Skip to content

Latest commit

 

History

History
608 lines (588 loc) · 25.5 KB

avi_fileobject.rst

File metadata and controls

608 lines (588 loc) · 25.5 KB

vmware.alb.avi_fileobject

Module for setup of FileObject Avi RESTful Object

Synopsis

Parameters

Parameter Choices/Defaults Comments
state
str
  • absent
  • present ←
- The state that should be applied on the entity.
avi_api_update_method
str
  • put ←
  • patch
- Default method for object update is HTTP PUT.
- Setting to patch will override that behavior to use HTTP PATCH.
avi_api_patch_op
str
  • add ←
  • replace
  • delete
  • remove
- Patch operation to use when using avi_api_update_method as patch.
avi_patch_path
str
- Patch path to use when using avi_api_update_method as patch.
avi_patch_value
str
- Patch value to use when using avi_api_update_method as patch.
checksum
str
- Sha1 checksum of the file.
- Field introduced in 20.1.1.
- Allowed in enterprise edition with any value, essentials, basic, enterprise with cloud services edition.
compressed
bool
- This field indicates whether the file is gzip-compressed.
- Field introduced in 20.1.1.
- Allowed in enterprise edition with any value, essentials, basic, enterprise with cloud services edition.
- Default value when not specified in API or module is interpreted by Avi Controller as False.
configpb_attributes
dict
- Protobuf versioning for config pbs.
- Field introduced in 30.2.1.
- Allowed in enterprise edition with any value, essentials edition with any value, basic edition with any value, enterprise with cloud services
- edition.
created
str
- Timestamp of creation for the file.
- Field introduced in 20.1.1.
- Allowed in enterprise edition with any value, essentials, basic, enterprise with cloud services edition.
crl_info
dict
- This field contains certificate revocation list metadata.
- Field introduced in 30.2.1.
- Allowed in enterprise edition with any value, enterprise with cloud services edition.
description
str
- Description of the file.
- Field introduced in 20.1.1.
- Allowed in enterprise edition with any value, essentials, basic, enterprise with cloud services edition.
expires_at
str
- Timestamp when the file will be no longer needed and can be removed by the system.
- If this is set, a garbage collector process will try to remove the file after this time.
- Field introduced in 20.1.1.
- Allowed in enterprise edition with any value, essentials, basic, enterprise with cloud services edition.
is_federated
bool
- This field describes the object's replication scope.
- If the field is set to false, then the object is visible within the controller-cluster and its associated service-engines.
- If the field is set to true, then the object is replicated across the federation.
- Field introduced in 20.1.1.
- Allowed in enterprise edition with any value, essentials, basic, enterprise with cloud services edition.
- Default value when not specified in API or module is interpreted by Avi Controller as False.
name
str
required: true
- Name of the file object.
- Field introduced in 20.1.1.
- Allowed in enterprise edition with any value, essentials, basic, enterprise with cloud services edition.
path
str
- Path to the file.
- Field introduced in 20.1.1.
- Allowed in enterprise edition with any value, essentials, basic, enterprise with cloud services edition.
read_only
bool
- Enforce read-only on the file.
- Field introduced in 20.1.1.
- Allowed in enterprise edition with any value, essentials, basic, enterprise with cloud services edition.
restrict_download
bool
- Flag to allow/restrict download of the file.
- Field introduced in 20.1.1.
- Allowed in enterprise edition with any value, essentials, basic, enterprise with cloud services edition.
size
int
- Size of the file.
- Field introduced in 20.1.1.
- Allowed in enterprise edition with any value, essentials, basic, enterprise with cloud services edition.
tenant_ref
str
- Tenant that this object belongs to.
- It is a reference to an object of type tenant.
- Field introduced in 20.1.1.
- Allowed in enterprise edition with any value, essentials, basic, enterprise with cloud services edition.
type
str
required: true
- Type of the file.
- Enum options - OTHER_FILE_TYPES, IP_REPUTATION, GEO_DB, TECH_SUPPORT, HSMPACKAGES, IPAMDNSSCRIPTS, CONTROLLER_IMAGE, CRL_DATA.
- Field introduced in 20.1.1.
- Allowed in enterprise edition with any value, essentials edition(allowed values- other_file_types), basic edition(allowed values-
- other_file_types), enterprise with cloud services edition.
url
str
- Avi controller URL of the object.
uuid
str
- Uuid of the file.
- Field introduced in 20.1.1.
- Allowed in enterprise edition with any value, essentials, basic, enterprise with cloud services edition.
version
str
- Version of the file.
- Field introduced in 20.1.1.
- Allowed in enterprise edition with any value, essentials, basic, enterprise with cloud services edition.

Examples

- hosts: localhost
  connection: local
  collections:
    - vmware.alb
  vars:
    avi_credentials:
      username: "avi_user"
      password: "avi_password"
      controller: "192.168.138.18"
      api_version: "21.1.1"
  tasks:
    - name: Example to create FileObject object
      avi_fileobject:
        avi_credentials: "{{ avi_credentials }}"
        state: present
        name: sample_fileobject

Authors