Skip to content

Latest commit

 

History

History
484 lines (464 loc) · 19.7 KB

avi_systemreport.rst

File metadata and controls

484 lines (464 loc) · 19.7 KB

vmware.alb.avi_systemreport

Module for setup of SystemReport 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.
archive_ref
str
- Relative path to the report archive file on filesystem.the archive includes exported system configuration and current object as json.
- Field introduced in 22.1.6, 30.2.1.
- Allowed in enterprise edition with any value, enterprise with cloud services edition.
controller_patch_image_ref
str
- Controller patch image associated with the report.
- It is a reference to an object of type image.
- Field introduced in 22.1.6, 30.2.1.
- Allowed in enterprise edition with any value, enterprise with cloud services edition.
downloadable
bool
- Indicates whether this report is downloadable as an archive.
- Field introduced in 22.1.6, 30.2.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 False.
events
list
- List of events associated with the report.
- Field introduced in 22.1.6, 30.2.1.
- Allowed in enterprise edition with any value, enterprise with cloud services edition.
image_ref
str
- System image associated with the report.
- It is a reference to an object of type image.
- Field introduced in 22.1.6, 30.2.1.
- Allowed in enterprise edition with any value, enterprise with cloud services edition.
name
str
- Name of the report derived from operation in a readable format.
- Ex upgrade_system_1a5c.
- Field introduced in 22.1.6, 30.2.1.
- Allowed in enterprise edition with any value, enterprise with cloud services edition.
obj_state
dict
- Report state combines all applicable states.
- Ex readiness_reports.system_readiness.state.
- Field introduced in 22.1.6, 30.2.1.
- Allowed in enterprise edition with any value, enterprise with cloud services edition.
readiness_reports
list
- Readiness state of the system.
- Ex upgrade pre-check results.
- Field introduced in 22.1.6, 30.2.1.
- Allowed in enterprise edition with any value, enterprise with cloud services edition.
se_patch_image_ref
str
- Se patch image associated with the report.
- It is a reference to an object of type image.
- Field introduced in 22.1.6, 30.2.1.
- Allowed in enterprise edition with any value, enterprise with cloud services edition.
summary
dict
- Summary of the report.
- Field introduced in 22.1.6, 30.2.1.
- Allowed in enterprise edition with any value, enterprise with cloud services edition.
tenant_ref
str
- Tenant uuid associated with the object.
- It is a reference to an object of type tenant.
- Field introduced in 22.1.6, 30.2.1.
- Allowed in enterprise edition with any value, enterprise with cloud services edition.
url
str
- Avi controller URL of the object.
uuid
str
- Uuid identifier for the report.
- Field introduced in 22.1.6, 30.2.1.
- Allowed in enterprise edition with any value, 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 SystemReport object
      avi_systemreport:
        avi_credentials: "{{ avi_credentials }}"
        state: present
        name: sample_systemreport

Authors