Skip to content

Latest commit

 

History

History
364 lines (346 loc) · 15.7 KB

avi_albservicesfileupload.rst

File metadata and controls

364 lines (346 loc) · 15.7 KB

vmware.alb.avi_albservicesfileupload

Module for setup of ALBServicesFileUpload 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.
case_id
str
- Salesforce alphanumeric caseid to attach uploaded file to.
- Field introduced in 18.2.6.
- Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
error
str
- Error reported during file upload.
- Field introduced in 18.2.6.
- Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
file_path
str
required: true
- Stores output file path, for upload to aws s3.
- Field introduced in 18.2.6.
- Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
name
str
required: true
- Field introduced in 18.2.6.
- Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
s3_directory
str
- Custom aws s3 directory path to upload file.
- Field introduced in 18.2.6.
- Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
status
str
- Status of file upload.
- Enum options - SYSERR_SUCCESS, SYSERR_FAILURE, SYSERR_OUT_OF_MEMORY, SYSERR_NO_ENT, SYSERR_INVAL, SYSERR_ACCESS, SYSERR_FAULT, SYSERR_IO,
- SYSERR_TIMEOUT, SYSERR_NOT_SUPPORTED, SYSERR_NOT_READY, SYSERR_UPGRADE_IN_PROGRESS, SYSERR_WARM_START_IN_PROGRESS, SYSERR_TRY_AGAIN,
- SYSERR_NOT_UPGRADING, SYSERR_PENDING, SYSERR_EVENT_GEN_FAILURE, SYSERR_CONFIG_PARAM_MISSING, SYSERR_RANGE, SYSERR_FAILED...
- Field introduced in 18.2.6.
- Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
tenant_ref
str
- It is a reference to an object of type tenant.
- Field introduced in 18.2.6.
- Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
url
str
- Avi controller URL of the object.
uuid
str
- Allowed with any value in enterprise, 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 ALBServicesFileUpload object
      avi_albservicesfileupload:
        avi_credentials: "{{ avi_credentials }}"
        state: present
        name: sample_albservicesfileupload

Authors