vcenter nsx deployment upgrade: operation

The operation structure contains information about the operation to be performed. Warning: This structure is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented.

Representation:

{
    "start_time""2015-01-01T22:13:05.651Z",
    "name""string",
    "end_time""2015-01-01T22:13:05.651Z",
    "progress"1.5,
    "messages"[
        {
            "unit_name""string",
            "msg"{
                "args"[
                    "string",
                    "string"
                ],
                "default_message""string",
                "localized""string",
                "id""string",
                "params"{
                    "<string>"{
                        "dt""2015-01-01T22:13:05.651Z",
                        "s""string",
                        "d"1.5,
                        "precision"1,
                        "format""SHORT_DATE",
                        "i"1,
                        "l"{
                            "id""string",
                            "params"{
                                "<string>"{
                                    "dt""2015-01-01T22:13:05.651Z",
                                    "s""string",
                                    "d"1.5,
                                    "precision"1,
                                    "format""SHORT_DATE",
                                    "i"1,
                                    "l"{
                                        "id""string",
                                        "params"{}
                                    }
                                }
                            }
                        }
                    }
                }
            },
            "msg_type""INFO",
            "unit_type""MANAGER"
        },
        {
            "unit_name""string",
            "msg"{
                "args"[
                    "string",
                    "string"
                ],
                "default_message""string",
                "localized""string",
                "id""string",
                "params"{
                    "<string>"{
                        "dt""2015-01-01T22:13:05.651Z",
                        "s""string",
                        "d"1.5,
                        "precision"1,
                        "format""SHORT_DATE",
                        "i"1,
                        "l"{
                            "id""string",
                            "params"{
                                "<string>"{
                                    "dt""2015-01-01T22:13:05.651Z",
                                    "s""string",
                                    "d"1.5,
                                    "precision"1,
                                    "format""SHORT_DATE",
                                    "i"1,
                                    "l"{
                                        "id""string",
                                        "params"{}
                                    }
                                }
                            }
                        }
                    }
                }
            },
            "msg_type""INFO",
            "unit_type""MANAGER"
        }
    ],
    "display_name"{
        "args"[
            "string",
            "string"
        ],
        "default_message""string",
        "localized""string",
        "id""string",
        "params"{
            "<string>"{
                "dt""2015-01-01T22:13:05.651Z",
                "s""string",
                "d"1.5,
                "precision"1,
                "format""SHORT_DATE",
                "i"1,
                "l"{
                    "id""string",
                    "params"{
                        "<string>"{
                            "dt""2015-01-01T22:13:05.651Z",
                            "s""string",
                            "d"1.5,
                            "precision"1,
                            "format""SHORT_DATE",
                            "i"1,
                            "l"{
                                "id""string",
                                "params"{}
                            }
                        }
                    }
                }
            }
        }
    },
    "tasks"[
        {
            "start_time""2015-01-01T22:13:05.651Z",
            "name""string",
            "end_time""2015-01-01T22:13:05.651Z",
            "progress"1.5,
            "messages"[
                {
                    "unit_name""string",
                    "msg"{
                        "args"[
                            "string",
                            "string"
                        ],
                        "default_message""string",
                        "localized""string",
                        "id""string",
                        "params"{
                            "<string>"{
                                "dt""2015-01-01T22:13:05.651Z",
                                "s""string",
                                "d"1.5,
                                "precision"1,
                                "format""SHORT_DATE",
                                "i"1,
                                "l"{
                                    "id""string",
                                    "params"{
                                        "<string>"{
                                            "dt""2015-01-01T22:13:05.651Z",
                                            "s""string",
                                            "d"1.5,
                                            "precision"1,
                                            "format""SHORT_DATE",
                                            "i"1,
                                            "l"{
                                                "id""string",
                                                "params"{}
                                            }
                                        }
                                    }
                                }
                            }
                        }
                    },
                    "msg_type""INFO",
                    "unit_type""MANAGER"
                },
                {
                    "unit_name""string",
                    "msg"{
                        "args"[
                            "string",
                            "string"
                        ],
                        "default_message""string",
                        "localized""string",
                        "id""string",
                        "params"{
                            "<string>"{
                                "dt""2015-01-01T22:13:05.651Z",
                                "s""string",
                                "d"1.5,
                                "precision"1,
                                "format""SHORT_DATE",
                                "i"1,
                                "l"{
                                    "id""string",
                                    "params"{
                                        "<string>"{
                                            "dt""2015-01-01T22:13:05.651Z",
                                            "s""string",
                                            "d"1.5,
                                            "precision"1,
                                            "format""SHORT_DATE",
                                            "i"1,
                                            "l"{
                                                "id""string",
                                                "params"{}
                                            }
                                        }
                                    }
                                }
                            }
                        }
                    },
                    "msg_type""INFO",
                    "unit_type""MANAGER"
                }
            ],
            "display_name"{
                "args"[
                    "string",
                    "string"
                ],
                "default_message""string",
                "localized""string",
                "id""string",
                "params"{
                    "<string>"{
                        "dt""2015-01-01T22:13:05.651Z",
                        "s""string",
                        "d"1.5,
                        "precision"1,
                        "format""SHORT_DATE",
                        "i"1,
                        "l"{
                            "id""string",
                            "params"{
                                "<string>"{
                                    "dt""2015-01-01T22:13:05.651Z",
                                    "s""string",
                                    "d"1.5,
                                    "precision"1,
                                    "format""SHORT_DATE",
                                    "i"1,
                                    "l"{
                                        "id""string",
                                        "params"{}
                                    }
                                }
                            }
                        }
                    }
                }
            },
            "tasks"[
                null,
                null
            ],
            "status""NOT_STARTED"
        },
        {
            "start_time""2015-01-01T22:13:05.651Z",
            "name""string",
            "end_time""2015-01-01T22:13:05.651Z",
            "progress"1.5,
            "messages"[
                {
                    "unit_name""string",
                    "msg"{
                        "args"[
                            "string",
                            "string"
                        ],
                        "default_message""string",
                        "localized""string",
                        "id""string",
                        "params"{
                            "<string>"{
                                "dt""2015-01-01T22:13:05.651Z",
                                "s""string",
                                "d"1.5,
                                "precision"1,
                                "format""SHORT_DATE",
                                "i"1,
                                "l"{
                                    "id""string",
                                    "params"{
                                        "<string>"{
                                            "dt""2015-01-01T22:13:05.651Z",
                                            "s""string",
                                            "d"1.5,
                                            "precision"1,
                                            "format""SHORT_DATE",
                                            "i"1,
                                            "l"{
                                                "id""string",
                                                "params"{}
                                            }
                                        }
                                    }
                                }
                            }
                        }
                    },
                    "msg_type""INFO",
                    "unit_type""MANAGER"
                },
                {
                    "unit_name""string",
                    "msg"{
                        "args"[
                            "string",
                            "string"
                        ],
                        "default_message""string",
                        "localized""string",
                        "id""string",
                        "params"{
                            "<string>"{
                                "dt""2015-01-01T22:13:05.651Z",
                                "s""string",
                                "d"1.5,
                                "precision"1,
                                "format""SHORT_DATE",
                                "i"1,
                                "l"{
                                    "id""string",
                                    "params"{
                                        "<string>"{
                                            "dt""2015-01-01T22:13:05.651Z",
                                            "s""string",
                                            "d"1.5,
                                            "precision"1,
                                            "format""SHORT_DATE",
                                            "i"1,
                                            "l"{
                                                "id""string",
                                                "params"{}
                                            }
                                        }
                                    }
                                }
                            }
                        }
                    },
                    "msg_type""INFO",
                    "unit_type""MANAGER"
                }
            ],
            "display_name"{
                "args"[
                    "string",
                    "string"
                ],
                "default_message""string",
                "localized""string",
                "id""string",
                "params"{
                    "<string>"{
                        "dt""2015-01-01T22:13:05.651Z",
                        "s""string",
                        "d"1.5,
                        "precision"1,
                        "format""SHORT_DATE",
                        "i"1,
                        "l"{
                            "id""string",
                            "params"{
                                "<string>"{
                                    "dt""2015-01-01T22:13:05.651Z",
                                    "s""string",
                                    "d"1.5,
                                    "precision"1,
                                    "format""SHORT_DATE",
                                    "i"1,
                                    "l"{
                                        "id""string",
                                        "params"{}
                                    }
                                }
                            }
                        }
                    }
                }
            },
            "tasks"[
                null,
                null
            ],
            "status""NOT_STARTED"
        }
    ],
    "status""NOT_STARTED"
}
{
    "start_time""2015-01-01T22:13:05.651Z",
    "name""string",
    "end_time""2015-01-01T22:13:05.651Z",
    "progress"1.5,
    "messages"[
        {
            "unit_name""string",
            "msg"{
                "args"[
                    "string",
                    "string"
                ],
                "default_message""string",
                "localized""string",
                "id""string",
                "params"[
                    {
                        "value"{
                            "dt""2015-01-01T22:13:05.651Z",
                            "s""string",
                            "d"1.5,
                            "precision"1,
                            "format""SHORT_DATE",
                            "i"1,
                            "l"{
                                "id""string",
                                "params"[
                                    {
                                        "value"{
                                            "dt""2015-01-01T22:13:05.651Z",
                                            "s""string",
                                            "d"1.5,
                                            "precision"1,
                                            "format""SHORT_DATE",
                                            "i"1,
                                            "l"{
                                                "id""string",
                                                "params"[
                                                    {
                                                        "key""string"
                                                    }
                                                ]
                                            }
                                        },
                                        "key""string"
                                    }
                                ]
                            }
                        },
                        "key""string"
                    }
                ]
            },
            "msg_type""INFO",
            "unit_type""MANAGER"
        },
        {
            "unit_name""string",
            "msg"{
                "args"[
                    "string",
                    "string"
                ],
                "default_message""string",
                "localized""string",
                "id""string",
                "params"[
                    {
                        "value"{
                            "dt""2015-01-01T22:13:05.651Z",
                            "s""string",
                            "d"1.5,
                            "precision"1,
                            "format""SHORT_DATE",
                            "i"1,
                            "l"{
                                "id""string",
                                "params"[
                                    {
                                        "value"{
                                            "dt""2015-01-01T22:13:05.651Z",
                                            "s""string",
                                            "d"1.5,
                                            "precision"1,
                                            "format""SHORT_DATE",
                                            "i"1,
                                            "l"{
                                                "id""string",
                                                "params"[
                                                    {
                                                        "key""string"
                                                    }
                                                ]
                                            }
                                        },
                                        "key""string"
                                    }
                                ]
                            }
                        },
                        "key""string"
                    }
                ]
            },
            "msg_type""INFO",
            "unit_type""MANAGER"
        }
    ],
    "display_name"{
        "args"[
            "string",
            "string"
        ],
        "default_message""string",
        "localized""string",
        "id""string",
        "params"[
            {
                "value"{
                    "dt""2015-01-01T22:13:05.651Z",
                    "s""string",
                    "d"1.5,
                    "precision"1,
                    "format""SHORT_DATE",
                    "i"1,
                    "l"{
                        "id""string",
                        "params"[
                            {
                                "value"{
                                    "dt""2015-01-01T22:13:05.651Z",
                                    "s""string",
                                    "d"1.5,
                                    "precision"1,
                                    "format""SHORT_DATE",
                                    "i"1,
                                    "l"{
                                        "id""string",
                                        "params"[
                                            {
                                                "key""string"
                                            }
                                        ]
                                    }
                                },
                                "key""string"
                            }
                        ]
                    }
                },
                "key""string"
            }
        ]
    },
    "tasks"[
        {
            "start_time""2015-01-01T22:13:05.651Z",
            "name""string",
            "end_time""2015-01-01T22:13:05.651Z",
            "progress"1.5,
            "messages"[
                {
                    "unit_name""string",
                    "msg"{
                        "args"[
                            "string",
                            "string"
                        ],
                        "default_message""string",
                        "localized""string",
                        "id""string",
                        "params"[
                            {
                                "value"{
                                    "dt""2015-01-01T22:13:05.651Z",
                                    "s""string",
                                    "d"1.5,
                                    "precision"1,
                                    "format""SHORT_DATE",
                                    "i"1,
                                    "l"{
                                        "id""string",
                                        "params"[
                                            {
                                                "value"{
                                                    "dt""2015-01-01T22:13:05.651Z",
                                                    "s""string",
                                                    "d"1.5,
                                                    "precision"1,
                                                    "format""SHORT_DATE",
                                                    "i"1,
                                                    "l"{
                                                        "id""string",
                                                        "params"[
                                                            {
                                                                "key""string"
                                                            }
                                                        ]
                                                    }
                                                },
                                                "key""string"
                                            }
                                        ]
                                    }
                                },
                                "key""string"
                            }
                        ]
                    },
                    "msg_type""INFO",
                    "unit_type""MANAGER"
                },
                {
                    "unit_name""string",
                    "msg"{
                        "args"[
                            "string",
                            "string"
                        ],
                        "default_message""string",
                        "localized""string",
                        "id""string",
                        "params"[
                            {
                                "value"{
                                    "dt""2015-01-01T22:13:05.651Z",
                                    "s""string",
                                    "d"1.5,
                                    "precision"1,
                                    "format""SHORT_DATE",
                                    "i"1,
                                    "l"{
                                        "id""string",
                                        "params"[
                                            {
                                                "value"{
                                                    "dt""2015-01-01T22:13:05.651Z",
                                                    "s""string",
                                                    "d"1.5,
                                                    "precision"1,
                                                    "format""SHORT_DATE",
                                                    "i"1,
                                                    "l"{
                                                        "id""string",
                                                        "params"[
                                                            {
                                                                "key""string"
                                                            }
                                                        ]
                                                    }
                                                },
                                                "key""string"
                                            }
                                        ]
                                    }
                                },
                                "key""string"
                            }
                        ]
                    },
                    "msg_type""INFO",
                    "unit_type""MANAGER"
                }
            ],
            "display_name"{
                "args"[
                    "string",
                    "string"
                ],
                "default_message""string",
                "localized""string",
                "id""string",
                "params"[
                    {
                        "value"{
                            "dt""2015-01-01T22:13:05.651Z",
                            "s""string",
                            "d"1.5,
                            "precision"1,
                            "format""SHORT_DATE",
                            "i"1,
                            "l"{
                                "id""string",
                                "params"[
                                    {
                                        "value"{
                                            "dt""2015-01-01T22:13:05.651Z",
                                            "s""string",
                                            "d"1.5,
                                            "precision"1,
                                            "format""SHORT_DATE",
                                            "i"1,
                                            "l"{
                                                "id""string",
                                                "params"[
                                                    {
                                                        "key""string"
                                                    }
                                                ]
                                            }
                                        },
                                        "key""string"
                                    }
                                ]
                            }
                        },
                        "key""string"
                    }
                ]
            },
            "tasks"[
                null,
                null
            ],
            "status""NOT_STARTED"
        },
        {
            "start_time""2015-01-01T22:13:05.651Z",
            "name""string",
            "end_time""2015-01-01T22:13:05.651Z",
            "progress"1.5,
            "messages"[
                {
                    "unit_name""string",
                    "msg"{
                        "args"[
                            "string",
                            "string"
                        ],
                        "default_message""string",
                        "localized""string",
                        "id""string",
                        "params"[
                            {
                                "value"{
                                    "dt""2015-01-01T22:13:05.651Z",
                                    "s""string",
                                    "d"1.5,
                                    "precision"1,
                                    "format""SHORT_DATE",
                                    "i"1,
                                    "l"{
                                        "id""string",
                                        "params"[
                                            {
                                                "value"{
                                                    "dt""2015-01-01T22:13:05.651Z",
                                                    "s""string",
                                                    "d"1.5,
                                                    "precision"1,
                                                    "format""SHORT_DATE",
                                                    "i"1,
                                                    "l"{
                                                        "id""string",
                                                        "params"[
                                                            {
                                                                "key""string"
                                                            }
                                                        ]
                                                    }
                                                },
                                                "key""string"
                                            }
                                        ]
                                    }
                                },
                                "key""string"
                            }
                        ]
                    },
                    "msg_type""INFO",
                    "unit_type""MANAGER"
                },
                {
                    "unit_name""string",
                    "msg"{
                        "args"[
                            "string",
                            "string"
                        ],
                        "default_message""string",
                        "localized""string",
                        "id""string",
                        "params"[
                            {
                                "value"{
                                    "dt""2015-01-01T22:13:05.651Z",
                                    "s""string",
                                    "d"1.5,
                                    "precision"1,
                                    "format""SHORT_DATE",
                                    "i"1,
                                    "l"{
                                        "id""string",
                                        "params"[
                                            {
                                                "value"{
                                                    "dt""2015-01-01T22:13:05.651Z",
                                                    "s""string",
                                                    "d"1.5,
                                                    "precision"1,
                                                    "format""SHORT_DATE",
                                                    "i"1,
                                                    "l"{
                                                        "id""string",
                                                        "params"[
                                                            {
                                                                "key""string"
                                                            }
                                                        ]
                                                    }
                                                },
                                                "key""string"
                                            }
                                        ]
                                    }
                                },
                                "key""string"
                            }
                        ]
                    },
                    "msg_type""INFO",
                    "unit_type""MANAGER"
                }
            ],
            "display_name"{
                "args"[
                    "string",
                    "string"
                ],
                "default_message""string",
                "localized""string",
                "id""string",
                "params"[
                    {
                        "value"{
                            "dt""2015-01-01T22:13:05.651Z",
                            "s""string",
                            "d"1.5,
                            "precision"1,
                            "format""SHORT_DATE",
                            "i"1,
                            "l"{
                                "id""string",
                                "params"[
                                    {
                                        "value"{
                                            "dt""2015-01-01T22:13:05.651Z",
                                            "s""string",
                                            "d"1.5,
                                            "precision"1,
                                            "format""SHORT_DATE",
                                            "i"1,
                                            "l"{
                                                "id""string",
                                                "params"[
                                                    {
                                                        "key""string"
                                                    }
                                                ]
                                            }
                                        },
                                        "key""string"
                                    }
                                ]
                            }
                        },
                        "key""string"
                    }
                ]
            },
            "tasks"[
                null,
                null
            ],
            "status""NOT_STARTED"
        }
    ],
    "status""NOT_STARTED"
}

