com.vmware.nsx.upgrade package

Submodules

com.vmware.nsx.upgrade.bundles_client module

class com.vmware.nsx.upgrade.bundles_client.StubFactory(stub_config)

Bases: vmware.vapi.bindings.stub.StubFactoryBase

Initialize StubFactoryBase

Parameters

stub_config (vmware.vapi.bindings.stub.StubConfiguration) – Stub config instance

class com.vmware.nsx.upgrade.bundles_client.UploadStatus(config)

Bases: vmware.vapi.bindings.stub.VapiInterface

Parameters

config (vmware.vapi.bindings.stub.StubConfiguration) – Configuration to be used for creating the stub.

get(bundle_id)

Get uploaded upgrade bundle upload status

Parameters

bundle_id (str) – (required)

Return type

com.vmware.nsx.model_client.UpgradeBundleUploadStatus

Returns

com.vmware.nsx.model.UpgradeBundleUploadStatus

Raise

com.vmware.vapi.std.errors_client.ServiceUnavailable Service Unavailable

Raise

com.vmware.vapi.std.errors_client.InvalidRequest Bad Request, Precondition Failed

Raise

com.vmware.vapi.std.errors_client.InternalServerError Internal Server Error

Raise

com.vmware.vapi.std.errors_client.Unauthorized Forbidden

Raise

com.vmware.vapi.std.errors_client.NotFound Not Found

com.vmware.nsx.upgrade.eula_client module

class com.vmware.nsx.upgrade.eula_client.Accept(config)

Bases: vmware.vapi.bindings.stub.VapiInterface

Parameters

config (vmware.vapi.bindings.stub.StubConfiguration) – Configuration to be used for creating the stub.

create()

Accept end user license agreement

Raise

com.vmware.vapi.std.errors_client.ServiceUnavailable Service Unavailable

Raise

com.vmware.vapi.std.errors_client.InvalidRequest Bad Request, Precondition Failed

Raise

com.vmware.vapi.std.errors_client.InternalServerError Internal Server Error

Raise

com.vmware.vapi.std.errors_client.Unauthorized Forbidden

Raise

com.vmware.vapi.std.errors_client.NotFound Not Found

class com.vmware.nsx.upgrade.eula_client.Acceptance(config)

Bases: vmware.vapi.bindings.stub.VapiInterface

Parameters

config (vmware.vapi.bindings.stub.StubConfiguration) – Configuration to be used for creating the stub.

get()

Return the acceptance status of end user license agreement

Return type

com.vmware.nsx.model_client.EULAAcceptance

Returns

com.vmware.nsx.model.EULAAcceptance

Raise

com.vmware.vapi.std.errors_client.ServiceUnavailable Service Unavailable

Raise

com.vmware.vapi.std.errors_client.InvalidRequest Bad Request, Precondition Failed

Raise

com.vmware.vapi.std.errors_client.InternalServerError Internal Server Error

Raise

com.vmware.vapi.std.errors_client.Unauthorized Forbidden

Raise

com.vmware.vapi.std.errors_client.NotFound Not Found

class com.vmware.nsx.upgrade.eula_client.Content(config)

Bases: vmware.vapi.bindings.stub.VapiInterface

Parameters

config (vmware.vapi.bindings.stub.StubConfiguration) – Configuration to be used for creating the stub.

get(cursor=None, format=None, included_fields=None, page_size=None, sort_ascending=None, sort_by=None)

Return the content of end user license agreement in the specified format. By default, it’s pure string without line break

Parameters

  • cursor (str or None) – Opaque cursor to be used for getting next page of records (supplied by current result page) (optional)

  • format (str or None) – End User License Agreement content output format (optional)

  • included_fields (str or None) – Comma separated list of fields that should be included in query result (optional)

  • page_size (long or None) – Maximum number of results to return in this page (server may return fewer) (optional, default to 1000)

  • sort_ascending (bool or None) – (optional)

  • sort_by (str or None) – Field by which records are sorted (optional)

Return type

com.vmware.nsx.model_client.EULAContent

Returns

com.vmware.nsx.model.EULAContent

Raise

com.vmware.vapi.std.errors_client.ServiceUnavailable Service Unavailable

Raise

com.vmware.vapi.std.errors_client.InvalidRequest Bad Request, Precondition Failed

Raise

com.vmware.vapi.std.errors_client.InternalServerError Internal Server Error

Raise

com.vmware.vapi.std.errors_client.Unauthorized Forbidden

Raise

com.vmware.vapi.std.errors_client.NotFound Not Found

class com.vmware.nsx.upgrade.eula_client.StubFactory(stub_config)

Bases: vmware.vapi.bindings.stub.StubFactoryBase

Initialize StubFactoryBase

Parameters

