Skip to content

Latest commit

 

History

History
729 lines (709 loc) · 31 KB

avi_image.rst

File metadata and controls

729 lines (709 loc) · 31 KB

vmware.alb.avi_image

Module for setup of Image 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.
cloud_info_values
list
- This field describes the cloud info specific to the base image.
- Field introduced in 20.1.1.
- Allowed in enterprise edition with any value, essentials, basic, enterprise with cloud services edition.
controller_info
dict
- Controller package details.
- Field introduced in 18.2.6.
- Allowed in enterprise edition with any value, essentials, basic, enterprise with cloud services edition.
controller_patch_name
str
- Mandatory controller patch name that is applied along with this base image.
- Field introduced in 18.2.10, 20.1.1.
- Allowed in enterprise edition with any value, essentials, basic, enterprise with cloud services edition.
controller_patch_ref
str
- It references the controller-patch associated with the uber image.
- It is a reference to an object of type image.
- Field introduced in 18.2.8, 20.1.1.
- Allowed in enterprise edition with any value, essentials, basic, enterprise with cloud services edition.
duration
int
- Time taken to upload the image in seconds.
- Field introduced in 21.1.3.
- Unit is sec.
- Allowed in enterprise edition with any value, enterprise with cloud services edition.
end_time
str
- Image upload end time.
- Field introduced in 21.1.3.
- Allowed in enterprise edition with any value, enterprise with cloud services edition.
events
list
- Image events for image upload operation.
- Field introduced in 21.1.3.
- Allowed in enterprise edition with any value, enterprise with cloud services edition.
fips_mode_transition_applicable
bool
- Specifies whether fips mode can be enabled on this image.
- Field introduced in 30.1.1.
- Allowed in enterprise edition with any value, enterprise with cloud services edition.
- Default value when not specified in API or module is interpreted by Avi Controller as True.
img_state
dict
- Status of the image.
- Field introduced in 21.1.3.
- Allowed in enterprise edition with any value, enterprise with cloud services edition.
migrations
dict
- This field describes the api migration related information.
- Field introduced in 18.2.6.
- Allowed in enterprise edition with any value, essentials, basic, enterprise with cloud services edition.
name
str
required: true
- Name of the image.
- Field introduced in 18.2.6.
- Allowed in enterprise edition with any value, essentials, basic, enterprise with cloud services edition.
progress
int
- Image upload progress which holds value between 0-100.
- Allowed values are 0-100.
- Field introduced in 21.1.3.
- Unit is percent.
- Allowed in enterprise edition with any value, enterprise with cloud services edition.
- Default value when not specified in API or module is interpreted by Avi Controller as 0.
se_info
dict
- Se package details.
- Field introduced in 18.2.6.
- Allowed in enterprise edition with any value, essentials, basic, enterprise with cloud services edition.
se_patch_name
str
- Mandatory serviceengine patch name that is applied along with this base image.
- Field introduced in 18.2.10, 20.1.1.
- Allowed in enterprise edition with any value, essentials, basic, enterprise with cloud services edition.
se_patch_ref
str
- It references the service engine patch associated with the uber image.
- It is a reference to an object of type image.
- Field introduced in 18.2.8, 20.1.1.
- Allowed in enterprise edition with any value, essentials, basic, enterprise with cloud services edition.
start_time
str
- Image upload start time.
- Field introduced in 21.1.3.
- Allowed in enterprise edition with any value, enterprise with cloud services edition.
tasks_completed
int
- Completed set of tasks for image upload.
- Field introduced in 21.1.3.
- Allowed in enterprise edition with any value, enterprise with cloud services edition.
- Default value when not specified in API or module is interpreted by Avi Controller as 0.
tenant_ref
str
- Tenant that this object belongs to.
- It is a reference to an object of type tenant.
- Field introduced in 18.2.6.
- Allowed in enterprise edition with any value, essentials, basic, enterprise with cloud services edition.
total_tasks
int
- Total number of tasks for image upload.
- Field introduced in 21.1.3.
- Allowed in enterprise edition with any value, enterprise with cloud services edition.
- Default value when not specified in API or module is interpreted by Avi Controller as 0.
type
str
- Type of the image patch/system.
- Enum options - IMAGE_TYPE_PATCH, IMAGE_TYPE_SYSTEM, IMAGE_TYPE_MUST_CHECK.
- Field introduced in 18.2.6.
- Allowed in enterprise edition with any value, essentials, basic, enterprise with cloud services edition.
uber_bundle
bool
- Status to check if the image is an uber bundle.
- Field introduced in 18.2.8, 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.
url
str
- Avi controller URL of the object.
uuid
str
- Uuid of the image.
- Field introduced in 18.2.6.
- 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 Image object
      avi_image:
        avi_credentials: "{{ avi_credentials }}"
        state: present
        name: sample_image

Authors