Attributes:

Name Type Description
Required
-.name string The name of the operation. Warning: This attribute is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented.

-.display_name.id string Unique identifier of the localizable string or message template.

This identifier is typically used to retrieve a locale-specific string or message template from a message catalog.

-.display_name.default_message string The value of this localizable string or message template in the en_US (English) locale. If vapi.std.localizable_message.id refers to a message template, the default message will contain the substituted arguments. This value can be used by clients that do not need to display strings and messages in the native language of the user. It could also be used as a fallback if a client is unable to access the appropriate message catalog.

-.display_name.args string[] Positional arguments to be substituted into the message template. This list will be empty if the message uses named arguments or has no arguments.

-.status string The status of the operation. Warning: This attribute is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented.

Defines the current status of the operation. Warning: This enumeration is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented. Value is one of:
NOT_STARTED: The operation is not yet started. Warning: This constant is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented.
IN_PROGRESS: The operation is in progress. Warning: This constant is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented.
PAUSED: The operation is paused. Warning: This constant is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented.
COMPLETED_SUCCESS: The operation completed with success. Warning: This constant is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented.
COMPLETED_ERROR: The operation completed with errors. Warning: This constant is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented.

Optional
-.display_name localizable_message The display name of the operation in localizable strucutre. Warning: This attribute is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented.

Optional. Only set if display name is present.

-.display_name.params object Named arguments to be substituted into the message template. This attribute was added in vSphere API 7.0.0.0.

Optional. Unset means that the message template requires no arguments or positional arguments are used.

-.display_name.localized string Localized string value as per request requirements. This attribute was added in vSphere API 7.0.0.0.

Optional. when the client has not requested specific locale the implementation may not populate this field to conserve resources.

-.start_time date_time The time when the operation was started. Warning: This attribute is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented.

Optional. Only set if the opeation is started and the operation supports start time.

-.end_time date_time The time when the operation ended. Warning: This attribute is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented.

Optional. Only set if the operation is completed and the operation supports end time.

-.progress double The progress of the operation in percentage. Warning: This attribute is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented.

Optional. Only set if the operation supports percentage progress.

-.messages message[] The messages corresponding to the operation. Warning: This attribute is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented.

Optional. Only set if messages are present.

-.tasks operation[] The list of tasks associated with the current operation. Warning: This attribute is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented.

Optional. Only set if sub tasks are present.