stub_config (vmware.vapi.bindings.stub.StubConfiguration) – Stub config instance

com.vmware.nsx.upgrade.plan_client module

class com.vmware.nsx.upgrade.plan_client.Settings(config)

Bases: vmware.vapi.bindings.stub.VapiInterface

Parameters

config (vmware.vapi.bindings.stub.StubConfiguration) – Configuration to be used for creating the stub.

get(component_type)

Get the upgrade plan settings for the component.

Parameters

component_type (str) – (required)

Return type

com.vmware.nsx.model_client.UpgradePlanSettings

Returns

com.vmware.nsx.model.UpgradePlanSettings

Raise

com.vmware.vapi.std.errors_client.ServiceUnavailable Service Unavailable

Raise

com.vmware.vapi.std.errors_client.InvalidRequest Bad Request, Precondition Failed

Raise

com.vmware.vapi.std.errors_client.InternalServerError Internal Server Error

Raise

com.vmware.vapi.std.errors_client.Unauthorized Forbidden

Raise

com.vmware.vapi.std.errors_client.NotFound Not Found

update(component_type, upgrade_plan_settings)

Update the upgrade plan settings for the component.

Parameters
Return type

com.vmware.nsx.model_client.UpgradePlanSettings

Returns

com.vmware.nsx.model.UpgradePlanSettings

Raise

com.vmware.vapi.std.errors_client.ServiceUnavailable Service Unavailable

Raise

com.vmware.vapi.std.errors_client.InvalidRequest Bad Request, Precondition Failed

Raise

com.vmware.vapi.std.errors_client.InternalServerError Internal Server Error

Raise

com.vmware.vapi.std.errors_client.Unauthorized Forbidden

Raise

com.vmware.vapi.std.errors_client.NotFound Not Found

class com.vmware.nsx.upgrade.plan_client.StubFactory(stub_config)

Bases: vmware.vapi.bindings.stub.StubFactoryBase

Initialize StubFactoryBase

Parameters

stub_config (vmware.vapi.bindings.stub.StubConfiguration) – Stub config instance

com.vmware.nsx.upgrade.upgrade_unit_groups_client module

class com.vmware.nsx.upgrade.upgrade_unit_groups_client.AggregateInfo(config)

Bases: vmware.vapi.bindings.stub.VapiInterface

Parameters

config (vmware.vapi.bindings.stub.StubConfiguration) – Configuration to be used for creating the stub.

list(component_type=None, cursor=None, included_fields=None, page_size=None, sort_ascending=None, sort_by=None, summary=None, sync=None)

Return aggregate information of all upgrade unit groups

Parameters

  • component_type (str or None) – Component type based on which upgrade unit groups to be filtered (optional)

  • cursor (str or None) – Opaque cursor to be used for getting next page of records (supplied by current result page) (optional)

  • included_fields (str or None) – Comma separated list of fields that should be included in query result (optional)

  • page_size (long or None) – Maximum number of results to return in this page (server may return fewer) (optional, default to 1000)

  • sort_ascending (bool or None) – (optional)

  • sort_by (str or None) – Field by which records are sorted (optional)

  • summary (bool or None) – Flag indicating whether to return summary (optional, default to false)

  • sync (bool or None) – Synchronize before returning upgrade unit groups (optional, default to false)

Return type

com.vmware.nsx.model_client.UpgradeUnitGroupAggregateInfoListResult

Returns

com.vmware.nsx.model.UpgradeUnitGroupAggregateInfoListResult

Raise

com.vmware.vapi.std.errors_client.ServiceUnavailable Service Unavailable

Raise

com.vmware.vapi.std.errors_client.InvalidRequest Bad Request, Precondition Failed

Raise

com.vmware.vapi.std.errors_client.InternalServerError Internal Server Error

Raise

com.vmware.vapi.std.errors_client.Unauthorized Forbidden

Raise

com.vmware.vapi.std.errors_client.NotFound Not Found

class com.vmware.nsx.upgrade.upgrade_unit_groups_client.Status(config)

Bases: vmware.vapi.bindings.stub.VapiInterface

Parameters

config (vmware.vapi.bindings.stub.StubConfiguration) – Configuration to be used for creating the stub.

list(group_id, cursor=None, has_errors=None, included_fields=None, page_size=None, sort_ascending=None, sort_by=None)

Get upgrade status for group

Parameters

  • group_id (str) – (required)

  • cursor (str or None) – Opaque cursor to be used for getting next page of records (supplied by current result page) (optional)

  • has_errors (bool or None) – Flag to indicate whether to return only upgrade units with errors (optional, default to false)

  • included_fields (str or None) – Comma separated list of fields that should be included in query result (optional)

  • page_size (long or None) – Maximum number of results to return in this page (server may return fewer) (optional, default to 1000)

  • sort_ascending (bool or None) – (optional)

  • sort_by (str or None) – Field by which records are sorted (optional)

