Skip to content

Latest commit

 

History

History
1421 lines (1401 loc) · 64 KB

avi_upgradestatusinfo.rst

File metadata and controls

1421 lines (1401 loc) · 64 KB

vmware.alb.avi_upgradestatusinfo

Module for setup of UpgradeStatusInfo 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.
after_reboot_rollback_fnc
str
- Backward compatible abort function name.
- Field introduced in 18.2.10, 20.1.1.
- Allowed in enterprise edition with any value, essentials, basic, enterprise with cloud services edition.
after_reboot_task_name
str
- Backward compatible task dict name.
- Field introduced in 18.2.10, 20.1.1.
- Allowed in enterprise edition with any value, essentials, basic, enterprise with cloud services edition.
clean
bool
- Flag for clean installation.
- Field introduced in 18.2.10, 20.1.1.
- Allowed in enterprise edition with any value, essentials, basic, enterprise with cloud services edition.
duration
int
- Duration of upgrade operation in seconds.
- Field introduced in 18.2.6.
- Allowed in enterprise edition with any value, essentials, basic, enterprise with cloud services edition.
enable_patch_rollback
bool
- Check if the patch rollback is possible on this node.
- Field introduced in 18.2.6.
- 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.
enable_rollback
bool
- Check if the rollback is possible on this node.
- Field introduced in 18.2.6.
- 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.
end_time
str
- End time of upgrade operation.
- Field introduced in 18.2.6.
- Allowed in enterprise edition with any value, essentials, basic, enterprise with cloud services edition.
enqueue_time
str
- Enqueue time of upgrade operation.
- Field introduced in 18.2.6.
- Allowed in enterprise edition with any value, essentials, basic, enterprise with cloud services edition.
fips_mode
bool
- Fips mode for the entire system.
- Field introduced in 20.1.5.
- Allowed in enterprise edition with any value, enterprise with cloud services edition.
history
list
- Record of past operations on this node.
- Field introduced in 20.1.4.
- Allowed in enterprise edition with any value, enterprise with cloud services edition.
image_path
str
- Image path of current 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.
image_ref
str
- Image uuid for identifying the current base image.
- It is a reference to an object of type image.
- Field introduced in 18.2.6.
- Allowed in enterprise edition with any value, essentials, basic, enterprise with cloud services edition.
name
str
- Name of the system such as cluster name, se group name and se name.
- Field introduced in 18.2.6.
- Allowed in enterprise edition with any value, essentials, basic, enterprise with cloud services edition.
node_type
str
- Type of the system such as controller_cluster, se_group or se.
- Enum options - NODE_CONTROLLER_CLUSTER, NODE_SE_GROUP, NODE_SE_TYPE.
- Field introduced in 18.2.6.
- Allowed in enterprise edition with any value, essentials, basic, enterprise with cloud services edition.
obj_cloud_ref
str
- Cloud that this object belongs to.
- It is a reference to an object of type cloud.
- Field introduced in 18.2.6.
- Allowed in enterprise edition with any value, essentials, basic, enterprise with cloud services edition.
obj_state
dict
- Current status of the upgrade operation.
- Field introduced in 18.2.6.
- Allowed in enterprise edition with any value, essentials, basic, enterprise with cloud services edition.
params
dict
- Parameters associated with the upgrade operation.
- Field introduced in 18.2.6.
- Allowed in enterprise edition with any value, essentials, basic, enterprise with cloud services edition.
patch_image_path
str
- Image path of current patch image.
- Field introduced in 18.2.10, 20.1.1.
- Allowed in enterprise edition with any value, essentials, basic, enterprise with cloud services edition.
patch_image_ref
str
- Image uuid for identifying the current patch.example base-image is 18.2.6 and a patch 6p1 is applied, then this field will indicate the 6p1
- value.
- It is a reference to an object of type image.
- Field introduced in 18.2.6.
- Allowed in enterprise edition with any value, essentials, basic, enterprise with cloud services edition.
patch_list
list
- List of patches applied to this node.
- Example base-image is 18.2.6 and a patch 6p1 is applied, then a patch 6p5 applied.
- This field will indicate the [{'6p1', '6p1_image_uuid'}, {'6p5', '6p5_image_uuid'}] value.
- Field introduced in 18.2.8, 20.1.1.
- Allowed in enterprise edition with any value, essentials, basic, enterprise with cloud services edition.
patch_reboot
bool
- Flag for patch op with reboot.
- Field introduced in 18.2.10, 20.1.1.
- Allowed in enterprise edition with any value, essentials, basic, enterprise with cloud services edition.
patch_version
str
- Current patch version applied to this node.
- Example base-image is 18.2.6 and a patch 6p1 is applied, then this field will indicate the 6p1 value.
- Field introduced in 18.2.6.
- Allowed in enterprise edition with any value, essentials, basic, enterprise with cloud services edition.
prev_image_path
str
- Image path of previous 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.
prev_patch_image_path
str
- Image path of previous patch image.
- Field introduced in 18.2.10, 20.1.1.
- Allowed in enterprise edition with any value, essentials, basic, enterprise with cloud services edition.
prev_remote_image_ref
str
- Remote image reference of previous base image.
- Field introduced in 30.1.1.
- Allowed in enterprise edition with any value, enterprise with cloud services edition.
previous_image_ref
str
- Image uuid for identifying previous base image.example base-image was 18.2.5 and an upgrade was done to 18.2.6, then this field will indicate
- the 18.2.5 value.
- It is a reference to an object of type image.
- Field introduced in 18.2.6.
- Allowed in enterprise edition with any value, essentials, basic, enterprise with cloud services edition.
previous_patch_image_ref
str
- Image uuid for identifying previous patch.example base-image was 18.2.6 with a patch 6p1.
- Upgrade was initiated to 18.2.8 with patch 8p1.
- The previous_image field will contain 18.2.6 and this field will indicate the 6p1 value.
- It is a reference to an object of type image.
- Field introduced in 18.2.6.
- Allowed in enterprise edition with any value, essentials, basic, enterprise with cloud services edition.
previous_patch_list
list
- List of patches applied to this node on previous major version.
- Field introduced in 18.2.8, 20.1.1.
- Allowed in enterprise edition with any value, essentials, basic, enterprise with cloud services edition.
previous_patch_version
str
- Previous patch version applied to this node.example base-image was 18.2.6 with a patch 6p1.
- Upgrade was initiated to 18.2.8 with patch 8p1.
- The previous_image field will contain 18.2.6 and this field will indicate the 6p1 value.
- Field introduced in 18.2.6.
- Allowed in enterprise edition with any value, essentials, basic, enterprise with cloud services edition.
previous_version
str
- Previous version prior to upgrade.example base-image was 18.2.5 and an upgrade was done to 18.2.6, then this field will indicate the 18.2.5
- value.
- Field introduced in 18.2.6.
- Allowed in enterprise edition with any value, essentials, basic, enterprise with cloud services edition.
progress
int
- Upgrade operations progress which holds value between 0-100.
- Allowed values are 0-100.
- Field introduced in 18.2.8, 20.1.1.
- Unit is percent.
- 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 0.
reason
str
- Descriptive reason for the upgrade state.
- Field introduced in 22.1.3.
- Allowed in enterprise edition with any value, enterprise with cloud services edition.
remote_image_ref
str
- Remote image reference of current base image.
- Field introduced in 30.1.1.
- Allowed in enterprise edition with any value, enterprise with cloud services edition.
se_patch_image_path
str
- Image path of se patch image.(required in case of reimage and upgrade + patch).
- 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_image_ref
str
- Image uuid for identifying the current se patch required in case of system upgrade(re-image) with se patch.
- It is a reference to an object of type 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_upgrade_events
list
- Serviceenginegroup upgrade errors.
- Field introduced in 18.2.6.
- Allowed in enterprise edition with any value, essentials, basic, enterprise with cloud services edition.
seg_params
dict
- Se_patch may be different from the controller_patch.
- It has to be saved in the journal for subsequent consumption.
- The segroup params will be saved in the controller entry as seg_params.
- Field introduced in 18.2.10, 20.1.1.
- Allowed in enterprise edition with any value, essentials, basic, enterprise with cloud services edition.
seg_status
dict
- Detailed segroup status.
- Field introduced in 18.2.6.
- Allowed in enterprise edition with any value, essentials, basic, enterprise with cloud services edition.
start_time
str
- Start time of upgrade operation.
- Field introduced in 18.2.6.
- Allowed in enterprise edition with any value, essentials, basic, enterprise with cloud services edition.
statediff_ref
str
- Record of pre/post snapshot captured for current upgrade operation.
- It is a reference to an object of type statediffoperation.
- Field introduced in 21.1.3.
- Allowed in enterprise edition with any value, enterprise with cloud services edition.
system
bool
- Flag is set only in the cluster if the upgrade is initiated as a system-upgrade.
- Field introduced in 18.2.6.
- Allowed in enterprise edition with any value, essentials, basic, enterprise with cloud services edition.
system_report_refs
list
- Tracks the list of reports created for node.
- It is a reference to an object of type systemreport.
- Field introduced in 22.1.6, 30.2.1.
- Allowed in enterprise edition with any value, enterprise with cloud services edition.
tasks_completed
int
- Completed set of tasks in the upgrade operation.
- Field introduced in 18.2.6.
- 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 18.2.6.
- Allowed in enterprise edition with any value, essentials, basic, enterprise with cloud services edition.
total_tasks
int
- Total number of tasks in the upgrade operation.
- Field introduced in 18.2.6.
- Allowed in enterprise edition with any value, essentials, basic, enterprise with cloud services edition.
upgrade_events
list
- Events performed for upgrade operation.
- Field introduced in 18.2.6.
- Allowed in enterprise edition with any value, essentials, basic, enterprise with cloud services edition.
upgrade_ops
str
- Upgrade operations requested.
- Enum options - UPGRADE, PATCH, ROLLBACK, ROLLBACKPATCH, SEGROUP_RESUME, EVAL_UPGRADE, EVAL_PATCH, EVAL_ROLLBACK, EVAL_ROLLBACKPATCH,
- EVAL_SEGROUP_RESUME, EVAL_RESTORE, RESTORE.
- Field introduced in 18.2.6.
- Allowed in enterprise edition with any value, essentials, basic, enterprise with cloud services edition.
upgrade_readiness
dict
- Upgrade readiness check execution detail.
- Field introduced in 22.1.3.
- 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 system such as cluster, se group and se.
- Field introduced in 18.2.6.
- Allowed in enterprise edition with any value, essentials, basic, enterprise with cloud services edition.
version
str
- Current base image applied to this node.
- 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 UpgradeStatusInfo object
      avi_upgradestatusinfo:
        avi_credentials: "{{ avi_credentials }}"
        state: present
        name: sample_upgradestatusinfo

Authors