The Upgrade Status object is used to view the upgrade status of Infoblox Grid elements.
Parameter type is required for object searches.
References to upgradestatus are object references.
The name part of the upgradestatus object reference has the following components:
- Name of the element of the Grid
- Upgrade status of which was requested.
The object does not support the following operations:
The object cannot be managed on Cloud Platform members.
These fields are actual members of the object; thus, they can be requested by using _return_fields, if the fields are readable.
The basic version of the object contains the field(s): alternate_version, comment, current_version, distribution_version, element_status, grid_state, group_state, ha_status, hotfixes, ipv4_address, ipv6_address, member, message, pnode_role, reverted, status_value, status_value_update_time, steps, steps_completed, steps_total, type, upgrade_group, upgrade_state, upgrade_test_status, upload_version.
Determines if distribution is allowed for the Grid.
Type
Bool.
Search
The field is not available for search.
Notes
The allow_distribution cannot be updated.
allow_distribution cannot be written.
Determines if distribution scheduling is allowed.
Type
Bool.
Search
The field is not available for search.
Notes
The allow_distribution_scheduling cannot be updated.
allow_distribution_scheduling cannot be written.
Determines if upgrade is allowed for the Grid.
Type
Bool.
Search
The field is not available for search.
Notes
The allow_upgrade cannot be updated.
allow_upgrade cannot be written.
Determines if the Grid is allowed to cancel an upgrade.
Type
Bool.
Search
The field is not available for search.
Notes
The allow_upgrade_cancel cannot be updated.
allow_upgrade_cancel cannot be written.
Determines if the Grid is allowed to pause an upgrade.
Type
Bool.
Search
The field is not available for search.
Notes
The allow_upgrade_pause cannot be updated.
allow_upgrade_pause cannot be written.
Determines if the Grid is allowed to resume an upgrade.
Type
Bool.
Search
The field is not available for search.
Notes
The allow_upgrade_resume cannot be updated.
allow_upgrade_resume cannot be written.
Determine if the Grid is allowed to schedule an upgrade.
Type
Bool.
Search
The field is not available for search.
Notes
The allow_upgrade_scheduling cannot be updated.
allow_upgrade_scheduling cannot be written.
Determines if the Grid is allowed to test an upgrade.
Type
Bool.
Search
The field is not available for search.
Notes
The allow_upgrade_test cannot be updated.
allow_upgrade_test cannot be written.
Determine if the Grid is allowed to upload a build.
Type
Bool.
Search
The field is not available for search.
Notes
The allow_upload cannot be updated.
allow_upload cannot be written.
The alternative version.
Type
String.
Search
The field is not available for search.
Notes
The alternate_version is part of the base object.
The alternate_version cannot be updated.
alternate_version cannot be written.
Comment in readable format for an upgrade group a or virtual node.
Type
String.
Search
The field is not available for search.
Notes
The comment is part of the base object.
The comment cannot be updated.
comment cannot be written.
The current version.
Type
String.
Search
The field is not available for search.
Notes
The current_version is part of the base object.
The current_version cannot be updated.
current_version cannot be written.
Current version summary for the ‘type’ requested. This field can be requested for the Grid, a certain group that has virtual nodes as subelements, or for the overall group status.
Type
String.
Search
The field is not available for search.
Notes
The current_version_summary cannot be updated.
current_version_summary cannot be written.
Determines if the distribution schedule is active for the Grid.
Type
Bool.
Search
The field is not available for search.
Notes
The distribution_schedule_active cannot be updated.
distribution_schedule_active cannot be written.
The Grid master distribution schedule time.
Type
Timestamp.
Search
The field is not available for search.
Notes
The distribution_schedule_time cannot be updated.
distribution_schedule_time cannot be written.
The current state of distribution process.
Type
String.
Search
The field is not available for search.
Notes
The distribution_state cannot be updated.
distribution_state cannot be written.
The version that is distributed.
Type
String.
Search
The field is not available for search.
Notes
The distribution_version is part of the base object.
The distribution_version cannot be updated.
distribution_version cannot be written.
Distribution version summary for the ‘type’ requested. This field can be requested for the Grid, a certain group that has virtual nodes as subelements, or for the overall group status.
Type
String.
Search
The field is not available for search.
Notes
The distribution_version_summary cannot be updated.
distribution_version_summary cannot be written.
The status of a certain element with regards to the type requested.
Type
String.
Search
The field is not available for search.
Notes
The element_status is part of the base object.
The element_status cannot be updated.
element_status cannot be written.
The state of the Grid.
Type
String.
Search
The field is not available for search.
Notes
The grid_state is part of the base object.
The grid_state cannot be updated.
grid_state cannot be written.
The state of a group.
Type
String.
Search
The field is not available for search.
Notes
The group_state is part of the base object.
The group_state cannot be updated.
group_state cannot be written.
Status of the HA pair.
Type
String.
Search
The field is not available for search.
Notes
The ha_status is part of the base object.
The ha_status cannot be updated.
ha_status cannot be written.
The list of hotfixes.
Type
A/An Upgrade process hotfix struct array.
Search
The field is not available for search.
Notes
The hotfixes is part of the base object.
The hotfixes cannot be updated.
hotfixes cannot be written.
The IPv4 Address of virtual node or physical one.
Type
String.
Search
The field is not available for search.
Notes
The ipv4_address is part of the base object.
The ipv4_address cannot be updated.
ipv4_address cannot be written.
The IPv6 Address of virtual node or physical one.
Type
String.
Search
The field is not available for search.
Notes
The ipv6_address is part of the base object.
The ipv6_address cannot be updated.
ipv6_address cannot be written.
Member that participates in the upgrade process.
Type
String.
Search
The field is available for search via
Notes
The member is part of the base object.
The member cannot be updated.
member cannot be written.
The Grid message.
Type
String.
Search
The field is not available for search.
Notes
The message is part of the base object.
The message cannot be updated.
message cannot be written.
Status of the physical node in the HA pair.
Type
String.
Search
The field is not available for search.
Notes
The pnode_role is part of the base object.
The pnode_role cannot be updated.
pnode_role cannot be written.
Determines if the upgrade process is reverted.
Type
Bool.
Search
The field is not available for search.
Notes
The reverted is part of the base object.
The reverted cannot be updated.
reverted cannot be written.
The status time.
Type
Timestamp.
Search
The field is not available for search.
Notes
The status_time cannot be updated.
status_time cannot be written.
Status of a certain group, virtual node or physical node.
Type
String.
Search
The field is not available for search.
Notes
The status_value is part of the base object.
The status_value cannot be updated.
status_value cannot be written.
Timestamp of when the status was updated.
Type
Timestamp.
Search
The field is not available for search.
Notes
The status_value_update_time is part of the base object.
The status_value_update_time cannot be updated.
status_value_update_time cannot be written.
The list of upgrade process steps.
Type
A/An Upgrade process step struct array.
Search
The field is not available for search.
Notes
The steps is part of the base object.
The steps cannot be updated.
steps cannot be written.
The number of steps done.
Type
Integer.
Search
The field is not available for search.
Notes
The steps_completed is part of the base object.
The steps_completed cannot be updated.
steps_completed cannot be written.
Total number steps in the upgrade process.
Type
Integer.
Search
The field is not available for search.
Notes
The steps_total is part of the base object.
The steps_total cannot be updated.
steps_total cannot be written.
The type of subelements to be requested. If ‘type’ is ‘GROUP’, or ‘VNODE’, then ‘upgrade_group’ or ‘member’ should have proper values for an operation to return data specific for the values passed. Otherwise, overall data is returned for every group or physical node.
Type
String.
Search
The field is available for search via
Notes
The subelement_type cannot be updated.
subelement_type cannot be written.
Number of subelements that have accomplished an upgrade.
Type
Integer.
Search
The field is not available for search.
Notes
The subelements_completed cannot be updated.
subelements_completed cannot be written.
The upgrade process information of subelements.
Type
A/An upgradestatus object array.
This field supports nested return fields as described here.
Create
The default value is undefined.
Search
The field is not available for search.
Number of subelements number in a certain group, virtual node, or the Grid.
Type
Integer.
Search
The field is not available for search.
Notes
The subelements_total cannot be updated.
subelements_total cannot be written.
The type of upper level elements to be requested.
Type
String.
Search
The field is available for search via
Notes
The type is part of the base object.
The type cannot be updated.
type cannot be written.
Upgrade group that participates in the upgrade process.
Type
String.
Search
The field is available for search via
Notes
The upgrade_group is part of the base object.
The upgrade_group cannot be updated.
upgrade_group cannot be written.
Determines if the upgrade schedule is active.
Type
Bool.
Search
The field is not available for search.
Notes
The upgrade_schedule_active cannot be updated.
upgrade_schedule_active cannot be written.
The upgrade state of the Grid.
Type
String.
Search
The field is not available for search.
Notes
The upgrade_state is part of the base object.
The upgrade_state cannot be updated.
upgrade_state cannot be written.
The upgrade test status of the Grid.
Type
String.
Search
The field is not available for search.
Notes
The upgrade_test_status is part of the base object.
The upgrade_test_status cannot be updated.
upgrade_test_status cannot be written.
The version that is uploaded.
Type
String.
Search
The field is not available for search.
Notes
The upload_version is part of the base object.
The upload_version cannot be updated.
upload_version cannot be written.
Upload version summary for the ‘type’ requested. This field can be requested for the Grid, a certain group that has virtual nodes as subelements, or overall group status.
Type
String.
Search
The field is not available for search.
Notes
The upload_version_summary cannot be updated.
upload_version_summary cannot be written.
| Field | Type | Req | R/O | Base | Search |
|---|---|---|---|---|---|
| allow_distribution | Bool | N | Y | N | N/A |
| allow_distribution_scheduling | Bool | N | Y | N | N/A |
| allow_upgrade | Bool | N | Y | N | N/A |
| allow_upgrade_cancel | Bool | N | Y | N | N/A |
| allow_upgrade_pause | Bool | N | Y | N | N/A |
| allow_upgrade_resume | Bool | N | Y | N | N/A |
| allow_upgrade_scheduling | Bool | N | Y | N | N/A |
| allow_upgrade_test | Bool | N | Y | N | N/A |
| allow_upload | Bool | N | Y | N | N/A |
| alternate_version | String | N | Y | Y | N/A |
| comment | String | N | Y | Y | N/A |
| current_version | String | N | Y | Y | N/A |
| current_version_summary | String | N | Y | N | N/A |
| distribution_schedule_active | Bool | N | Y | N | N/A |
| distribution_schedule_time | Timestamp | N | Y | N | N/A |
| distribution_state | String | N | Y | N | N/A |
| distribution_version | String | N | Y | Y | N/A |
| distribution_version_summary | String | N | Y | N | N/A |
| element_status | String | N | Y | Y | N/A |
| grid_state | String | N | Y | Y | N/A |
| group_state | String | N | Y | Y | N/A |
| ha_status | String | N | Y | Y | N/A |
| hotfixes | [struct] | N | Y | Y | N/A |
| ipv4_address | String | N | Y | Y | N/A |
| ipv6_address | String | N | Y | Y | N/A |
| member | String | N | Y | Y | = |
| message | String | N | Y | Y | N/A |
| pnode_role | String | N | Y | Y | N/A |
| reverted | Bool | N | Y | Y | N/A |
| status_time | Timestamp | N | Y | N | N/A |
| status_value | String | N | Y | Y | N/A |
| status_value_update_time | Timestamp | N | Y | Y | N/A |
| steps | [struct] | N | Y | Y | N/A |
| steps_completed | Integer | N | Y | Y | N/A |
| steps_total | Integer | N | Y | Y | N/A |
| subelement_type | String | N | Y | N | = |
| subelements_completed | Integer | N | Y | N | N/A |
| subelements_status | [obj] | N | N | N | N/A |
| subelements_total | Integer | N | Y | N | N/A |
| type | String | N | Y | Y | = |
| upgrade_group | String | N | Y | Y | = |
| upgrade_schedule_active | Bool | N | Y | N | N/A |
| upgrade_state | String | N | Y | Y | N/A |
| upgrade_test_status | String | N | Y | Y | N/A |
| upload_version | String | N | Y | Y | N/A |
| upload_version_summary | String | N | Y | N | N/A |
upgradeschedule : Upgrade schedule object.