Return type

com.vmware.nsx.model_client.UpgradeUnitStatusListResult

Returns

com.vmware.nsx.model.UpgradeUnitStatusListResult

Raise

com.vmware.vapi.std.errors_client.ServiceUnavailable Service Unavailable

Raise

com.vmware.vapi.std.errors_client.InvalidRequest Bad Request, Precondition Failed

Raise

com.vmware.vapi.std.errors_client.InternalServerError Internal Server Error

Raise

com.vmware.vapi.std.errors_client.Unauthorized Forbidden

Raise

com.vmware.vapi.std.errors_client.NotFound Not Found

class com.vmware.nsx.upgrade.upgrade_unit_groups_client.StubFactory(stub_config)

Bases: vmware.vapi.bindings.stub.StubFactoryBase

Initialize StubFactoryBase

Parameters

stub_config (vmware.vapi.bindings.stub.StubConfiguration) – Stub config instance

class com.vmware.nsx.upgrade.upgrade_unit_groups_client.UpgradeUnit(config)

Bases: vmware.vapi.bindings.stub.VapiInterface

Parameters

config (vmware.vapi.bindings.stub.StubConfiguration) – Configuration to be used for creating the stub.

reorder(group_id, upgrade_unit_id, reorder_request)

Reorder an upgrade unit within the upgrade unit group

Parameters
Raise

com.vmware.vapi.std.errors_client.ServiceUnavailable Service Unavailable

Raise

com.vmware.vapi.std.errors_client.InvalidRequest Bad Request, Precondition Failed

Raise

com.vmware.vapi.std.errors_client.InternalServerError Internal Server Error

Raise

com.vmware.vapi.std.errors_client.Unauthorized Forbidden

Raise

com.vmware.vapi.std.errors_client.NotFound Not Found

com.vmware.nsx.upgrade.upgrade_units_client module

class com.vmware.nsx.upgrade.upgrade_units_client.AggregateInfo(config)

Bases: vmware.vapi.bindings.stub.VapiInterface

Parameters

config (vmware.vapi.bindings.stub.StubConfiguration) – Configuration to be used for creating the stub.

LIST_SELECTION_STATUS_ALL = 'ALL'

Possible value for selectionStatus of method AggregateInfo.list().

LIST_SELECTION_STATUS_DESELECTED = 'DESELECTED'

Possible value for selectionStatus of method AggregateInfo.list().

LIST_SELECTION_STATUS_SELECTED = 'SELECTED'

Possible value for selectionStatus of method AggregateInfo.list().

list(component_type=None, cursor=None, group_id=None, has_errors=None, included_fields=None, metadata=None, page_size=None, selection_status=None, sort_ascending=None, sort_by=None)

Get upgrade units aggregate-info

Parameters

  • component_type (str or None) – Component type based on which upgrade units to be filtered (optional)

  • cursor (str or None) – Opaque cursor to be used for getting next page of records (supplied by current result page) (optional)

  • group_id (str or None) – Identifier of group based on which upgrade units to be filtered (optional)

  • has_errors (bool or None) – Flag to indicate whether to return only upgrade units with errors (optional, default to false)

  • included_fields (str or None) – Comma separated list of fields that should be included in query result (optional)

  • metadata (str or None) – Metadata about upgrade unit to filter on (optional)

  • page_size (long or None) – Maximum number of results to return in this page (server may return fewer) (optional, default to 1000)

  • selection_status (str or None) – Flag to indicate whether to return only selected, only deselected or both type of upgrade units (optional, default to ALL)

  • sort_ascending (bool or None) – (optional)

  • sort_by (str or None) – Field by which records are sorted (optional)

Return type

com.vmware.nsx.model_client.UpgradeUnitAggregateInfoListResult

Returns

com.vmware.nsx.model.UpgradeUnitAggregateInfoListResult

Raise

com.vmware.vapi.std.errors_client.ServiceUnavailable Service Unavailable

Raise

com.vmware.vapi.std.errors_client.InvalidRequest Bad Request, Precondition Failed

Raise

com.vmware.vapi.std.errors_client.InternalServerError Internal Server Error

Raise

com.vmware.vapi.std.errors_client.Unauthorized Forbidden

Raise

com.vmware.vapi.std.errors_client.NotFound Not Found

class com.vmware.nsx.upgrade.upgrade_units_client.StubFactory(stub_config)

Bases: vmware.vapi.bindings.stub.StubFactoryBase

Initialize StubFactoryBase

Parameters

stub_config (vmware.vapi.bindings.stub.StubConfiguration) – Stub config instance