def __init__(self, config):
# properties for create operation
create_input_type = type.StructType('operation-input', {
'container_cluster_status': type.ReferenceType('com.vmware.nsx.model_client', 'ContainerClusterStatus'),
})
create_error_dict = {
'com.vmware.vapi.std.errors.service_unavailable':
type.ReferenceType('com.vmware.vapi.std.errors_client', 'ServiceUnavailable'),
'com.vmware.vapi.std.errors.invalid_request':
type.ReferenceType('com.vmware.vapi.std.errors_client', 'InvalidRequest'),
'com.vmware.vapi.std.errors.internal_server_error':
type.ReferenceType('com.vmware.vapi.std.errors_client', 'InternalServerError'),
'com.vmware.vapi.std.errors.unauthorized':
type.ReferenceType('com.vmware.vapi.std.errors_client', 'Unauthorized'),
'com.vmware.vapi.std.errors.not_found':
type.ReferenceType('com.vmware.vapi.std.errors_client', 'NotFound'),
}
create_input_value_validator_list = [
]
create_output_validator_list = [
]
create_rest_metadata = OperationRestMetadata(
http_method='POST',
url_template='/api/v1/systemhealth/container-cluster/ncp/status',
request_body_parameter='container_cluster_status',
path_variables={
},
query_parameters={
},
content_type='application/json'
)
# properties for delete operation
delete_input_type = type.StructType('operation-input', {
'cluster_id': type.StringType(),
})
delete_error_dict = {
'com.vmware.vapi.std.errors.service_unavailable':
type.ReferenceType('com.vmware.vapi.std.errors_client', 'ServiceUnavailable'),
'com.vmware.vapi.std.errors.invalid_request':
type.ReferenceType('com.vmware.vapi.std.errors_client', 'InvalidRequest'),
'com.vmware.vapi.std.errors.internal_server_error':
type.ReferenceType('com.vmware.vapi.std.errors_client', 'InternalServerError'),
'com.vmware.vapi.std.errors.unauthorized':
type.ReferenceType('com.vmware.vapi.std.errors_client', 'Unauthorized'),
'com.vmware.vapi.std.errors.not_found':
type.ReferenceType('com.vmware.vapi.std.errors_client', 'NotFound'),
}
delete_input_value_validator_list = [
]
delete_output_validator_list = [
]
delete_rest_metadata = OperationRestMetadata(
http_method='DELETE',
url_template='/api/v1/systemhealth/container-cluster/{cluster-id}/ncp/status',
path_variables={
'cluster_id': 'cluster-id',
},
query_parameters={
},
content_type='application/json'
)
# properties for get operation
get_input_type = type.StructType('operation-input', {
'cursor': type.OptionalType(type.StringType()),
'included_fields': type.OptionalType(type.StringType()),
'page_size': type.OptionalType(type.IntegerType()),
'sort_ascending': type.OptionalType(type.BooleanType()),
'sort_by': type.OptionalType(type.StringType()),
})
get_error_dict = {
'com.vmware.vapi.std.errors.service_unavailable':
type.ReferenceType('com.vmware.vapi.std.errors_client', 'ServiceUnavailable'),
'com.vmware.vapi.std.errors.invalid_request':
type.ReferenceType('com.vmware.vapi.std.errors_client', 'InvalidRequest'),
'com.vmware.vapi.std.errors.internal_server_error':
type.ReferenceType('com.vmware.vapi.std.errors_client', 'InternalServerError'),
'com.vmware.vapi.std.errors.unauthorized':
type.ReferenceType('com.vmware.vapi.std.errors_client', 'Unauthorized'),
'com.vmware.vapi.std.errors.not_found':
type.ReferenceType('com.vmware.vapi.std.errors_client', 'NotFound'),
}
get_input_value_validator_list = [
]
get_output_validator_list = [
]
get_rest_metadata = OperationRestMetadata(
http_method='GET',
url_template='/api/v1/systemhealth/container-cluster/ncp/status',
path_variables={
},
query_parameters={
'cursor': 'cursor',
'included_fields': 'included_fields',
'page_size': 'page_size',
'sort_ascending': 'sort_ascending',
'sort_by': 'sort_by',
},
content_type='application/json'
)
# properties for get_0 operation
get_0_input_type = type.StructType('operation-input', {
'cluster_id': type.StringType(),
})
get_0_error_dict = {
'com.vmware.vapi.std.errors.service_unavailable':
type.ReferenceType('com.vmware.vapi.std.errors_client', 'ServiceUnavailable'),
'com.vmware.vapi.std.errors.invalid_request':
type.ReferenceType('com.vmware.vapi.std.errors_client', 'InvalidRequest'),
'com.vmware.vapi.std.errors.internal_server_error':
type.ReferenceType('com.vmware.vapi.std.errors_client', 'InternalServerError'),
'com.vmware.vapi.std.errors.unauthorized':
type.ReferenceType('com.vmware.vapi.std.errors_client', 'Unauthorized'),
'com.vmware.vapi.std.errors.not_found':
type.ReferenceType('com.vmware.vapi.std.errors_client', 'NotFound'),
}
get_0_input_value_validator_list = [
]
get_0_output_validator_list = [
]
get_0_rest_metadata = OperationRestMetadata(
http_method='GET',
url_template='/api/v1/systemhealth/container-cluster/{cluster-id}/ncp/status',
path_variables={
'cluster_id': 'cluster-id',
},
query_parameters={
},
content_type='application/json'
)
operations = {
'create': {
'input_type': create_input_type,
'output_type': type.ReferenceType('com.vmware.nsx.model_client', 'ContainerClusterStatus'),
'errors': create_error_dict,
'input_value_validator_list': create_input_value_validator_list,
'output_validator_list': create_output_validator_list,
'task_type': TaskType.NONE,
},
'delete': {
'input_type': delete_input_type,
'output_type': type.VoidType(),
'errors': delete_error_dict,
'input_value_validator_list': delete_input_value_validator_list,
'output_validator_list': delete_output_validator_list,
'task_type': TaskType.NONE,
},
'get': {
'input_type': get_input_type,
'output_type': type.ReferenceType('com.vmware.nsx.model_client', 'ContainerClusterStatusList'),
'errors': get_error_dict,
'input_value_validator_list': get_input_value_validator_list,
'output_validator_list': get_output_validator_list,
'task_type': TaskType.NONE,
},
'get_0': {
'input_type': get_0_input_type,
'output_type': type.ReferenceType('com.vmware.nsx.model_client', 'ContainerClusterSummary'),
'errors': get_0_error_dict,
'input_value_validator_list': get_0_input_value_validator_list,
'output_validator_list': get_0_output_validator_list,
'task_type': TaskType.NONE,
},
}
rest_metadata = {
'create': create_rest_metadata,
'delete': delete_rest_metadata,
'get': get_rest_metadata,
'get_0': get_0_rest_metadata,
}
ApiInterfaceStub.__init__(
self, iface_name='com.vmware.nsx.systemhealth.container_cluster.ncp.status',
config=config, operations=operations, rest_metadata=rest_metadata,
is_vapi_rest=False)
def __init__(self, config):
# properties for create operation
create_input_type = type.StructType('operation-input', {
'role_binding': type.ReferenceType('com.vmware.nsx_policy.model_client', 'RoleBinding'),
})
create_error_dict = {
'com.vmware.vapi.std.errors.service_unavailable':
type.ReferenceType('com.vmware.vapi.std.errors_client', 'ServiceUnavailable'),
'com.vmware.vapi.std.errors.invalid_request':
type.ReferenceType('com.vmware.vapi.std.errors_client', 'InvalidRequest'),
'com.vmware.vapi.std.errors.internal_server_error':
type.ReferenceType('com.vmware.vapi.std.errors_client', 'InternalServerError'),
'com.vmware.vapi.std.errors.unauthorized':
type.ReferenceType('com.vmware.vapi.std.errors_client', 'Unauthorized'),
'com.vmware.vapi.std.errors.not_found':
type.ReferenceType('com.vmware.vapi.std.errors_client', 'NotFound'),
}
create_input_value_validator_list = [
]
create_output_validator_list = [
]
create_rest_metadata = OperationRestMetadata(
http_method='POST',
url_template='/policy/api/v1/aaa/role-bindings',
request_body_parameter='role_binding',
path_variables={
},
query_parameters={
}
)
# properties for delete operation
delete_input_type = type.StructType('operation-input', {
'binding_id': type.StringType(),
})
delete_error_dict = {
'com.vmware.vapi.std.errors.service_unavailable':
type.ReferenceType('com.vmware.vapi.std.errors_client', 'ServiceUnavailable'),
'com.vmware.vapi.std.errors.invalid_request':
type.ReferenceType('com.vmware.vapi.std.errors_client', 'InvalidRequest'),
'com.vmware.vapi.std.errors.internal_server_error':
type.ReferenceType('com.vmware.vapi.std.errors_client', 'InternalServerError'),
'com.vmware.vapi.std.errors.unauthorized':
type.ReferenceType('com.vmware.vapi.std.errors_client', 'Unauthorized'),
'com.vmware.vapi.std.errors.not_found':
type.ReferenceType('com.vmware.vapi.std.errors_client', 'NotFound'),
}
delete_input_value_validator_list = [
]
delete_output_validator_list = [
]
delete_rest_metadata = OperationRestMetadata(
http_method='DELETE',
url_template='/policy/api/v1/aaa/role-bindings/{binding-id}',
path_variables={
'binding_id': 'binding-id',
},
query_parameters={
}
)
# properties for get operation
get_input_type = type.StructType('operation-input', {
'binding_id': type.StringType(),
})
get_error_dict = {
'com.vmware.vapi.std.errors.service_unavailable':
type.ReferenceType('com.vmware.vapi.std.errors_client', 'ServiceUnavailable'),
'com.vmware.vapi.std.errors.invalid_request':
type.ReferenceType('com.vmware.vapi.std.errors_client', 'InvalidRequest'),
'com.vmware.vapi.std.errors.internal_server_error':
type.ReferenceType('com.vmware.vapi.std.errors_client', 'InternalServerError'),
'com.vmware.vapi.std.errors.unauthorized':
type.ReferenceType('com.vmware.vapi.std.errors_client', 'Unauthorized'),
'com.vmware.vapi.std.errors.not_found':
type.ReferenceType('com.vmware.vapi.std.errors_client', 'NotFound'),
}
get_input_value_validator_list = [
]
get_output_validator_list = [
]
get_rest_metadata = OperationRestMetadata(
http_method='GET',
url_template='/policy/api/v1/aaa/role-bindings/{binding-id}',
path_variables={
'binding_id': 'binding-id',
},
query_parameters={
}
)
# properties for list operation
list_input_type = type.StructType('operation-input', {
'cursor': type.OptionalType(type.StringType()),
'included_fields': type.OptionalType(type.StringType()),
'name': type.OptionalType(type.StringType()),
'page_size': type.OptionalType(type.IntegerType()),
'sort_ascending': type.OptionalType(type.BooleanType()),
'sort_by': type.OptionalType(type.StringType()),
'type': type.OptionalType(type.StringType()),
})
list_error_dict = {
'com.vmware.vapi.std.errors.service_unavailable':
type.ReferenceType('com.vmware.vapi.std.errors_client', 'ServiceUnavailable'),
'com.vmware.vapi.std.errors.invalid_request':
type.ReferenceType('com.vmware.vapi.std.errors_client', 'InvalidRequest'),
'com.vmware.vapi.std.errors.internal_server_error':
type.ReferenceType('com.vmware.vapi.std.errors_client', 'InternalServerError'),
'com.vmware.vapi.std.errors.unauthorized':
type.ReferenceType('com.vmware.vapi.std.errors_client', 'Unauthorized'),
'com.vmware.vapi.std.errors.not_found':
type.ReferenceType('com.vmware.vapi.std.errors_client', 'NotFound'),
}
list_input_value_validator_list = [
]
list_output_validator_list = [
]
list_rest_metadata = OperationRestMetadata(
http_method='GET',
url_template='/policy/api/v1/aaa/role-bindings',
path_variables={
},
query_parameters={
'cursor': 'cursor',
'included_fields': 'included_fields',
'name': 'name',
'page_size': 'page_size',
'sort_ascending': 'sort_ascending',
'sort_by': 'sort_by',
'type': 'type',
}
)
# properties for update operation
update_input_type = type.StructType('operation-input', {
'binding_id': type.StringType(),
'role_binding': type.ReferenceType('com.vmware.nsx_policy.model_client', 'RoleBinding'),
})
update_error_dict = {
'com.vmware.vapi.std.errors.service_unavailable':
type.ReferenceType('com.vmware.vapi.std.errors_client', 'ServiceUnavailable'),
'com.vmware.vapi.std.errors.invalid_request':
type.ReferenceType('com.vmware.vapi.std.errors_client', 'InvalidRequest'),
'com.vmware.vapi.std.errors.internal_server_error':
type.ReferenceType('com.vmware.vapi.std.errors_client', 'InternalServerError'),
'com.vmware.vapi.std.errors.unauthorized':
type.ReferenceType('com.vmware.vapi.std.errors_client', 'Unauthorized'),
'com.vmware.vapi.std.errors.not_found':
type.ReferenceType('com.vmware.vapi.std.errors_client', 'NotFound'),
}
update_input_value_validator_list = [
]
update_output_validator_list = [
]
update_rest_metadata = OperationRestMetadata(
http_method='PUT',
url_template='/policy/api/v1/aaa/role-bindings/{binding-id}',
request_body_parameter='role_binding',
path_variables={
'binding_id': 'binding-id',
},
query_parameters={
}
)
operations = {
'create': {
'input_type': create_input_type,
'output_type': type.ReferenceType('com.vmware.nsx_policy.model_client', 'RoleBinding'),
'errors': create_error_dict,
'input_value_validator_list': create_input_value_validator_list,
'output_validator_list': create_output_validator_list,
'task_type': TaskType.NONE,
},
'delete': {
'input_type': delete_input_type,
'output_type': type.VoidType(),
'errors': delete_error_dict,
'input_value_validator_list': delete_input_value_validator_list,
'output_validator_list': delete_output_validator_list,
'task_type': TaskType.NONE,
},
'get': {
'input_type': get_input_type,
'output_type': type.ReferenceType('com.vmware.nsx_policy.model_client', 'RoleBinding'),
'errors': get_error_dict,
'input_value_validator_list': get_input_value_validator_list,
'output_validator_list': get_output_validator_list,
'task_type': TaskType.NONE,
},
'list': {
'input_type': list_input_type,
'output_type': type.ReferenceType('com.vmware.nsx_policy.model_client', 'RoleBindingListResult'),
'errors': list_error_dict,
'input_value_validator_list': list_input_value_validator_list,
'output_validator_list': list_output_validator_list,
'task_type': TaskType.NONE,
},
'update': {
'input_type': update_input_type,
'output_type': type.ReferenceType('com.vmware.nsx_policy.model_client', 'RoleBinding'),
'errors': update_error_dict,
'input_value_validator_list': update_input_value_validator_list,
'output_validator_list': update_output_validator_list,
'task_type': TaskType.NONE,
},
}
rest_metadata = {
'create': create_rest_metadata,
'delete': delete_rest_metadata,
'get': get_rest_metadata,
'list': list_rest_metadata,
'update': update_rest_metadata,
}
ApiInterfaceStub.__init__(
self, iface_name='com.vmware.nsx_policy.aaa.role_bindings',
config=config, operations=operations, rest_metadata=rest_metadata,
is_vapi_rest=False)
class Parts(VapiInterface):
"""
``Parts`` class provides methods Provides list of parts optional for the
backup
"""
def __init__(self, config):
"""
:type config: :class:`vmware.vapi.bindings.stub.StubConfiguration`
:param config: Configuration to be used for creating the stub.
"""
VapiInterface.__init__(self, config, _PartsStub)
class LocalizableMessage(VapiStruct):
"""
``Parts.LocalizableMessage`` class Structure representing message
.. tip::
The arguments are used to initialize data attributes with the same
names.
"""
def __init__(
self,
id=None,
default_message=None,
args=None,
):
"""
:type id: :class:`str`
:param id: id in message bundle
:type default_message: :class:`str`
:param default_message: text in english
:type args: :class:`list` of :class:`str`
:param args: nested data
"""
self.id = id
self.default_message = default_message
self.args = args
VapiStruct.__init__(self)
LocalizableMessage._set_binding_type(
type.StructType(
'com.vmware.appliance.recovery.backup.parts.localizable_message', {
'id': type.StringType(),
'default_message': type.StringType(),
'args': type.ListType(type.StringType()),
}, LocalizableMessage, False, None))
class Part(VapiStruct):
"""
``Parts.Part`` class Structure representing backup restore part
.. tip::
The arguments are used to initialize data attributes with the same
names.
"""
def __init__(
self,
id=None,
name=None,
description=None,
selected_by_default=None,
optional=None,
):
"""
:type id: :class:`str`
:param id: part ID
When clients pass a value of this class as a parameter, the
attribute must be an identifier for the resource type:
``com.vmware.appliance.recovery.backup.parts``. When methods return
a value of this class as a return value, the attribute will be an
identifier for the resource type:
``com.vmware.appliance.recovery.backup.parts``.
:type name: :class:`Parts.LocalizableMessage`
:param name: part name id in message bundle
:type description: :class:`Parts.LocalizableMessage`
:param description: part description id in message bundle
:type selected_by_default: :class:`bool`
:param selected_by_default: Is part selected by default in UI
:type optional: :class:`bool`
:param optional: Estimated size of this piece
"""
self.id = id
self.name = name
self.description = description
self.selected_by_default = selected_by_default
self.optional = optional
VapiStruct.__init__(self)
Part._set_binding_type(
type.StructType(
'com.vmware.appliance.recovery.backup.parts.part', {
'id':
type.IdType(
resource_types='com.vmware.appliance.recovery.backup.parts'
),
'name':
type.ReferenceType(sys.modules[__name__],
'Parts.LocalizableMessage'),
'description':
type.ReferenceType(sys.modules[__name__],
'Parts.LocalizableMessage'),
'selected_by_default':
type.BooleanType(),
'optional':
type.BooleanType(),
}, Part, False, None))
def list(self):
"""
Get a list of the backup parts
:rtype: :class:`list` of :class:`Parts.Part`
:return: list of parts
:raise: :class:`com.vmware.vapi.std.errors_client.Error`
Generic error
"""
return self._invoke('list', None)
def get(
self,
id,
):
"""
Get size of the optional part
:type id: :class:`str`
:param id: part id
The parameter must be an identifier for the resource type:
``com.vmware.appliance.recovery.backup.parts``.
:rtype: :class:`long`
:return: int size
:raise: :class:`com.vmware.vapi.std.errors_client.Error`
Generic error
"""
return self._invoke('get', {
'id': id,
})
def __init__(self, config):
# properties for apply operation
apply_input_type = type.StructType('operation-input', {
'upgrade_topology': type.ReferenceType('com.vmware.nsx.model_client', 'UpgradeTopology'),
})
apply_error_dict = {
'com.vmware.vapi.std.errors.service_unavailable':
type.ReferenceType('com.vmware.vapi.std.errors_client', 'ServiceUnavailable'),
'com.vmware.vapi.std.errors.invalid_request':
type.ReferenceType('com.vmware.vapi.std.errors_client', 'InvalidRequest'),
'com.vmware.vapi.std.errors.internal_server_error':
type.ReferenceType('com.vmware.vapi.std.errors_client', 'InternalServerError'),
'com.vmware.vapi.std.errors.unauthorized':
type.ReferenceType('com.vmware.vapi.std.errors_client', 'Unauthorized'),
'com.vmware.vapi.std.errors.not_found':
type.ReferenceType('com.vmware.vapi.std.errors_client', 'NotFound'),
}
apply_input_value_validator_list = [
]
apply_output_validator_list = [
]
apply_rest_metadata = OperationRestMetadata(
http_method='POST',
url_template='/api/v1/nvds-urt/topology?action=apply',
request_body_parameter='upgrade_topology',
path_variables={
},
query_parameters={
},
content_type='application/json'
)
# properties for get operation
get_input_type = type.StructType('operation-input', {
'precheck_id': type.StringType(),
'compute_manager_id': type.OptionalType(type.StringType()),
'show_vds_config': type.OptionalType(type.BooleanType()),
})
get_error_dict = {
'com.vmware.vapi.std.errors.service_unavailable':
type.ReferenceType('com.vmware.vapi.std.errors_client', 'ServiceUnavailable'),
'com.vmware.vapi.std.errors.invalid_request':
type.ReferenceType('com.vmware.vapi.std.errors_client', 'InvalidRequest'),
'com.vmware.vapi.std.errors.internal_server_error':
type.ReferenceType('com.vmware.vapi.std.errors_client', 'InternalServerError'),
'com.vmware.vapi.std.errors.unauthorized':
type.ReferenceType('com.vmware.vapi.std.errors_client', 'Unauthorized'),
'com.vmware.vapi.std.errors.not_found':
type.ReferenceType('com.vmware.vapi.std.errors_client', 'NotFound'),
}
get_input_value_validator_list = [
]
get_output_validator_list = [
]
get_rest_metadata = OperationRestMetadata(
http_method='GET',
url_template='/api/v1/nvds-urt/topology/{precheck-id}',
path_variables={
'precheck_id': 'precheck-id',
},
query_parameters={
'compute_manager_id': 'compute_manager_id',
'show_vds_config': 'show_vds_config',
},
content_type='application/json'
)
operations = {
'apply': {
'input_type': apply_input_type,
'output_type': type.ReferenceType('com.vmware.nsx.model_client', 'UpgradeTopology'),
'errors': apply_error_dict,
'input_value_validator_list': apply_input_value_validator_list,
'output_validator_list': apply_output_validator_list,
'task_type': TaskType.NONE,
},
'get': {
'input_type': get_input_type,
'output_type': type.ReferenceType('com.vmware.nsx.model_client', 'UpgradeTopology'),
'errors': get_error_dict,
'input_value_validator_list': get_input_value_validator_list,
'output_validator_list': get_output_validator_list,
'task_type': TaskType.NONE,
},
}
rest_metadata = {
'apply': apply_rest_metadata,
'get': get_rest_metadata,
}
ApiInterfaceStub.__init__(
self, iface_name='com.vmware.nsx.nvds_urt.topology',
config=config, operations=operations, rest_metadata=rest_metadata,
is_vapi_rest=False)
class Pscs(VapiInterface):
"""
The ``Pscs`` class provides methods to decommission the external Platform
Services Controller node. This class was added in vSphere API 6.7.2.
"""
_VAPI_SERVICE_ID = 'com.vmware.vcenter.topology.pscs'
"""
Identifier of the service in canonical form.
"""
def __init__(self, config):
"""
:type config: :class:`vmware.vapi.bindings.stub.StubConfiguration`
:param config: Configuration to be used for creating the stub.
"""
VapiInterface.__init__(self, config, _PscsStub)
class DecommissionSpec(VapiStruct):
"""
The ``Pscs.DecommissionSpec`` class contains information about the Platform
Services Controller node to be decommissioned. This class was added in
vSphere API 6.7.2.
.. tip::
The arguments are used to initialize data attributes with the same
names.
"""
def __init__(
self,
sso_admin_username=None,
sso_admin_password=None,
ssl_thumbprint=None,
ssl_verify=None,
):
"""
:type sso_admin_username: :class:`str`
:param sso_admin_username: The SSO administrator username for example
"administrator\\\\@vsphere.local". This attribute was added in
vSphere API 6.7.2.
:type sso_admin_password: :class:`str`
:param sso_admin_password: The SSO administrator account password. This attribute was added in
vSphere API 6.7.2.
:type ssl_thumbprint: :class:`str` or ``None``
:param ssl_thumbprint: SHA1 thumbprint of the external Platform Services Controller node
to be decommissioned that will be used for verification. This
attribute was added in vSphere API 6.7.2.
This attribute is only relevant if ``sslVerify`` is :class:`set` or
has the value true. No verification will be performed if
``sslVerify`` value is set to false.
:type ssl_verify: :class:`bool` or ``None``
:param ssl_verify: SSL verification should be enabled or disabled. This attribute was
added in vSphere API 6.7.2.
If None, ssl_verify false will be used.
"""
self.sso_admin_username = sso_admin_username
self.sso_admin_password = sso_admin_password
self.ssl_thumbprint = ssl_thumbprint
self.ssl_verify = ssl_verify
VapiStruct.__init__(self)
DecommissionSpec._set_binding_type(
type.StructType(
'com.vmware.vcenter.topology.pscs.decommission_spec', {
'sso_admin_username': type.StringType(),
'sso_admin_password': type.SecretType(),
'ssl_thumbprint': type.OptionalType(type.StringType()),
'ssl_verify': type.OptionalType(type.BooleanType()),
}, DecommissionSpec, False, None))
def decommission_task(
self,
hostname,
spec,
only_precheck=None,
):
"""
Decommission the external Platform Services Controller node. This
method was added in vSphere API 6.7.2.
:type hostname: :class:`str`
:param hostname: FQDN or IP address of external Platform Services Controller node to
be decommissioned.
The parameter must be an identifier for the resource type:
``com.vmware.vcenter.VCenter.name``.
:type spec: :class:`Pscs.DecommissionSpec`
:param spec: Information needed to decommission the external Platform Services
Controller node.
:type only_precheck: :class:`bool` or ``None``
:param only_precheck: Flag indicating whether only a pre-check should be performed.
If None the full decommission will be performed.
:raise: :class:`com.vmware.vapi.std.errors_client.Unsupported`
if the appliance is in not a management node.
:raise: :class:`com.vmware.vapi.std.errors_client.InvalidArgument`
if passed arguments are invalid.
:raise: :class:`com.vmware.vapi.std.errors_client.UnverifiedPeer`
If the SSL certificate of the foreign external Platform Services
Controller node cannot be validated.
The value of the data attribute of null will be a class that
contains all the attributes defined in null.
:raise: :class:`com.vmware.vapi.std.errors_client.Unauthenticated`
if the caller is not authenticated.
:raise: :class:`com.vmware.vapi.std.errors_client.NotAllowedInCurrentState`
if the provided Platform Services Controller node doesn't qualify
for decommission due to some reasons like it has some other nodes
connected to it.
"""
task_id = self._invoke('decommission$task', {
'hostname': hostname,
'spec': spec,
'only_precheck': only_precheck,
})
task_svc = Tasks(self._config)
task_instance = Task(task_id, task_svc, type.VoidType())
return task_instance
"""
:type ipv4_enabled: :class:`bool`
:param ipv4_enabled: True if IPv4 DHCP is enabled, false otherwise. This attribute was
added in vSphere API 7.0.0.
:type ipv6_enabled: :class:`bool`
:param ipv6_enabled: True if IPv6 DHCP is enabled, false otherwise. This attribute was
added in vSphere API 7.0.0.
"""
self.ipv4_enabled = ipv4_enabled
self.ipv6_enabled = ipv6_enabled
VapiStruct.__init__(self)
DhcpConfigInfo._set_binding_type(
type.StructType('com.vmware.vcenter.vm.guest.dhcp_config_info', {
'ipv4_enabled': type.BooleanType(),
'ipv6_enabled': type.BooleanType(),
}, DhcpConfigInfo, False, None))
class Customization(VapiInterface):
"""
The ``Customization`` class provides methods to apply a customization
specification to a virtual machine. This class was added in vSphere API
7.0.0.
"""
_VAPI_SERVICE_ID = 'com.vmware.vcenter.vm.guest.customization'
"""
Identifier of the service in canonical form.
"""
def __init__(self, config):
# properties for list operation
list_input_type = type.StructType(
'operation-input', {
'domain_id': type.StringType(),
'group_id': type.StringType(),
'cursor': type.OptionalType(type.StringType()),
'enforcement_point_path': type.OptionalType(type.StringType()),
'included_fields': type.OptionalType(type.StringType()),
'page_size': type.OptionalType(type.IntegerType()),
'sort_ascending': type.OptionalType(type.BooleanType()),
'sort_by': type.OptionalType(type.StringType()),
})
list_error_dict = {
'com.vmware.vapi.std.errors.service_unavailable':
type.ReferenceType('com.vmware.vapi.std.errors_client',
'ServiceUnavailable'),
'com.vmware.vapi.std.errors.invalid_request':
type.ReferenceType('com.vmware.vapi.std.errors_client',
'InvalidRequest'),
'com.vmware.vapi.std.errors.internal_server_error':
type.ReferenceType('com.vmware.vapi.std.errors_client',
'InternalServerError'),
'com.vmware.vapi.std.errors.unauthorized':
type.ReferenceType('com.vmware.vapi.std.errors_client',
'Unauthorized'),
'com.vmware.vapi.std.errors.not_found':
type.ReferenceType('com.vmware.vapi.std.errors_client',
'NotFound'),
}
list_input_value_validator_list = []
list_output_validator_list = []
list_rest_metadata = OperationRestMetadata(
http_method='GET',
url_template=
'/policy/api/v1/infra/domains/{domain-id}/groups/{group-id}/statistics/virtual-machines',
path_variables={
'domain_id': 'domain-id',
'group_id': 'group-id',
},
query_parameters={
'cursor': 'cursor',
'enforcement_point_path': 'enforcement_point_path',
'included_fields': 'included_fields',
'page_size': 'page_size',
'sort_ascending': 'sort_ascending',
'sort_by': 'sort_by',
},
content_type='application/json')
operations = {
'list': {
'input_type':
list_input_type,
'output_type':
type.ReferenceType('com.vmware.nsx_policy.model_client',
'RealizedVirtualMachineListResult'),
'errors':
list_error_dict,
'input_value_validator_list':
list_input_value_validator_list,
'output_validator_list':
list_output_validator_list,
'task_type':
TaskType.NONE,
},
}
rest_metadata = {
'list': list_rest_metadata,
}
ApiInterfaceStub.__init__(
self,
iface_name=
'com.vmware.nsx_policy.infra.domains.groups.statistics.virtual_machines',
config=config,
operations=operations,
rest_metadata=rest_metadata,
is_vapi_rest=False)
class Installer(VapiInterface):
"""
The ``Installer`` (\\\\@term service} provides methods to install VMware
Tools in the guest operating system. This class was added in vSphere API
7.0.0.
"""
_VAPI_SERVICE_ID = 'com.vmware.vcenter.vm.tools.installer'
"""
Identifier of the service in canonical form.
"""
def __init__(self, config):
"""
:type config: :class:`vmware.vapi.bindings.stub.StubConfiguration`
:param config: Configuration to be used for creating the stub.
"""
VapiInterface.__init__(self, config, _InstallerStub)
self._VAPI_OPERATION_IDS = {}
class Info(VapiStruct):
"""
The ``Installer.Info`` class contains information about the VMWare Tools
installer. This class was added in vSphere API 7.0.0.
.. tip::
The arguments are used to initialize data attributes with the same
names.
"""
def __init__(
self,
is_connected=None,
):
"""
:type is_connected: :class:`bool`
:param is_connected: Flag indicating whether the VMware Tools installer is mounted as a
CD-ROM. This attribute was added in vSphere API 7.0.0.
"""
self.is_connected = is_connected
VapiStruct.__init__(self)
Info._set_binding_type(
type.StructType('com.vmware.vcenter.vm.tools.installer.info', {
'is_connected': type.BooleanType(),
}, Info, False, None))
def get(
self,
vm,
):
"""
Get information about the VMware Tools installer. This method was added
in vSphere API 7.0.0.
:type vm: :class:`str`
:param vm: Identifier of the virtual machine.
The parameter must be an identifier for the resource type:
``VirtualMachine``.
:rtype: :class:`Installer.Info`
:return: information about the VMware Tools installer.
:raise: :class:`com.vmware.vapi.std.errors_client.Error`
if the system reports an error while responding to the request.
:raise: :class:`com.vmware.vapi.std.errors_client.NotFound`
if the virtual machine is not found.
"""
return self._invoke('get', {
'vm': vm,
})
def connect(
self,
vm,
):
"""
Connects the VMware Tools CD installer as a CD-ROM for the guest
operating system. On Windows guest operating systems with autorun, this
should cause the installer to initiate the Tools installation which
will need user input to complete. On other (non-Windows) guest
operating systems this will make the Tools installation available, and
a a user will need to do guest-specific actions. On Linux, this
includes opening an archive and running the installer. To monitor the
status of the Tools install, clients should check the ``versionStatus``
and ``runState`` from :func:`com.vmware.vcenter.vm_client.Tools.get`.
This method was added in vSphere API 7.0.0.
:type vm: :class:`str`
:param vm: Virtual machine ID
The parameter must be an identifier for the resource type:
``VirtualMachine``.
:raise: :class:`com.vmware.vapi.std.errors_client.NotFound`
if the virtual machine is not found.
:raise: :class:`com.vmware.vapi.std.errors_client.NotAllowedInCurrentState`
if the virtual machine is not powered on.
:raise: :class:`com.vmware.vapi.std.errors_client.AlreadyInDesiredState`
if the VMware Tools CD is already connected.
:raise: :class:`com.vmware.vapi.std.errors_client.Error`
if the Tools installation fails in the guest operating system.
"""
return self._invoke('connect', {
'vm': vm,
})
def disconnect(
self,
vm,
):
"""
Disconnect the VMware Tools installer CD image. This method was added
in vSphere API 7.0.0.
:type vm: :class:`str`
:param vm: Virtual machine ID
The parameter must be an identifier for the resource type:
``VirtualMachine``.
:raise: :class:`com.vmware.vapi.std.errors_client.Error`
if the system reports an error while responding to the request.
:raise: :class:`com.vmware.vapi.std.errors_client.NotFound`
if the virtual machine is not found.
:raise: :class:`com.vmware.vapi.std.errors_client.NotAllowedInCurrentState`
if the virtual machine is not powered on.
"""
return self._invoke('disconnect', {
'vm': vm,
})
class Details(VapiInterface):
"""
The ``Details`` class provides methods to get the details about backup
jobs. This class was added in vSphere API 6.7.
"""
_VAPI_SERVICE_ID = 'com.vmware.appliance.recovery.backup.job.details'
"""
Identifier of the service in canonical form.
"""
def __init__(self, config):
"""
:type config: :class:`vmware.vapi.bindings.stub.StubConfiguration`
:param config: Configuration to be used for creating the stub.
"""
VapiInterface.__init__(self, config, _DetailsStub)
class Type(Enum):
"""
The ``Details.Type`` class defines the type of backup job. This enumeration
was added in vSphere API 6.7.
.. note::
This class represents an enumerated type in the interface language
definition. The class contains class attributes which represent the
values in the current version of the enumerated type. Newer versions of
the enumerated type may contain new values. To use new values of the
enumerated type in communication with a server that supports the newer
version of the API, you instantiate this class. See :ref:`enumerated
type description page <enumeration_description>`.
"""
SCHEDULED = None
"""
Job type is Scheduled. This class attribute was added in vSphere API 6.7.
"""
MANUAL = None
"""
Job type is Manual. This class attribute was added in vSphere API 6.7.
"""
def __init__(self, string):
"""
:type string: :class:`str`
:param string: String value for the :class:`Type` instance.
"""
Enum.__init__(string)
Type._set_values([
Type('SCHEDULED'),
Type('MANUAL'),
])
Type._set_binding_type(
type.EnumType('com.vmware.appliance.recovery.backup.job.details.type',
Type))
class Info(VapiStruct):
"""
The ``Details.Info`` class contains information about a backup job. This
class was added in vSphere API 6.7.
.. tip::
The arguments are used to initialize data attributes with the same
names.
"""
_validator_list = [
UnionValidator(
'status', {
'SUCCEEDED': [('duration', True), ('size', True),
('progress', True), ('start_time', True),
('end_time', True)],
'FAILED': [('duration', True), ('size', True),
('progress', True), ('error', False),
('start_time', True), ('end_time', True)],
'RUNNING': [('duration', True), ('size', True),
('progress', True), ('start_time', True)],
'BLOCKED': [('start_time', True)],
'PENDING': [],
}),
]
def __init__(
self,
location=None,
duration=None,
size=None,
progress=None,
location_user=None,
type=None,
messages=None,
build=None,
description=None,
service=None,
operation=None,
parent=None,
target=None,
status=None,
cancelable=None,
error=None,
start_time=None,
end_time=None,
user=None,
):
"""
:type location: :class:`str`
:param location: URL of the backup location. This attribute was added in vSphere API
6.7.
:type duration: :class:`long`
:param duration: Time in seconds since the backup job was started or the time it
took to complete the backup job. This attribute was added in
vSphere API 6.7.
This attribute is optional and it is only relevant when the value
of ``#status`` is one of
:attr:`com.vmware.cis.task_client.Status.SUCCEEDED`,
:attr:`com.vmware.cis.task_client.Status.FAILED`, or
:attr:`com.vmware.cis.task_client.Status.RUNNING`.
:type size: :class:`long`
:param size: Size of the backup data transferred to remote location. This
attribute was added in vSphere API 6.7.
This attribute is optional and it is only relevant when the value
of ``#status`` is one of
:attr:`com.vmware.cis.task_client.Status.SUCCEEDED`,
:attr:`com.vmware.cis.task_client.Status.FAILED`, or
:attr:`com.vmware.cis.task_client.Status.RUNNING`.
:type progress: :class:`com.vmware.cis.task_client.Progress`
:param progress: Progress of the job. This attribute was added in vSphere API 6.7.
This attribute is optional and it is only relevant when the value
of ``#status`` is one of
:attr:`com.vmware.cis.task_client.Status.SUCCEEDED`,
:attr:`com.vmware.cis.task_client.Status.FAILED`, or
:attr:`com.vmware.cis.task_client.Status.RUNNING`.
:type location_user: :class:`str`
:param location_user: The username for the remote backup location. This attribute was
added in vSphere API 6.7.
:type type: :class:`Details.Type`
:param type: Type of the backup job. Indicates whether the backup was started
manually or as a scheduled backup. This attribute was added in
vSphere API 6.7.
:type messages: :class:`list` of :class:`com.vmware.vapi.std_client.LocalizableMessage`
:param messages: List of any info/warning/error messages returned by the backup job.
This attribute was added in vSphere API 6.7.
:type build: :class:`Details.BuildInfo`
:param build: Information about the build of the appliance. This attribute was
added in vSphere API 6.7.2.
This attribute is optional because it was added in a newer version
than its parent node.
:type description: :class:`com.vmware.vapi.std_client.LocalizableMessage`
:param description: Description of the operation associated with the task.
:type service: :class:`str`
:param service: Identifier of the service containing the operation.
When clients pass a value of this class as a parameter, the
attribute must be an identifier for the resource type:
``com.vmware.vapi.service``. When methods return a value of this
class as a return value, the attribute will be an identifier for
the resource type: ``com.vmware.vapi.service``.
:type operation: :class:`str`
:param operation: Identifier of the operation associated with the task.
When clients pass a value of this class as a parameter, the
attribute must be an identifier for the resource type:
``com.vmware.vapi.operation``. When methods return a value of this
class as a return value, the attribute will be an identifier for
the resource type: ``com.vmware.vapi.operation``.
:type parent: :class:`str` or ``None``
:param parent: Parent of the current task.
When clients pass a value of this class as a parameter, the
attribute must be an identifier for the resource type:
``com.vmware.cis.task``. When methods return a value of this class
as a return value, the attribute will be an identifier for the
resource type: ``com.vmware.cis.task``.
This attribute will be None if the task has no parent.
:type target: :class:`com.vmware.vapi.std_client.DynamicID` or ``None``
:param target: Identifier of the target created by the operation or an existing
one the operation performed on.
This attribute will be None if the operation has no target or
multiple targets.
:type status: :class:`com.vmware.cis.task_client.Status`
:param status: Status of the operation associated with the task.
:type cancelable: :class:`bool`
:param cancelable: Flag to indicate whether or not the operation can be cancelled. The
value may change as the operation progresses.
:type error: :class:`Exception` or ``None``
:param error: Description of the error if the operation status is "FAILED".
If None the description of why the operation failed will be
included in the result of the operation (see
:attr:`com.vmware.cis.task_client.Info.result`).
:type start_time: :class:`datetime.datetime`
:param start_time: Time when the operation is started.
This attribute is optional and it is only relevant when the value
of ``status`` is one of
:attr:`com.vmware.cis.task_client.Status.RUNNING`,
:attr:`com.vmware.cis.task_client.Status.BLOCKED`,
:attr:`com.vmware.cis.task_client.Status.SUCCEEDED`, or
:attr:`com.vmware.cis.task_client.Status.FAILED`.
:type end_time: :class:`datetime.datetime`
:param end_time: Time when the operation is completed.
This attribute is optional and it is only relevant when the value
of ``status`` is one of
:attr:`com.vmware.cis.task_client.Status.SUCCEEDED` or
:attr:`com.vmware.cis.task_client.Status.FAILED`.
:type user: :class:`str` or ``None``
:param user: Name of the user who performed the operation.
This attribute will be None if the operation is performed by the
system.
"""
self.location = location
self.duration = duration
self.size = size
self.progress = progress
self.location_user = location_user
self.type = type
self.messages = messages
self.build = build
self.description = description
self.service = service
self.operation = operation
self.parent = parent
self.target = target
self.status = status
self.cancelable = cancelable
self.error = error
self.start_time = start_time
self.end_time = end_time
self.user = user
VapiStruct.__init__(self)
Info._set_binding_type(
type.StructType(
'com.vmware.appliance.recovery.backup.job.details.info', {
'location':
type.URIType(),
'duration':
type.OptionalType(type.IntegerType()),
'size':
type.OptionalType(type.IntegerType()),
'progress':
type.OptionalType(
type.ReferenceType('com.vmware.cis.task_client',
'Progress')),
'location_user':
type.StringType(),
'type':
type.ReferenceType(__name__, 'Details.Type'),
'messages':
type.ListType(
type.ReferenceType('com.vmware.vapi.std_client',
'LocalizableMessage')),
'build':
type.OptionalType(
type.ReferenceType(__name__, 'Details.BuildInfo')),
'description':
type.ReferenceType('com.vmware.vapi.std_client',
'LocalizableMessage'),
'service':
type.IdType(resource_types='com.vmware.vapi.service'),
'operation':
type.IdType(resource_types='com.vmware.vapi.operation'),
'parent':
type.OptionalType(type.IdType()),
'target':
type.OptionalType(
type.ReferenceType('com.vmware.vapi.std_client',
'DynamicID')),
'status':
type.ReferenceType('com.vmware.cis.task_client', 'Status'),
'cancelable':
type.BooleanType(),
'error':
type.OptionalType(type.AnyErrorType()),
'start_time':
type.OptionalType(type.DateTimeType()),
'end_time':
type.OptionalType(type.DateTimeType()),
'user':
type.OptionalType(type.StringType()),
}, Info, False, None))
class FilterSpec(VapiStruct):
"""
The ``Details.FilterSpec`` class contains attributes used to filter the
results when listing backup jobs details (see :func:`Details.list`). This
class was added in vSphere API 6.7.
.. tip::
The arguments are used to initialize data attributes with the same
names.
"""
def __init__(
self,
jobs=None,
):
"""
:type jobs: :class:`set` of :class:`str` or ``None``
:param jobs: Identifiers of backup jobs that can match the filter. This
attribute was added in vSphere API 6.7.
When clients pass a value of this class as a parameter, the
attribute must contain identifiers for the resource type:
``com.vmware.appliance.recovery.backup.job``. When methods return a
value of this class as a return value, the attribute will contain
identifiers for the resource type:
``com.vmware.appliance.recovery.backup.job``.
If None the filter will match all the backup jobs.
"""
self.jobs = jobs
VapiStruct.__init__(self)
FilterSpec._set_binding_type(
type.StructType(
'com.vmware.appliance.recovery.backup.job.details.filter_spec', {
'jobs': type.OptionalType(type.SetType(type.IdType())),
}, FilterSpec, False, None))
class BuildInfo(VapiStruct):
"""
The ``Details.BuildInfo`` class contains information about the build of the
appliance. This class was added in vSphere API 6.7.2.
.. tip::
The arguments are used to initialize data attributes with the same
names.
"""
def __init__(
self,
version_name=None,
version=None,
build_number=None,
):
"""
:type version_name: :class:`str`
:param version_name: Appliance product type, for example 6.8.2 GA. This attribute was
added in vSphere API 6.7.2.
:type version: :class:`str`
:param version: Appliance version, for example 6.8.2.10000. This attribute was
added in vSphere API 6.7.2.
:type build_number: :class:`str`
:param build_number: Build Number of the appliance. This attribute was added in vSphere
API 6.7.2.
"""
self.version_name = version_name
self.version = version
self.build_number = build_number
VapiStruct.__init__(self)
BuildInfo._set_binding_type(
type.StructType(
'com.vmware.appliance.recovery.backup.job.details.build_info', {
'version_name': type.StringType(),
'version': type.StringType(),
'build_number': type.StringType(),
}, BuildInfo, False, None))
def list(
self,
filter=None,
):
"""
Returns detailed information about the current and historical backup
jobs. This method was added in vSphere API 6.7.
:type filter: :class:`Details.FilterSpec` or ``None``
:param filter: Specification of matching backup jobs for which information should
be returned.
If None, the behavior is equivalent to :class:`Details.FilterSpec`
with all attributes None which means all the backup jobs match the
filter.
:rtype: :class:`dict` of :class:`str` and :class:`Details.Info`
:return: Map of backup job identifier to Info Structure.
The key in the return value :class:`dict` will be an identifier for
the resource type: ``com.vmware.appliance.recovery.backup.job``.
:raise: :class:`com.vmware.vapi.std.errors_client.Error`
if any error occurs during the execution of the operation.
"""
return self._invoke('list', {
'filter': filter,
})
def __init__(self, config):
# properties for list operation
list_input_type = type.StructType(
'operation-input', {
'cursor':
type.OptionalType(type.StringType()),
'filter_text':
type.OptionalType(type.StringType()),
'include_mark_for_delete_objects':
type.OptionalType(type.BooleanType()),
'included_fields':
type.OptionalType(type.StringType()),
'page_size':
type.OptionalType(type.IntegerType()),
'scope':
type.OptionalType(type.StringType()),
'sort_ascending':
type.OptionalType(type.BooleanType()),
'sort_by':
type.OptionalType(type.StringType()),
'tag':
type.OptionalType(type.StringType()),
})
list_error_dict = {
'com.vmware.vapi.std.errors.service_unavailable':
type.ReferenceType('com.vmware.vapi.std.errors_client',
'ServiceUnavailable'),
'com.vmware.vapi.std.errors.invalid_request':
type.ReferenceType('com.vmware.vapi.std.errors_client',
'InvalidRequest'),
'com.vmware.vapi.std.errors.internal_server_error':
type.ReferenceType('com.vmware.vapi.std.errors_client',
'InternalServerError'),
'com.vmware.vapi.std.errors.unauthorized':
type.ReferenceType('com.vmware.vapi.std.errors_client',
'Unauthorized'),
'com.vmware.vapi.std.errors.not_found':
type.ReferenceType('com.vmware.vapi.std.errors_client',
'NotFound'),
}
list_input_value_validator_list = []
list_output_validator_list = []
list_rest_metadata = OperationRestMetadata(
http_method='GET',
url_template='/policy/api/v1/infra/tags/effective-resources',
path_variables={},
query_parameters={
'cursor': 'cursor',
'filter_text': 'filter_text',
'include_mark_for_delete_objects':
'include_mark_for_delete_objects',
'included_fields': 'included_fields',
'page_size': 'page_size',
'scope': 'scope',
'sort_ascending': 'sort_ascending',
'sort_by': 'sort_by',
'tag': 'tag',
},
content_type='application/json')
operations = {
'list': {
'input_type':
list_input_type,
'output_type':
type.ReferenceType('com.vmware.nsx_policy.model_client',
'PolicyResourceReferenceListResult'),
'errors':
list_error_dict,
'input_value_validator_list':
list_input_value_validator_list,
'output_validator_list':
list_output_validator_list,
'task_type':
TaskType.NONE,
},
}
rest_metadata = {
'list': list_rest_metadata,
}
ApiInterfaceStub.__init__(
self,
iface_name='com.vmware.nsx_policy.infra.tags.effective_resources',
config=config,
operations=operations,
rest_metadata=rest_metadata,
is_vapi_rest=False)
class File(VapiInterface):
"""
The ``File`` class provides methods for accessing files within an update
session.
After an update session is created against a library item, the ``File``
class can be used to make changes to the underlying library item metadata
as well as the content of the files. The following changes can be made:
* deleting an existing file within the library item. This deletes both the
metadata and the content.
* updating an existing file with new content.
* adding a new file to the library item.
The above changes are not applied or visible until the session is
completed. See
:class:`com.vmware.content.library.item_client.UpdateSession`.
"""
def __init__(self, config):
"""
:type config: :class:`vmware.vapi.bindings.stub.StubConfiguration`
:param config: Configuration to be used for creating the stub.
"""
VapiInterface.__init__(self, config, _FileStub)
class SourceType(Enum):
"""
The ``File.SourceType`` class defines how the file content is retrieved.
.. note::
This class represents an enumerated type in the interface language
definition. The class contains class attributes which represent the
values in the current version of the enumerated type. Newer versions of
the enumerated type may contain new values. To use new values of the
enumerated type in communication with a server that supports the newer
version of the API, you instantiate this class. See :ref:`enumerated
type description page <enumeration_description>`.
"""
NONE = None
"""
No source type has been requested.
"""
PUSH = None
"""
The client is uploading content using HTTP(S) PUT requests.
"""
PULL = None
"""
The server is pulling content from a URL. The URL scheme can be ``http``,
``https``, ``file``, or ``ds``.
"""
def __init__(self, string):
"""
:type string: :class:`str`
:param string: String value for the :class:`SourceType` instance.
"""
Enum.__init__(string)
SourceType._set_values([
SourceType('NONE'),
SourceType('PUSH'),
SourceType('PULL'),
])
SourceType._set_binding_type(
type.EnumType(
'com.vmware.content.library.item.updatesession.file.source_type',
SourceType))
class AddSpec(VapiStruct):
"""
The ``File.AddSpec`` class describes the properties of the file to be
uploaded.
.. tip::
The arguments are used to initialize data attributes with the same
names.
"""
_validator_list = [
UnionValidator('source_type', {
'PULL': [('source_endpoint', True)],
'NONE': [],
'PUSH': [],
}),
]
def __init__(
self,
name=None,
source_type=None,
source_endpoint=None,
size=None,
checksum_info=None,
):
"""
:type name: :class:`str`
:param name: The name of the file being uploaded.
:type source_type: :class:`File.SourceType`
:param source_type: The source type (NONE, PUSH, PULL) from which the file content will
be retrieved.
:type source_endpoint: :class:`com.vmware.content.library.item_client.TransferEndpoint`
:param source_endpoint: Location from which the Content Library Service will fetch the
file, rather than requiring a client to upload the file.
This attribute is optional and it is only relevant when the value
of ``sourceType`` is :attr:`File.SourceType.PULL`.
:type size: :class:`long` or ``None``
:param size: The file size, in bytes.
If specified the server will verify it received the correct size.
:type checksum_info: :class:`com.vmware.content.library.item_client.File.ChecksumInfo` or ``None``
:param checksum_info: The checksum of the file. If specified, the server will verify the
checksum once the file is received. If there is a mismatch, the
upload will fail.
If not specified the server does not verify the checksum.
"""
self.name = name
self.source_type = source_type
self.source_endpoint = source_endpoint
self.size = size
self.checksum_info = checksum_info
VapiStruct.__init__(self)
AddSpec._set_binding_type(
type.StructType(
'com.vmware.content.library.item.updatesession.file.add_spec', {
'name':
type.StringType(),
'source_type':
type.ReferenceType(__name__, 'File.SourceType'),
'source_endpoint':
type.OptionalType(
type.ReferenceType(
'com.vmware.content.library.item_client',
'TransferEndpoint')),
'size':
type.OptionalType(type.IntegerType()),
'checksum_info':
type.OptionalType(
type.ReferenceType(
'com.vmware.content.library.item_client',
'File.ChecksumInfo')),
}, AddSpec, False, None))
class Info(VapiStruct):
"""
The ``File.Info`` class defines the uploaded file.
.. tip::
The arguments are used to initialize data attributes with the same
names.
"""
_validator_list = [
UnionValidator(
'source_type', {
'PULL': [('source_endpoint', True)],
'PUSH': [('upload_endpoint', True)],
'NONE': [],
}),
]
def __init__(
self,
name=None,
source_type=None,
size=None,
checksum_info=None,
source_endpoint=None,
upload_endpoint=None,
bytes_transferred=None,
status=None,
error_message=None,
):
"""
:type name: :class:`str`
:param name: The name of the file.
:type source_type: :class:`File.SourceType`
:param source_type: The source type (NONE, PUSH, PULL) from which the file is being
retrieved. This may be :attr:`File.SourceType.NONE` if the file is
not being changed.
:type size: :class:`long` or ``None``
:param size: The file size, in bytes as received by the server. This attribute
is guaranteed to be set when the server has completely received the
file.
This attribute won't be set until the file status is
:attr:`com.vmware.content.library.item_client.TransferStatus.READY`.
:type checksum_info: :class:`com.vmware.content.library.item_client.File.ChecksumInfo` or ``None``
:param checksum_info: The checksum information of the file received by the server.
If not specified the server does not verify the checksum.
:type source_endpoint: :class:`com.vmware.content.library.item_client.TransferEndpoint`
:param source_endpoint: A source endpoint from which to retrieve the file.
This attribute is optional and it is only relevant when the value
of ``sourceType`` is :attr:`File.SourceType.PULL`.
:type upload_endpoint: :class:`com.vmware.content.library.item_client.TransferEndpoint`
:param upload_endpoint: An upload endpoint to which the client can push the content.
This attribute is optional and it is only relevant when the value
of ``sourceType`` is :attr:`File.SourceType.PUSH`.
:type bytes_transferred: :class:`long`
:param bytes_transferred: The number of bytes of this file that have been received by the
server.
:type status: :class:`com.vmware.content.library.item_client.TransferStatus`
:param status: The transfer status (WAITING_FOR_TRANSFER, TRANSFERRING, READY,
VALIDATING, ERROR) of this file.
:type error_message: :class:`com.vmware.vapi.std_client.LocalizableMessage` or ``None``
:param error_message: Details about the transfer error.
An error message is set if the status is
:attr:`com.vmware.content.library.item_client.TransferStatus.ERROR`.
"""
self.name = name
self.source_type = source_type
self.size = size
self.checksum_info = checksum_info
self.source_endpoint = source_endpoint
self.upload_endpoint = upload_endpoint
self.bytes_transferred = bytes_transferred
self.status = status
self.error_message = error_message
VapiStruct.__init__(self)
Info._set_binding_type(
type.StructType(
'com.vmware.content.library.item.updatesession.file.info', {
'name':
type.StringType(),
'source_type':
type.ReferenceType(__name__, 'File.SourceType'),
'size':
type.OptionalType(type.IntegerType()),
'checksum_info':
type.OptionalType(
type.ReferenceType(
'com.vmware.content.library.item_client',
'File.ChecksumInfo')),
'source_endpoint':
type.OptionalType(
type.ReferenceType(
'com.vmware.content.library.item_client',
'TransferEndpoint')),
'upload_endpoint':
type.OptionalType(
type.ReferenceType(
'com.vmware.content.library.item_client',
'TransferEndpoint')),
'bytes_transferred':
type.IntegerType(),
'status':
type.ReferenceType('com.vmware.content.library.item_client',
'TransferStatus'),
'error_message':
type.OptionalType(
type.ReferenceType('com.vmware.vapi.std_client',
'LocalizableMessage')),
}, Info, False, None))
class ValidationError(VapiStruct):
"""
The ``File.ValidationError`` class defines the validation error of a file
in the session.
.. tip::
The arguments are used to initialize data attributes with the same
names.
"""
def __init__(
self,
name=None,
error_message=None,
):
"""
:type name: :class:`str`
:param name: The name of the file.
:type error_message: :class:`com.vmware.vapi.std_client.LocalizableMessage`
:param error_message: A message indicating why the file was considered invalid.
"""
self.name = name
self.error_message = error_message
VapiStruct.__init__(self)
ValidationError._set_binding_type(
type.StructType(
'com.vmware.content.library.item.updatesession.file.validation_error',
{
'name':
type.StringType(),
'error_message':
type.ReferenceType('com.vmware.vapi.std_client',
'LocalizableMessage'),
}, ValidationError, False, None))
class ValidationResult(VapiStruct):
"""
The ``File.ValidationResult`` class defines the result of validating the
files in the session.
.. tip::
The arguments are used to initialize data attributes with the same
names.
"""
def __init__(
self,
has_errors=None,
missing_files=None,
invalid_files=None,
):
"""
:type has_errors: :class:`bool`
:param has_errors: Whether the validation was succesful or not. In case of errors, the
:attr:`File.ValidationResult.missing_files` and
:attr:`File.ValidationResult.invalid_files` will contain at least
one entry.
:type missing_files: :class:`set` of :class:`str`
:param missing_files: A :class:`set` containing the names of the files that are required
but the client hasn't added.
:type invalid_files: :class:`list` of :class:`File.ValidationError`
:param invalid_files: A :class:`list` containing the files that have been identified as
invalid and details about the error.
"""
self.has_errors = has_errors
self.missing_files = missing_files
self.invalid_files = invalid_files
VapiStruct.__init__(self)
ValidationResult._set_binding_type(
type.StructType(
'com.vmware.content.library.item.updatesession.file.validation_result',
{
'has_errors':
type.BooleanType(),
'missing_files':
type.SetType(type.StringType()),
'invalid_files':
type.ListType(
type.ReferenceType(__name__, 'File.ValidationError')),
}, ValidationResult, False, None))
def validate(
self,
update_session_id,
):
"""
Validates the files in the update session with the referenced
identifier and ensures all necessary files are received. In the case
where a file is missing, this method will return its name in the
:attr:`File.ValidationResult.missing_files` set. The user can add the
missing files and try re-validating. For other type of errors,
:attr:`File.ValidationResult.invalid_files` will contain the list of
invalid files.
:type update_session_id: :class:`str`
:param update_session_id: Identifier of the update session to validate.
The parameter must be an identifier for the resource type:
``com.vmware.content.library.item.UpdateSession``.
:rtype: :class:`File.ValidationResult`
:return: A validation result containing missing files or invalid files and
the reason why they are invalid.
:raise: :class:`com.vmware.vapi.std.errors_client.NotFound`
if no update session with the given identifier exists.
:raise: :class:`com.vmware.vapi.std.errors_client.NotAllowedInCurrentState`
if the update session is not in the
:attr:`com.vmware.content.library.item_client.UpdateSessionModel.State.ACTIVE`
state, or if some of the files that will be uploaded by the client
aren't received correctly.
"""
return self._invoke('validate', {
'update_session_id': update_session_id,
})
def add(
self,
update_session_id,
file_spec,
):
"""
Requests file content to be changed (either created, or updated).
Depending on the source type of the file, this method will either
return an upload endpoint where the client can push the content, or the
server will pull from the provided source endpoint. If a file with the
same name already exists in this session, this method will be used to
update the content of the existing file.
When importing a file directly from storage, where the source endpoint
is a file or datastore URI, you will need to have the
ContentLibrary.ReadStorage privilege on the library item. If the file
is located in the same directory as the library storage backing folder,
the server will move the file instead of copying it, thereby allowing
instantaneous import of files for efficient backup and restore
scenarios. In all other cases, a copy is performed rather than a move.
:type update_session_id: :class:`str`
:param update_session_id: Identifier of the update session to be modified.
The parameter must be an identifier for the resource type:
``com.vmware.content.library.item.UpdateSession``.
:type file_spec: :class:`File.AddSpec`
:param file_spec: Specification for the file that needs to be added or updated. This
includes whether the client wants to push the content or have the
server pull it.
:rtype: :class:`File.Info`
:return: An :class:`File.Info` class containing upload links as well as
server side state tracking the transfer of the file.
:raise: :class:`com.vmware.vapi.std.errors_client.InvalidArgument`
if the ``file_spec`` is invalid.
:raise: :class:`com.vmware.vapi.std.errors_client.NotFound`
if the update session doesn't exist.
:raise: :class:`com.vmware.vapi.std.errors_client.Unauthorized`
if the caller doesn't have ContentLibrary.ReadStorage privilege on
the library item of the update session and source type
:attr:`File.SourceType.PULL` is requested for a file or datastore
source endpoint (that is, not HTTP or HTTPs based endpoint).
:raise: :class:`com.vmware.vapi.std.errors_client.NotAllowedInCurrentState`
if the content of the library item associated with the update
session has been deleted from the storage backings (see null)
associated with it.
"""
return self._invoke('add', {
'update_session_id': update_session_id,
'file_spec': file_spec,
})
def remove(
self,
update_session_id,
file_name,
):
"""
Requests a file to be removed. The file will only be effectively
removed when the update session is completed.
:type update_session_id: :class:`str`
:param update_session_id: Identifier of the update session.
The parameter must be an identifier for the resource type:
``com.vmware.content.library.item.UpdateSession``.
:type file_name: :class:`str`
:param file_name: Name of the file to be removed.
:raise: :class:`com.vmware.vapi.std.errors_client.NotFound`
if the update session doesn't exist.
:raise: :class:`com.vmware.vapi.std.errors_client.InvalidArgument`
if the file doesn't exist in the library item associated with the
update session.
"""
return self._invoke('remove', {
'update_session_id': update_session_id,
'file_name': file_name,
})
def list(
self,
update_session_id,
):
"""
Lists all files in the library item associated with the update session.
:type update_session_id: :class:`str`
:param update_session_id: Identifier of the update session.
The parameter must be an identifier for the resource type:
``com.vmware.content.library.item.UpdateSession``.
:rtype: :class:`list` of :class:`File.Info`
:return: The :class:`list` of the files in the library item associated with
the update session. This :class:`list` may be empty if the caller
has removed all the files as part of this session (in which case
completing the update session will result in an empty library
item).
:raise: :class:`com.vmware.vapi.std.errors_client.NotFound`
if the update session doesn't exist.
:raise: :class:`com.vmware.vapi.std.errors_client.Unauthorized`
if you do not have all of the privileges described as follows:
* The resource ``com.vmware.content.library.Item`` referenced by
the parameter ``libraryItemId`` requires ``System.Read``.
"""
return self._invoke('list', {
'update_session_id': update_session_id,
})
def get(
self,
update_session_id,
file_name,
):
"""
Retrieves information about a specific file in the snapshot of the
library item at the time when the update session was created.
:type update_session_id: :class:`str`
:param update_session_id: Identifier of the update session.
The parameter must be an identifier for the resource type:
``com.vmware.content.library.item.UpdateSession``.
:type file_name: :class:`str`
:param file_name: Name of the file.
:rtype: :class:`File.Info`
:return: Information about the file.
:raise: :class:`com.vmware.vapi.std.errors_client.NotFound`
if the update session doesn't exist.
:raise: :class:`com.vmware.vapi.std.errors_client.InvalidArgument`
if the file doesn't exist in the library item associated with the
update session.
:raise: :class:`com.vmware.vapi.std.errors_client.Unauthorized`
if you do not have all of the privileges described as follows:
* The resource ``com.vmware.content.library.Item`` referenced by
the parameter ``libraryItemId`` requires ``System.Read``.
"""
return self._invoke('get', {
'update_session_id': update_session_id,
'file_name': file_name,
})
def __init__(self, config):
# properties for get operation
get_input_type = type.StructType(
'operation-input', {
'site_id': type.StringType(),
'enforcementpoint_id': type.StringType(),
'transport_zone_id': type.StringType(),
})
get_error_dict = {
'com.vmware.vapi.std.errors.service_unavailable':
type.ReferenceType('com.vmware.vapi.std.errors_client',
'ServiceUnavailable'),
'com.vmware.vapi.std.errors.invalid_request':
type.ReferenceType('com.vmware.vapi.std.errors_client',
'InvalidRequest'),
'com.vmware.vapi.std.errors.internal_server_error':
type.ReferenceType('com.vmware.vapi.std.errors_client',
'InternalServerError'),
'com.vmware.vapi.std.errors.unauthorized':
type.ReferenceType('com.vmware.vapi.std.errors_client',
'Unauthorized'),
'com.vmware.vapi.std.errors.not_found':
type.ReferenceType('com.vmware.vapi.std.errors_client',
'NotFound'),
}
get_input_value_validator_list = []
get_output_validator_list = [HasFieldsOfValidator()]
get_rest_metadata = OperationRestMetadata(
http_method='GET',
url_template=
'/policy/api/v1/infra/sites/{site-id}/enforcement-points/{enforcementpoint-id}/transport-zones/{transport-zone-id}',
path_variables={
'site_id': 'site-id',
'enforcementpoint_id': 'enforcementpoint-id',
'transport_zone_id': 'transport-zone-id',
},
query_parameters={},
content_type='application/json')
# properties for list operation
list_input_type = type.StructType(
'operation-input', {
'site_id':
type.StringType(),
'enforcementpoint_id':
type.StringType(),
'cursor':
type.OptionalType(type.StringType()),
'include_mark_for_delete_objects':
type.OptionalType(type.BooleanType()),
'included_fields':
type.OptionalType(type.StringType()),
'page_size':
type.OptionalType(type.IntegerType()),
'sort_ascending':
type.OptionalType(type.BooleanType()),
'sort_by':
type.OptionalType(type.StringType()),
})
list_error_dict = {
'com.vmware.vapi.std.errors.service_unavailable':
type.ReferenceType('com.vmware.vapi.std.errors_client',
'ServiceUnavailable'),
'com.vmware.vapi.std.errors.invalid_request':
type.ReferenceType('com.vmware.vapi.std.errors_client',
'InvalidRequest'),
'com.vmware.vapi.std.errors.internal_server_error':
type.ReferenceType('com.vmware.vapi.std.errors_client',
'InternalServerError'),
'com.vmware.vapi.std.errors.unauthorized':
type.ReferenceType('com.vmware.vapi.std.errors_client',
'Unauthorized'),
'com.vmware.vapi.std.errors.not_found':
type.ReferenceType('com.vmware.vapi.std.errors_client',
'NotFound'),
}
list_input_value_validator_list = []
list_output_validator_list = [HasFieldsOfValidator()]
list_rest_metadata = OperationRestMetadata(
http_method='GET',
url_template=
'/policy/api/v1/infra/sites/{site-id}/enforcement-points/{enforcementpoint-id}/transport-zones',
path_variables={
'site_id': 'site-id',
'enforcementpoint_id': 'enforcementpoint-id',
},
query_parameters={
'cursor': 'cursor',
'include_mark_for_delete_objects':
'include_mark_for_delete_objects',
'included_fields': 'included_fields',
'page_size': 'page_size',
'sort_ascending': 'sort_ascending',
'sort_by': 'sort_by',
},
content_type='application/json')
operations = {
'get': {
'input_type':
get_input_type,
'output_type':
type.ReferenceType('com.vmware.nsx_policy.model_client',
'PolicyTransportZone'),
'errors':
get_error_dict,
'input_value_validator_list':
get_input_value_validator_list,
'output_validator_list':
get_output_validator_list,
'task_type':
TaskType.NONE,
},
'list': {
'input_type':
list_input_type,
'output_type':
type.ReferenceType('com.vmware.nsx_policy.model_client',
'PolicyTransportZoneListResult'),
'errors':
list_error_dict,
'input_value_validator_list':
list_input_value_validator_list,
'output_validator_list':
list_output_validator_list,
'task_type':
TaskType.NONE,
},
}
rest_metadata = {
'get': get_rest_metadata,
'list': list_rest_metadata,
}
ApiInterfaceStub.__init__(
self,
iface_name=
'com.vmware.nsx_policy.infra.sites.enforcement_points.transport_zones',
config=config,
operations=operations,
rest_metadata=rest_metadata,
is_vapi_rest=False)
class Effective(VapiInterface):
"""
The ``Effective`` class provides methods to manage the effective policies
that will impact how the software and configuration specification documents
are applied to ESXi clusters.
"""
_VAPI_SERVICE_ID = 'com.vmware.esx.settings.defaults.clusters.policies.apply.effective'
"""
Identifier of the service in canonical form.
"""
def __init__(self, config):
"""
:type config: :class:`vmware.vapi.bindings.stub.StubConfiguration`
:param config: Configuration to be used for creating the stub.
"""
VapiInterface.__init__(self, config, _EffectiveStub)
self._VAPI_OPERATION_IDS = {}
class FailureAction(VapiStruct):
"""
The ``Effective.FailureAction`` class contains attributes that describe the
actions to be taken when entering maintenance mode fails on a single host
within the cluster.
.. tip::
The arguments are used to initialize data attributes with the same
names.
"""
_validator_list = [
UnionValidator(
'action', {
'RETRY': [('retry_delay', True), ('retry_count', True)],
'FAIL': [],
}),
]
def __init__(
self,
action=None,
retry_delay=None,
retry_count=None,
):
"""
:type action: :class:`Effective.FailureAction.Action`
:param action: What action (FAIL, RETRY) is to be taken if entering maintenance
mode fails on a single host within the cluster.
:type retry_delay: :class:`long`
:param retry_delay: Time to wait to retry the failed operation in seconds.
This attribute is optional and it is only relevant when the value
of ``action`` is :attr:`Effective.FailureAction.Action.RETRY`.
:type retry_count: :class:`long`
:param retry_count: Number of times to retry the failed operation.
This attribute is optional and it is only relevant when the value
of ``action`` is :attr:`Effective.FailureAction.Action.RETRY`.
"""
self.action = action
self.retry_delay = retry_delay
self.retry_count = retry_count
VapiStruct.__init__(self)
class Action(Enum):
"""
The ``Effective.FailureAction.Action`` class defines the actions to be
taken when entering maintenance mode fails on a single host within the
cluster.
.. note::
This class represents an enumerated type in the interface language
definition. The class contains class attributes which represent the
values in the current version of the enumerated type. Newer versions of
the enumerated type may contain new values. To use new values of the
enumerated type in communication with a server that supports the newer
version of the API, you instantiate this class. See :ref:`enumerated
type description page <enumeration_description>`.
"""
FAIL = None
"""
Fail the apply method
"""
RETRY = None
"""
Retry the task Apply.FailureAction#retryCount number of times on the failed
host after Apply.FailureAction#retryDelay.
"""
def __init__(self, string):
"""
:type string: :class:`str`
:param string: String value for the :class:`Action` instance.
"""
Enum.__init__(string)
Action._set_values([
Action('FAIL'),
Action('RETRY'),
])
Action._set_binding_type(
type.EnumType(
'com.vmware.esx.settings.defaults.clusters.policies.apply.effective.failure_action.action',
Action))
FailureAction._set_binding_type(
type.StructType(
'com.vmware.esx.settings.defaults.clusters.policies.apply.effective.failure_action',
{
'action':
type.ReferenceType(__name__, 'Effective.FailureAction.Action'),
'retry_delay':
type.OptionalType(type.IntegerType()),
'retry_count':
type.OptionalType(type.IntegerType()),
}, FailureAction, False, None))
class EffectivePolicySpec(VapiStruct):
"""
The ``Effective.EffectivePolicySpec`` class contains attributes that
describe the effective policies to be used when the software and
configuration specification documents are applied to ESXi clusters.
.. tip::
The arguments are used to initialize data attributes with the same
names.
"""
def __init__(
self,
failure_action=None,
pre_remediation_power_action=None,
enable_quick_boot=None,
disable_dpm=None,
disable_hac=None,
evacuate_offline_vms=None,
enforce_hcl_validation=None,
):
"""
:type failure_action: :class:`Effective.FailureAction`
:param failure_action: What action is to be taken if entering maintenance mode fails on a
given host of the cluster.
:type pre_remediation_power_action: :class:`Effective.EffectivePolicySpec.PreRemediationPowerAction`
:param pre_remediation_power_action: Specifies what should be done to the power state of the VM before
entering maintenance mode.
:type enable_quick_boot: :class:`bool`
:param enable_quick_boot: Enable Quick Boot during remediation in the cluster.
:type disable_dpm: :class:`bool`
:param disable_dpm: Disable DPM on the cluster.
:type disable_hac: :class:`bool`
:param disable_hac: Disable HA Admission control on the cluster.
:type evacuate_offline_vms: :class:`bool`
:param evacuate_offline_vms: Evacuate powered off/suspended VMs when attempting maintenance
mode.
:type enforce_hcl_validation: :class:`bool`
:param enforce_hcl_validation: Enforce Hcl validation, when applicable, to prevent remediation if
hardware compatibility issues are found. This attribute was added
in vSphere API 7.0.1.0.
This attribute is optional because it was added in a newer version
than its parent node.
"""
self.failure_action = failure_action
self.pre_remediation_power_action = pre_remediation_power_action
self.enable_quick_boot = enable_quick_boot
self.disable_dpm = disable_dpm
self.disable_hac = disable_hac
self.evacuate_offline_vms = evacuate_offline_vms
self.enforce_hcl_validation = enforce_hcl_validation
VapiStruct.__init__(self)
class PreRemediationPowerAction(Enum):
"""
The ``Effective.EffectivePolicySpec.PreRemediationPowerAction`` class
defines the possible actions to be taken, before entering maintenance mode.
.. note::
This class represents an enumerated type in the interface language
definition. The class contains class attributes which represent the
values in the current version of the enumerated type. Newer versions of
the enumerated type may contain new values. To use new values of the
enumerated type in communication with a server that supports the newer
version of the API, you instantiate this class. See :ref:`enumerated
type description page <enumeration_description>`.
"""
POWER_OFF_VMS = None
"""
Power off VMs before entering maintenance mode.
"""
SUSPEND_VMS = None
"""
Suspend VMs before entering maintenance mode
"""
DO_NOT_CHANGE_VMS_POWER_STATE = None
"""
Do not change the VM power state
"""
SUSPEND_VMS_TO_MEMORY = None
"""
Suspend VMs to Memory before entering maintenance mode. This class
attribute was added in vSphere API 7.0.2.0.
"""
def __init__(self, string):
"""
:type string: :class:`str`
:param string: String value for the :class:`PreRemediationPowerAction` instance.
"""
Enum.__init__(string)
PreRemediationPowerAction._set_values([
PreRemediationPowerAction('POWER_OFF_VMS'),
PreRemediationPowerAction('SUSPEND_VMS'),
PreRemediationPowerAction('DO_NOT_CHANGE_VMS_POWER_STATE'),
PreRemediationPowerAction('SUSPEND_VMS_TO_MEMORY'),
])
PreRemediationPowerAction._set_binding_type(
type.EnumType(
'com.vmware.esx.settings.defaults.clusters.policies.apply.effective.effective_policy_spec.pre_remediation_power_action',
PreRemediationPowerAction))
EffectivePolicySpec._set_binding_type(
type.StructType(
'com.vmware.esx.settings.defaults.clusters.policies.apply.effective.effective_policy_spec',
{
'failure_action':
type.ReferenceType(__name__, 'Effective.FailureAction'),
'pre_remediation_power_action':
type.ReferenceType(
__name__,
'Effective.EffectivePolicySpec.PreRemediationPowerAction'),
'enable_quick_boot':
type.BooleanType(),
'disable_dpm':
type.BooleanType(),
'disable_hac':
type.BooleanType(),
'evacuate_offline_vms':
type.BooleanType(),
'enforce_hcl_validation':
type.OptionalType(type.BooleanType()),
}, EffectivePolicySpec, False, None))
def get(self):
"""
Returns the effective apply policy based on system defaults and what
has been configured.
:rtype: :class:`Effective.EffectivePolicySpec`
:return: The effective policies that impact the apply method
:raise: :class:`com.vmware.vapi.std.errors_client.Error`
If there is an unknown internal error. The accompanying error
message will give more details about the failure.
:raise: :class:`com.vmware.vapi.std.errors_client.ServiceUnavailable`
If the service is not available.
:raise: :class:`com.vmware.vapi.std.errors_client.Unauthenticated`
if the caller is not authenticated.
:raise: :class:`com.vmware.vapi.std.errors_client.Unauthorized`
if you do not have all of the privileges described as follows:
* Method execution requires ``VcIntegrity.lifecycleSettings.Read``.
"""
return self._invoke('get', None)
def __init__(self, config):
# properties for delete operation
delete_input_type = type.StructType('operation-input', {
'org': type.StringType(),
'sddc': type.StringType(),
'edge_id': type.StringType(),
})
delete_error_dict = {
'com.vmware.vapi.std.errors.invalid_request':
type.ReferenceType('com.vmware.vapi.std.errors_client', 'InvalidRequest'),
'com.vmware.vapi.std.errors.unauthorized':
type.ReferenceType('com.vmware.vapi.std.errors_client', 'Unauthorized'),
'com.vmware.vapi.std.errors.not_found':
type.ReferenceType('com.vmware.vapi.std.errors_client', 'NotFound'),
}
delete_input_value_validator_list = [
]
delete_output_validator_list = [
]
delete_rest_metadata = OperationRestMetadata(
http_method='DELETE',
url_template='/vmc/api/orgs/{org}/sddcs/{sddc}/networks/4.0/sddc/cgws/{edgeId}/l2vpn/config',
path_variables={
'org': 'org',
'sddc': 'sddc',
'edge_id': 'edgeId',
},
query_parameters={
},
content_type='application/json'
)
# properties for get operation
get_input_type = type.StructType('operation-input', {
'org': type.StringType(),
'sddc': type.StringType(),
'edge_id': type.StringType(),
'show_sensitive_data': type.OptionalType(type.BooleanType()),
})
get_error_dict = {
'com.vmware.vapi.std.errors.invalid_request':
type.ReferenceType('com.vmware.vapi.std.errors_client', 'InvalidRequest'),
'com.vmware.vapi.std.errors.unauthorized':
type.ReferenceType('com.vmware.vapi.std.errors_client', 'Unauthorized'),
'com.vmware.vapi.std.errors.not_found':
type.ReferenceType('com.vmware.vapi.std.errors_client', 'NotFound'),
}
get_input_value_validator_list = [
]
get_output_validator_list = [
]
get_rest_metadata = OperationRestMetadata(
http_method='GET',
url_template='/vmc/api/orgs/{org}/sddcs/{sddc}/networks/4.0/sddc/cgws/{edgeId}/l2vpn/config',
path_variables={
'org': 'org',
'sddc': 'sddc',
'edge_id': 'edgeId',
},
query_parameters={
'show_sensitive_data': 'showSensitiveData',
},
content_type='application/json'
)
# properties for update operation
update_input_type = type.StructType('operation-input', {
'org': type.StringType(),
'sddc': type.StringType(),
'edge_id': type.StringType(),
'nsxl2vpn': type.ReferenceType('com.vmware.vmc.model_client', 'Nsxl2vpn'),
})
update_error_dict = {
'com.vmware.vapi.std.errors.invalid_request':
type.ReferenceType('com.vmware.vapi.std.errors_client', 'InvalidRequest'),
'com.vmware.vapi.std.errors.unauthorized':
type.ReferenceType('com.vmware.vapi.std.errors_client', 'Unauthorized'),
'com.vmware.vapi.std.errors.not_found':
type.ReferenceType('com.vmware.vapi.std.errors_client', 'NotFound'),
}
update_input_value_validator_list = [
]
update_output_validator_list = [
]
update_rest_metadata = OperationRestMetadata(
http_method='PUT',
url_template='/vmc/api/orgs/{org}/sddcs/{sddc}/networks/4.0/sddc/cgws/{edgeId}/l2vpn/config',
request_body_parameter='nsxl2vpn',
path_variables={
'org': 'org',
'sddc': 'sddc',
'edge_id': 'edgeId',
},
query_parameters={
},
content_type='application/json'
)
operations = {
'delete': {
'input_type': delete_input_type,
'output_type': type.VoidType(),
'errors': delete_error_dict,
'input_value_validator_list': delete_input_value_validator_list,
'output_validator_list': delete_output_validator_list,
'task_type': TaskType.NONE,
},
'get': {
'input_type': get_input_type,
'output_type': type.ReferenceType('com.vmware.vmc.model_client', 'Nsxl2vpn'),
'errors': get_error_dict,
'input_value_validator_list': get_input_value_validator_list,
'output_validator_list': get_output_validator_list,
'task_type': TaskType.NONE,
},
'update': {
'input_type': update_input_type,
'output_type': type.VoidType(),
'errors': update_error_dict,
'input_value_validator_list': update_input_value_validator_list,
'output_validator_list': update_output_validator_list,
'task_type': TaskType.NONE,
},
}
rest_metadata = {
'delete': delete_rest_metadata,
'get': get_rest_metadata,
'update': update_rest_metadata,
}
ApiInterfaceStub.__init__(
self, iface_name='com.vmware.vmc.orgs.sddcs.networks.cgws.l2vpn.config',
config=config, operations=operations, rest_metadata=rest_metadata,
is_vapi_rest=False)
It is optional to specify if a floppy is connected.
:type type: :class:`str` or ``None``
:param type: Floppy type
It is optional to specify the type of floppy drive.
"""
self.name = name
self.connected = connected
self.type = type
VapiStruct.__init__(self)
Floppy._set_binding_type(
type.StructType(
'com.vmware.content.type.ovf.floppy', {
'name': type.StringType(),
'connected': type.OptionalType(type.BooleanType()),
'type': type.OptionalType(type.StringType()),
}, Floppy, False, None))
class Memory(VapiStruct):
"""
Provide the memory information in a template VM.
.. tip::
The arguments are used to initialize data attributes with the same
names.
"""
def __init__(
self,
size=None,
class Compliance(VapiInterface):
"""
The Compliance class provides methods that return the compliance status of
virtual machine entities(virtual machine home directory and virtual disks)
that specify storage policy requirements. This class was added in vSphere
API 6.7.
"""
_VAPI_SERVICE_ID = 'com.vmware.vcenter.vm.storage.policy.compliance'
"""
Identifier of the service in canonical form.
"""
def __init__(self, config):
"""
:type config: :class:`vmware.vapi.bindings.stub.StubConfiguration`
:param config: Configuration to be used for creating the stub.
"""
VapiInterface.__init__(self, config, _ComplianceStub)
class Status(Enum):
"""
The ``Compliance.Status`` class defines the storage compliance status of a
virtual machine and its applicable entities. This enumeration was added in
vSphere API 6.7.
.. note::
This class represents an enumerated type in the interface language
definition. The class contains class attributes which represent the
values in the current version of the enumerated type. Newer versions of
the enumerated type may contain new values. To use new values of the
enumerated type in communication with a server that supports the newer
version of the API, you instantiate this class. See :ref:`enumerated
type description page <enumeration_description>`.
"""
COMPLIANT = None
"""
Entity is in compliance. This class attribute was added in vSphere API 6.7.
"""
NON_COMPLIANT = None
"""
Entity is out of compliance. This class attribute was added in vSphere API
6.7.
"""
UNKNOWN_COMPLIANCE = None
"""
Compliance status of the entity is not known. This class attribute was
added in vSphere API 6.7.
"""
NOT_APPLICABLE = None
"""
Compliance computation is not applicable for this entity because it does
not have any storage requirements that apply to the datastore on which it
is placed. This class attribute was added in vSphere API 6.7.
"""
OUT_OF_DATE = None
"""
The Compliance status becomes out-of-date when the profile associated with
the entity is edited but not applied. The compliance status remains
out-of-date until the edited policy is applied to the entity. This class
attribute was added in vSphere API 6.7.
"""
def __init__(self, string):
"""
:type string: :class:`str`
:param string: String value for the :class:`Status` instance.
"""
Enum.__init__(string)
Status._set_values([
Status('COMPLIANT'),
Status('NON_COMPLIANT'),
Status('UNKNOWN_COMPLIANCE'),
Status('NOT_APPLICABLE'),
Status('OUT_OF_DATE'),
])
Status._set_binding_type(
type.EnumType('com.vmware.vcenter.vm.storage.policy.compliance.status',
Status))
class VmComplianceInfo(VapiStruct):
"""
The ``Compliance.VmComplianceInfo`` class contains information about
storage policy compliance associated with a virtual machine. This class was
added in vSphere API 6.7.
.. tip::
The arguments are used to initialize data attributes with the same
names.
"""
def __init__(
self,
status=None,
check_time=None,
policy=None,
failure_cause=None,
):
"""
:type status: :class:`Compliance.Status`
:param status: Status of the compliance operation. This attribute was added in
vSphere API 6.7.
:type check_time: :class:`datetime.datetime`
:param check_time: Date and time of the most recent compliance check. This attribute
was added in vSphere API 6.7.
:type policy: :class:`str` or ``None``
:param policy: Identifier of the storage policy associated with the virtual
machine. This attribute was added in vSphere API 6.7.
When clients pass a value of this class as a parameter, the
attribute must be an identifier for the resource type:
``com.vmware.vcenter.StoragePolicy``. When methods return a value
of this class as a return value, the attribute will be an
identifier for the resource type:
``com.vmware.vcenter.StoragePolicy``.
If None SPBM is unable to retrieve or determine the associated
policy, :attr:`Compliance.VmComplianceInfo.failure_cause` is set in
such casses.
:type failure_cause: :class:`list` of :class:`com.vmware.vapi.std_client.LocalizableMessage`
:param failure_cause: The exception that caused the compliance check to fail. There can
be more than one cause, since a policy can contain capabilities
from multiple providers. If empty, it implies no failures while
retrieving compliance. This attribute was added in vSphere API 6.7.
"""
self.status = status
self.check_time = check_time
self.policy = policy
self.failure_cause = failure_cause
VapiStruct.__init__(self)
VmComplianceInfo._set_binding_type(
type.StructType(
'com.vmware.vcenter.vm.storage.policy.compliance.vm_compliance_info',
{
'status':
type.ReferenceType(__name__, 'Compliance.Status'),
'check_time':
type.DateTimeType(),
'policy':
type.OptionalType(type.IdType()),
'failure_cause':
type.ListType(
type.ReferenceType('com.vmware.vapi.std_client',
'LocalizableMessage')),
}, VmComplianceInfo, False, None))
class Info(VapiStruct):
"""
The ``Compliance.Info`` class contains information about the storage policy
compliance of a virtual machine, including information about it's home
directory and/or it's virtual disks. This class was added in vSphere API
6.7.
.. tip::
The arguments are used to initialize data attributes with the same
names.
"""
def __init__(
self,
overall_compliance=None,
vm_home=None,
disks=None,
):
"""
:type overall_compliance: :class:`Compliance.Status`
:param overall_compliance: The overall compliance status of the virtual machine and all it's
entities. This attribute was added in vSphere API 6.7.
:type vm_home: :class:`Compliance.VmComplianceInfo` or ``None``
:param vm_home: The storage policy compliance information
:class:`Compliance.VmComplianceInfo` for the virtual machine's home
directory. This attribute was added in vSphere API 6.7.
If None the virtual machine home directory has no storage policy
association.
:type disks: :class:`dict` of :class:`str` and :class:`Compliance.VmComplianceInfo`
:param disks: The compliance information :class:`Compliance.VmComplianceInfo` for
the virtual machine's virtual disks that are currently associated
with a storage policy. This attribute was added in vSphere API 6.7.
When clients pass a value of this class as a parameter, the key in
the attribute :class:`dict` must be an identifier for the resource
type: ``com.vmware.vcenter.vm.hardware.Disk``. When methods return
a value of this class as a return value, the key in the attribute
:class:`dict` will be an identifier for the resource type:
``com.vmware.vcenter.vm.hardware.Disk``.
"""
self.overall_compliance = overall_compliance
self.vm_home = vm_home
self.disks = disks
VapiStruct.__init__(self)
Info._set_binding_type(
type.StructType(
'com.vmware.vcenter.vm.storage.policy.compliance.info', {
'overall_compliance':
type.ReferenceType(__name__, 'Compliance.Status'),
'vm_home':
type.OptionalType(
type.ReferenceType(__name__,
'Compliance.VmComplianceInfo')),
'disks':
type.MapType(
type.IdType(),
type.ReferenceType(__name__,
'Compliance.VmComplianceInfo')),
}, Info, False, None))
class CheckSpec(VapiStruct):
"""
The ``Compliance.CheckSpec`` class contains attributes used to specify the
entities on which the storage policy compliance check is to be invoked.
This class was added in vSphere API 6.7.
.. tip::
The arguments are used to initialize data attributes with the same
names.
"""
def __init__(
self,
vm_home=None,
disks=None,
):
"""
:type vm_home: :class:`bool`
:param vm_home: Invoke compliance check on the virtual machine home directory if
set to true. This attribute was added in vSphere API 6.7.
:type disks: :class:`set` of :class:`str` or ``None``
:param disks: Identifiers of the virtual machine's virtual disks for which
compliance should be checked. This attribute was added in vSphere
API 6.7.
When clients pass a value of this class as a parameter, the
attribute must contain identifiers for the resource type:
``com.vmware.vcenter.vm.hardware.Disk``. When methods return a
value of this class as a return value, the attribute will contain
identifiers for the resource type:
``com.vmware.vcenter.vm.hardware.Disk``.
If None or empty, compliance check is invoked on all the associated
disks.
"""
self.vm_home = vm_home
self.disks = disks
VapiStruct.__init__(self)
CheckSpec._set_binding_type(
type.StructType(
'com.vmware.vcenter.vm.storage.policy.compliance.check_spec', {
'vm_home': type.BooleanType(),
'disks': type.OptionalType(type.SetType(type.IdType())),
}, CheckSpec, False, None))
def get(
self,
vm,
):
"""
Returns the cached storage policy compliance information of a virtual
machine. This method was added in vSphere API 6.7.
:type vm: :class:`str`
:param vm: Virtual machine identifier.
The parameter must be an identifier for the resource type:
``VirtualMachine``.
:rtype: :class:`Compliance.Info` or ``None``
:return: Virtual machine storage policy compliance Info
:class:`Compliance.Info`.
If None, neither the virtual machine home directory nor any of it's
virtual disks are associated with a storage policy.
:raise: :class:`com.vmware.vapi.std.errors_client.Error`
if the system reports an error while responding to the request.
:raise: :class:`com.vmware.vapi.std.errors_client.ServiceUnavailable`
if the system is unable to communicate with a service to complete
the request.
:raise: :class:`com.vmware.vapi.std.errors_client.Unauthenticated`
if the user cannot be authenticated.
:raise: :class:`com.vmware.vapi.std.errors_client.Unauthorized`
if the user does not have the required privileges.
"""
return self._invoke('get', {
'vm': vm,
})
def check(
self,
vm,
check_spec=None,
):
"""
Returns the storage policy Compliance :class:`Compliance.Info` of a
virtual machine after explicitly re-computing compliance check. This
method was added in vSphere API 6.7.
:type vm: :class:`str`
:param vm: Virtual machine identifier.
The parameter must be an identifier for the resource type:
``VirtualMachine``.
:type check_spec: :class:`Compliance.CheckSpec` or ``None``
:param check_spec: Parameter specifies the entities on which storage policy compliance
check is to be invoked. The storage compliance Info
:class:`Compliance.Info` is returned.
If None, the behavior is equivalent to a
:class:`Compliance.CheckSpec` with CheckSpec#vmHome set to true and
CheckSpec#disks populated with all disks attached to the virtual
machine.
:rtype: :class:`Compliance.Info` or ``None``
:return: Virtual machine storage policy compliance ``Compliance.Info`` class
.
If None, neither the virtual machine home directory nor any of it's
virtual disks are associated with a storage policy.
:raise: :class:`com.vmware.vapi.std.errors_client.Error`
if the system reports an error while responding to the request.
:raise: :class:`com.vmware.vapi.std.errors_client.ServiceUnavailable`
if the system is unable to communicate with a service necessary to
complete the request.
:raise: :class:`com.vmware.vapi.std.errors_client.Unauthenticated`
if the user cannot be authenticated.
:raise: :class:`com.vmware.vapi.std.errors_client.Unauthorized`
if the user does not have the required privileges.
"""
return self._invoke('check', {
'vm': vm,
'check_spec': check_spec,
})
def __init__(self, config):
# properties for get operation
get_input_type = type.StructType('operation-input', {
'enforcement_point_name': type.StringType(),
'firewall_section_id': type.StringType(),
})
get_error_dict = {
'com.vmware.vapi.std.errors.service_unavailable':
type.ReferenceType('com.vmware.vapi.std.errors_client', 'ServiceUnavailable'),
'com.vmware.vapi.std.errors.invalid_request':
type.ReferenceType('com.vmware.vapi.std.errors_client', 'InvalidRequest'),
'com.vmware.vapi.std.errors.internal_server_error':
type.ReferenceType('com.vmware.vapi.std.errors_client', 'InternalServerError'),
'com.vmware.vapi.std.errors.unauthorized':
type.ReferenceType('com.vmware.vapi.std.errors_client', 'Unauthorized'),
'com.vmware.vapi.std.errors.not_found':
type.ReferenceType('com.vmware.vapi.std.errors_client', 'NotFound'),
}
get_input_value_validator_list = [
]
get_output_validator_list = [
]
get_rest_metadata = OperationRestMetadata(
http_method='GET',
url_template='/policy/api/v1/infra/realized-state/enforcement-points/{enforcement-point-name}/firewalls/firewall-sections/{firewall-section-id}',
path_variables={
'enforcement_point_name': 'enforcement-point-name',
'firewall_section_id': 'firewall-section-id',
},
query_parameters={
}
)
# properties for list operation
list_input_type = type.StructType('operation-input', {
'enforcement_point_name': type.StringType(),
'cursor': type.OptionalType(type.StringType()),
'included_fields': type.OptionalType(type.StringType()),
'page_size': type.OptionalType(type.IntegerType()),
'sort_ascending': type.OptionalType(type.BooleanType()),
'sort_by': type.OptionalType(type.StringType()),
})
list_error_dict = {
'com.vmware.vapi.std.errors.service_unavailable':
type.ReferenceType('com.vmware.vapi.std.errors_client', 'ServiceUnavailable'),
'com.vmware.vapi.std.errors.invalid_request':
type.ReferenceType('com.vmware.vapi.std.errors_client', 'InvalidRequest'),
'com.vmware.vapi.std.errors.internal_server_error':
type.ReferenceType('com.vmware.vapi.std.errors_client', 'InternalServerError'),
'com.vmware.vapi.std.errors.unauthorized':
type.ReferenceType('com.vmware.vapi.std.errors_client', 'Unauthorized'),
'com.vmware.vapi.std.errors.not_found':
type.ReferenceType('com.vmware.vapi.std.errors_client', 'NotFound'),
}
list_input_value_validator_list = [
]
list_output_validator_list = [
]
list_rest_metadata = OperationRestMetadata(
http_method='GET',
url_template='/policy/api/v1/infra/realized-state/enforcement-points/{enforcement-point-name}/firewalls/firewall-sections',
path_variables={
'enforcement_point_name': 'enforcement-point-name',
},
query_parameters={
'cursor': 'cursor',
'included_fields': 'included_fields',
'page_size': 'page_size',
'sort_ascending': 'sort_ascending',
'sort_by': 'sort_by',
}
)
operations = {
'get': {
'input_type': get_input_type,
'output_type': type.ReferenceType('com.vmware.nsx_policy.model_client', 'RealizedFirewallSection'),
'errors': get_error_dict,
'input_value_validator_list': get_input_value_validator_list,
'output_validator_list': get_output_validator_list,
'task_type': TaskType.NONE,
},
'list': {
'input_type': list_input_type,
'output_type': type.ReferenceType('com.vmware.nsx_policy.model_client', 'RealizedFirewallSectionListResult'),
'errors': list_error_dict,
'input_value_validator_list': list_input_value_validator_list,
'output_validator_list': list_output_validator_list,
'task_type': TaskType.NONE,
},
}
rest_metadata = {
'get': get_rest_metadata,
'list': list_rest_metadata,
}
ApiInterfaceStub.__init__(
self, iface_name='com.vmware.nsx_policy.infra.realized_state.enforcement_points.firewalls.firewall_sections',
config=config, operations=operations, rest_metadata=rest_metadata,
is_vapi_rest=False)
def __init__(self, config):
# properties for delete operation
delete_input_type = type.StructType('operation-input', {
'tier0_id': type.StringType(),
'locale_service_id': type.StringType(),
'neighbor_id': type.StringType(),
})
delete_error_dict = {
'com.vmware.vapi.std.errors.service_unavailable':
type.ReferenceType('com.vmware.vapi.std.errors_client', 'ServiceUnavailable'),
'com.vmware.vapi.std.errors.invalid_request':
type.ReferenceType('com.vmware.vapi.std.errors_client', 'InvalidRequest'),
'com.vmware.vapi.std.errors.internal_server_error':
type.ReferenceType('com.vmware.vapi.std.errors_client', 'InternalServerError'),
'com.vmware.vapi.std.errors.unauthorized':
type.ReferenceType('com.vmware.vapi.std.errors_client', 'Unauthorized'),
'com.vmware.vapi.std.errors.not_found':
type.ReferenceType('com.vmware.vapi.std.errors_client', 'NotFound'),
}
delete_input_value_validator_list = [
]
delete_output_validator_list = [
]
delete_rest_metadata = OperationRestMetadata(
http_method='DELETE',
url_template='/policy/api/v1/infra/tier-0s/{tier-0-id}/locale-services/{locale-service-id}/bgp/neighbors/{neighbor-id}',
path_variables={
'tier0_id': 'tier-0-id',
'locale_service_id': 'locale-service-id',
'neighbor_id': 'neighbor-id',
},
query_parameters={
},
content_type='application/json'
)
# properties for get operation
get_input_type = type.StructType('operation-input', {
'tier0_id': type.StringType(),
'locale_service_id': type.StringType(),
'neighbor_id': type.StringType(),
})
get_error_dict = {
'com.vmware.vapi.std.errors.service_unavailable':
type.ReferenceType('com.vmware.vapi.std.errors_client', 'ServiceUnavailable'),
'com.vmware.vapi.std.errors.invalid_request':
type.ReferenceType('com.vmware.vapi.std.errors_client', 'InvalidRequest'),
'com.vmware.vapi.std.errors.internal_server_error':
type.ReferenceType('com.vmware.vapi.std.errors_client', 'InternalServerError'),
'com.vmware.vapi.std.errors.unauthorized':
type.ReferenceType('com.vmware.vapi.std.errors_client', 'Unauthorized'),
'com.vmware.vapi.std.errors.not_found':
type.ReferenceType('com.vmware.vapi.std.errors_client', 'NotFound'),
}
get_input_value_validator_list = [
]
get_output_validator_list = [
]
get_rest_metadata = OperationRestMetadata(
http_method='GET',
url_template='/policy/api/v1/infra/tier-0s/{tier-0-id}/locale-services/{locale-service-id}/bgp/neighbors/{neighbor-id}',
path_variables={
'tier0_id': 'tier-0-id',
'locale_service_id': 'locale-service-id',
'neighbor_id': 'neighbor-id',
},
query_parameters={
},
content_type='application/json'
)
# properties for list operation
list_input_type = type.StructType('operation-input', {
'tier0_id': type.StringType(),
'locale_service_id': type.StringType(),
'cursor': type.OptionalType(type.StringType()),
'included_fields': type.OptionalType(type.StringType()),
'page_size': type.OptionalType(type.IntegerType()),
'sort_ascending': type.OptionalType(type.BooleanType()),
'sort_by': type.OptionalType(type.StringType()),
})
list_error_dict = {
'com.vmware.vapi.std.errors.service_unavailable':
type.ReferenceType('com.vmware.vapi.std.errors_client', 'ServiceUnavailable'),
'com.vmware.vapi.std.errors.invalid_request':
type.ReferenceType('com.vmware.vapi.std.errors_client', 'InvalidRequest'),
'com.vmware.vapi.std.errors.internal_server_error':
type.ReferenceType('com.vmware.vapi.std.errors_client', 'InternalServerError'),
'com.vmware.vapi.std.errors.unauthorized':
type.ReferenceType('com.vmware.vapi.std.errors_client', 'Unauthorized'),
'com.vmware.vapi.std.errors.not_found':
type.ReferenceType('com.vmware.vapi.std.errors_client', 'NotFound'),
}
list_input_value_validator_list = [
]
list_output_validator_list = [
]
list_rest_metadata = OperationRestMetadata(
http_method='GET',
url_template='/policy/api/v1/infra/tier-0s/{tier-0-id}/locale-services/{locale-service-id}/bgp/neighbors',
path_variables={
'tier0_id': 'tier-0-id',
'locale_service_id': 'locale-service-id',
},
query_parameters={
'cursor': 'cursor',
'included_fields': 'included_fields',
'page_size': 'page_size',
'sort_ascending': 'sort_ascending',
'sort_by': 'sort_by',
},
content_type='application/json'
)
# properties for patch operation
patch_input_type = type.StructType('operation-input', {
'tier0_id': type.StringType(),
'locale_service_id': type.StringType(),
'neighbor_id': type.StringType(),
'bgp_neighbor_config': type.ReferenceType('com.vmware.nsx_policy.model_client', 'BgpNeighborConfig'),
})
patch_error_dict = {
'com.vmware.vapi.std.errors.service_unavailable':
type.ReferenceType('com.vmware.vapi.std.errors_client', 'ServiceUnavailable'),
'com.vmware.vapi.std.errors.invalid_request':
type.ReferenceType('com.vmware.vapi.std.errors_client', 'InvalidRequest'),
'com.vmware.vapi.std.errors.internal_server_error':
type.ReferenceType('com.vmware.vapi.std.errors_client', 'InternalServerError'),
'com.vmware.vapi.std.errors.unauthorized':
type.ReferenceType('com.vmware.vapi.std.errors_client', 'Unauthorized'),
'com.vmware.vapi.std.errors.not_found':
type.ReferenceType('com.vmware.vapi.std.errors_client', 'NotFound'),
}
patch_input_value_validator_list = [
]
patch_output_validator_list = [
]
patch_rest_metadata = OperationRestMetadata(
http_method='PATCH',
url_template='/policy/api/v1/infra/tier-0s/{tier-0-id}/locale-services/{locale-service-id}/bgp/neighbors/{neighbor-id}',
request_body_parameter='bgp_neighbor_config',
path_variables={
'tier0_id': 'tier-0-id',
'locale_service_id': 'locale-service-id',
'neighbor_id': 'neighbor-id',
},
query_parameters={
},
content_type='application/json'
)
# properties for update operation
update_input_type = type.StructType('operation-input', {
'tier0_id': type.StringType(),
'locale_service_id': type.StringType(),
'neighbor_id': type.StringType(),
'bgp_neighbor_config': type.ReferenceType('com.vmware.nsx_policy.model_client', 'BgpNeighborConfig'),
})
update_error_dict = {
'com.vmware.vapi.std.errors.service_unavailable':
type.ReferenceType('com.vmware.vapi.std.errors_client', 'ServiceUnavailable'),
'com.vmware.vapi.std.errors.invalid_request':
type.ReferenceType('com.vmware.vapi.std.errors_client', 'InvalidRequest'),
'com.vmware.vapi.std.errors.internal_server_error':
type.ReferenceType('com.vmware.vapi.std.errors_client', 'InternalServerError'),
'com.vmware.vapi.std.errors.unauthorized':
type.ReferenceType('com.vmware.vapi.std.errors_client', 'Unauthorized'),
'com.vmware.vapi.std.errors.not_found':
type.ReferenceType('com.vmware.vapi.std.errors_client', 'NotFound'),
}
update_input_value_validator_list = [
]
update_output_validator_list = [
]
update_rest_metadata = OperationRestMetadata(
http_method='PUT',
url_template='/policy/api/v1/infra/tier-0s/{tier-0-id}/locale-services/{locale-service-id}/bgp/neighbors/{neighbor-id}',
request_body_parameter='bgp_neighbor_config',
path_variables={
'tier0_id': 'tier-0-id',
'locale_service_id': 'locale-service-id',
'neighbor_id': 'neighbor-id',
},
query_parameters={
},
content_type='application/json'
)
operations = {
'delete': {
'input_type': delete_input_type,
'output_type': type.VoidType(),
'errors': delete_error_dict,
'input_value_validator_list': delete_input_value_validator_list,
'output_validator_list': delete_output_validator_list,
'task_type': TaskType.NONE,
},
'get': {
'input_type': get_input_type,
'output_type': type.ReferenceType('com.vmware.nsx_policy.model_client', 'BgpNeighborConfig'),
'errors': get_error_dict,
'input_value_validator_list': get_input_value_validator_list,
'output_validator_list': get_output_validator_list,
'task_type': TaskType.NONE,
},
'list': {
'input_type': list_input_type,
'output_type': type.ReferenceType('com.vmware.nsx_policy.model_client', 'BgpNeighborConfigListResult'),
'errors': list_error_dict,
'input_value_validator_list': list_input_value_validator_list,
'output_validator_list': list_output_validator_list,
'task_type': TaskType.NONE,
},
'patch': {
'input_type': patch_input_type,
'output_type': type.VoidType(),
'errors': patch_error_dict,
'input_value_validator_list': patch_input_value_validator_list,
'output_validator_list': patch_output_validator_list,
'task_type': TaskType.NONE,
},
'update': {
'input_type': update_input_type,
'output_type': type.ReferenceType('com.vmware.nsx_policy.model_client', 'BgpNeighborConfig'),
'errors': update_error_dict,
'input_value_validator_list': update_input_value_validator_list,
'output_validator_list': update_output_validator_list,
'task_type': TaskType.NONE,
},
}
rest_metadata = {
'delete': delete_rest_metadata,
'get': get_rest_metadata,
'list': list_rest_metadata,
'patch': patch_rest_metadata,
'update': update_rest_metadata,
}
ApiInterfaceStub.__init__(
self, iface_name='com.vmware.nsx_policy.infra.tier_0s.locale_services.bgp.neighbors',
config=config, operations=operations, rest_metadata=rest_metadata,
is_vapi_rest=False)
class Power(VapiInterface):
"""
The ``Power`` class provides methods for managing the guest operating
system power state of a virtual machine. This class was added in vSphere
API 6.7.
"""
_VAPI_SERVICE_ID = 'com.vmware.vcenter.vm.guest.power'
"""
Identifier of the service in canonical form.
"""
def __init__(self, config):
"""
:type config: :class:`vmware.vapi.bindings.stub.StubConfiguration`
:param config: Configuration to be used for creating the stub.
"""
VapiInterface.__init__(self, config, _PowerStub)
self._VAPI_OPERATION_IDS = {}
class State(Enum):
"""
Possible guest power states. This enumeration was added in vSphere API 6.7.
.. note::
This class represents an enumerated type in the interface language
definition. The class contains class attributes which represent the
values in the current version of the enumerated type. Newer versions of
the enumerated type may contain new values. To use new values of the
enumerated type in communication with a server that supports the newer
version of the API, you instantiate this class. See :ref:`enumerated
type description page <enumeration_description>`.
"""
RUNNING = None
"""
The guest OS is running. This class attribute was added in vSphere API 6.7.
"""
SHUTTING_DOWN = None
"""
The guest OS is shutting down. This class attribute was added in vSphere
API 6.7.
"""
RESETTING = None
"""
The guest OS is resetting. This class attribute was added in vSphere API
6.7.
"""
STANDBY = None
"""
The guest OS is in standby. This class attribute was added in vSphere API
6.7.
"""
NOT_RUNNING = None
"""
The guest OS is not running. This class attribute was added in vSphere API
6.7.
"""
UNAVAILABLE = None
"""
The guest OS power state is unknown. This class attribute was added in
vSphere API 6.7.
"""
def __init__(self, string):
"""
:type string: :class:`str`
:param string: String value for the :class:`State` instance.
"""
Enum.__init__(string)
State._set_values([
State('RUNNING'),
State('SHUTTING_DOWN'),
State('RESETTING'),
State('STANDBY'),
State('NOT_RUNNING'),
State('UNAVAILABLE'),
])
State._set_binding_type(
type.EnumType('com.vmware.vcenter.vm.guest.power.state', State))
class Info(VapiStruct):
"""
Information about the guest operating system power state. This class was
added in vSphere API 6.7.
.. tip::
The arguments are used to initialize data attributes with the same
names.
"""
def __init__(
self,
state=None,
operations_ready=None,
):
"""
:type state: :class:`Power.State`
:param state: The power state of the guest operating system. This attribute was
added in vSphere API 6.7.
:type operations_ready: :class:`bool`
:param operations_ready: Flag indicating if the virtual machine is ready to process soft
power operations. This attribute was added in vSphere API 6.7.
"""
self.state = state
self.operations_ready = operations_ready
VapiStruct.__init__(self)
Info._set_binding_type(
type.StructType(
'com.vmware.vcenter.vm.guest.power.info', {
'state': type.ReferenceType(__name__, 'Power.State'),
'operations_ready': type.BooleanType(),
}, Info, False, None))
def get(
self,
vm,
):
"""
Returns information about the guest operating system power state. This
method was added in vSphere API 6.7.
:type vm: :class:`str`
:param vm: Identifier of the virtual machine.
The parameter must be an identifier for the resource type:
``VirtualMachine``.
:rtype: :class:`Power.Info`
:return: Guest OS powerstate information.
:raise: :class:`com.vmware.vapi.std.errors_client.Error`
if the system reports an error while responding to the request.
:raise: :class:`com.vmware.vapi.std.errors_client.NotFound`
if the virtual machine is not found.
"""
return self._invoke('get', {
'vm': vm,
})
def shutdown(
self,
vm,
):
"""
Issues a request to the guest operating system asking it to perform a
clean shutdown of all services. This request returns immediately and
does not wait for the guest operating system to complete the operation.
This method was added in vSphere API 6.7.
:type vm: :class:`str`
:param vm: Identifier of the virtual machine.
The parameter must be an identifier for the resource type:
``VirtualMachine``.
:raise: :class:`com.vmware.vapi.std.errors_client.Error`
if the system reports an error while responding to the request.
:raise: :class:`com.vmware.vapi.std.errors_client.NotFound`
if the virtual machine is not found.
:raise: :class:`com.vmware.vapi.std.errors_client.AlreadyInDesiredState`
if the virtual machine is not powered on.
:raise: :class:`com.vmware.vapi.std.errors_client.ServiceUnavailable`
if VMware Tools is not running.
:raise: :class:`com.vmware.vapi.std.errors_client.NotAllowedInCurrentState`
if the virtual machine is suspended.
:raise: :class:`com.vmware.vapi.std.errors_client.ResourceBusy`
if the virtual machine is performing another operation.
:raise: :class:`com.vmware.vapi.std.errors_client.Unsupported`
if the virtual machine does not support being powered on (e.g.
marked as a template, serving as a fault-tolerance secondary
virtual machine).
"""
return self._invoke('shutdown', {
'vm': vm,
})
def reboot(
self,
vm,
):
"""
Issues a request to the guest operating system asking it to perform a
reboot. This request returns immediately and does not wait for the
guest operating system to complete the operation. This method was added
in vSphere API 6.7.
:type vm: :class:`str`
:param vm: Identifier of the virtual machine.
The parameter must be an identifier for the resource type:
``VirtualMachine``.
:raise: :class:`com.vmware.vapi.std.errors_client.Error`
if the system reports an error while responding to the request.
:raise: :class:`com.vmware.vapi.std.errors_client.NotFound`
if the virtual machine is not found.
:raise: :class:`com.vmware.vapi.std.errors_client.NotAllowedInCurrentState`
if the virtual machine is not powered on.
:raise: :class:`com.vmware.vapi.std.errors_client.ServiceUnavailable`
if VMware Tools is not running.
:raise: :class:`com.vmware.vapi.std.errors_client.ResourceBusy`
if the virtual machine is performing another operation.
:raise: :class:`com.vmware.vapi.std.errors_client.Unsupported`
if the virtual machine does not support being powered on (e.g.
marked as a template, serving as a fault-tolerance secondary
virtual machine).
"""
return self._invoke('reboot', {
'vm': vm,
})
def standby(
self,
vm,
):
"""
Issues a request to the guest operating system asking it to perform a
suspend operation. This method was added in vSphere API 6.7.
:type vm: :class:`str`
:param vm: Identifier of the virtual machine.
The parameter must be an identifier for the resource type:
``VirtualMachine``.
:raise: :class:`com.vmware.vapi.std.errors_client.Error`
if the system reports an error while responding to the request.
:raise: :class:`com.vmware.vapi.std.errors_client.AlreadyInDesiredState`
if the virtual machine is suspended.
:raise: :class:`com.vmware.vapi.std.errors_client.NotFound`
if the virtual machine is not found.
:raise: :class:`com.vmware.vapi.std.errors_client.ServiceUnavailable`
if VMware Tools is not running.
:raise: :class:`com.vmware.vapi.std.errors_client.NotAllowedInCurrentState`
if the virtual machine is not powered on.
:raise: :class:`com.vmware.vapi.std.errors_client.ResourceBusy`
if the virtual machine is performing another operation.
:raise: :class:`com.vmware.vapi.std.errors_client.Unsupported`
if the virtual machine does not support being powered on (e.g.
marked as a template, serving as a fault-tolerance secondary
virtual machine).
"""
return self._invoke('standby', {
'vm': vm,
})
class CurrentPeerCertificates(VapiInterface):
"""
Retrieves the list of TLS certificates used by peer key servers. Those are
meant for review. Following approval these certificates should be added as
trusted certificates in the :class:`TrustedPeerCertificates` class. This
class was added in vSphere API 7.0.0.0.
"""
_VAPI_SERVICE_ID = 'com.vmware.vcenter.trusted_infrastructure.trust_authority_clusters.kms.providers.current_peer_certificates'
"""
Identifier of the service in canonical form.
"""
def __init__(self, config):
"""
:type config: :class:`vmware.vapi.bindings.stub.StubConfiguration`
:param config: Configuration to be used for creating the stub.
"""
VapiInterface.__init__(self, config, _CurrentPeerCertificatesStub)
self._VAPI_OPERATION_IDS = {}
self._VAPI_OPERATION_IDS.update({'list_task': 'list$task'})
class Summary(VapiStruct):
"""
The ``CurrentPeerCertificates.Summary`` class contains a summary of the
current key server certificates. This class was added in vSphere API
7.0.0.0.
.. tip::
The arguments are used to initialize data attributes with the same
names.
"""
def __init__(
self,
server_name=None,
certificate=None,
error_messages=None,
trusted=None,
):
"""
:type server_name: :class:`str`
:param server_name: Name of the server. This attribute was added in vSphere API
7.0.0.0.
:type certificate: :class:`str` or ``None``
:param certificate: Server certificate. This attribute was added in vSphere API
7.0.0.0.
If None, the certificate cannot be retrieved from the remote
system, and :attr:`CurrentPeerCertificates.Summary.trusted` is
undefined. See
:attr:`CurrentPeerCertificates.Summary.error_messages` for details.
:type error_messages: :class:`list` of :class:`com.vmware.vapi.std_client.LocalizableMessage`
:param error_messages: Server certificate retrieval errors.
Specifies error details when retrieving the remote server
certificate fails. This list will be empty when
:attr:`CurrentPeerCertificates.Summary.certificate` is
:class:`set`.. This attribute was added in vSphere API 7.0.0.0.
:type trusted: :class:`bool`
:param trusted: whether server certificate is already trusted . This attribute was
added in vSphere API 7.0.0.0.
"""
self.server_name = server_name
self.certificate = certificate
self.error_messages = error_messages
self.trusted = trusted
VapiStruct.__init__(self)
Summary._set_binding_type(
type.StructType(
'com.vmware.vcenter.trusted_infrastructure.trust_authority_clusters.kms.providers.current_peer_certificates.summary',
{
'server_name':
type.StringType(),
'certificate':
type.OptionalType(type.StringType()),
'error_messages':
type.ListType(
type.ReferenceType('com.vmware.vapi.std_client',
'LocalizableMessage')),
'trusted':
type.BooleanType(),
}, Summary, False, None))
class FilterSpec(VapiStruct):
"""
The ``CurrentPeerCertificates.FilterSpec`` class contains attributes used
to filter the results when listing remote server certificates. This class
was added in vSphere API 7.0.0.0.
.. tip::
The arguments are used to initialize data attributes with the same
names.
"""
def __init__(
self,
server_names=None,
trusted=None,
):
"""
:type server_names: :class:`set` of :class:`str` or ``None``
:param server_names: Names that key server must have to match the filter (see
:attr:`CurrentPeerCertificates.Summary.server_name`). This
attribute was added in vSphere API 7.0.0.0.
If None or empty, key servers with any name match the filter.
:type trusted: :class:`bool` or ``None``
:param trusted: Trust status that server certificates must have to match the filter
(see :attr:`CurrentPeerCertificates.Summary.trusted`). This
attribute was added in vSphere API 7.0.0.0.
If None, trusted and untrusted server certificates match the
filter.
"""
self.server_names = server_names
self.trusted = trusted
VapiStruct.__init__(self)
FilterSpec._set_binding_type(
type.StructType(
'com.vmware.vcenter.trusted_infrastructure.trust_authority_clusters.kms.providers.current_peer_certificates.filter_spec',
{
'server_names': type.OptionalType(
type.SetType(type.StringType())),
'trusted': type.OptionalType(type.BooleanType()),
}, FilterSpec, False, None))
def list_task(
self,
cluster,
provider,
spec=None,
):
"""
Return the remote server certificates.
Contacts the configured key servers and attempts to retrieve their
certificates. These certificates might not yet be trusted.
If the returned certificates are to be considered trustworthy, then it
must be added to the list of trusted server certificates by adding to
the certificates returned by :func:`TrustedPeerCertificates.get` and
invoking :func:`TrustedPeerCertificates.update` with the updated
:class:`list` of certificates.. This method was added in vSphere API
7.0.0.0.
:type cluster: :class:`str`
:param cluster: Identifier of the cluster.
The parameter must be an identifier for the resource type:
``ClusterComputeResource``.
:type provider: :class:`str`
:param provider: Identifier of the provider.
The parameter must be an identifier for the resource type:
``com.vmware.vcenter.trusted_infrastructure.trust_authority_clusters.kms.Provider``.
:type spec: :class:`CurrentPeerCertificates.FilterSpec` or ``None``
:param spec: Filter spec.
If None, the behavior is equivalent to a
:class:`CurrentPeerCertificates.FilterSpec` with all attributes
None
:rtype: :class: `vmware.vapi.stdlib.client.task.Task`
:return: Task instance
:raise: :class:`com.vmware.vapi.std.errors_client.InvalidArgument`
If the cluster or provider id is empty.
:raise: :class:`com.vmware.vapi.std.errors_client.NotFound`
If the cluster or provider is not found.
:raise: :class:`com.vmware.vapi.std.errors_client.Unauthenticated`
If the caller is not authenticated.
:raise: :class:`com.vmware.vapi.std.errors_client.Error`
For any other error.
"""
task_id = self._invoke('list$task', {
'cluster': cluster,
'provider': provider,
'spec': spec,
})
task_svc = Tasks(self._config)
task_instance = Task(
task_id, task_svc,
type.ListType(
type.ReferenceType(__name__,
'CurrentPeerCertificates.Summary')))
return task_instance
def __init__(self, config):
# properties for get operation
get_input_type = type.StructType(
'operation-input', {
'cursor': type.OptionalType(type.StringType()),
'format': type.OptionalType(type.StringType()),
'included_fields': type.OptionalType(type.StringType()),
'page_size': type.OptionalType(type.IntegerType()),
'sort_ascending': type.OptionalType(type.BooleanType()),
'sort_by': type.OptionalType(type.StringType()),
})
get_error_dict = {
'com.vmware.vapi.std.errors.service_unavailable':
type.ReferenceType('com.vmware.vapi.std.errors_client',
'ServiceUnavailable'),
'com.vmware.vapi.std.errors.invalid_request':
type.ReferenceType('com.vmware.vapi.std.errors_client',
'InvalidRequest'),
'com.vmware.vapi.std.errors.internal_server_error':
type.ReferenceType('com.vmware.vapi.std.errors_client',
'InternalServerError'),
'com.vmware.vapi.std.errors.unauthorized':
type.ReferenceType('com.vmware.vapi.std.errors_client',
'Unauthorized'),
'com.vmware.vapi.std.errors.not_found':
type.ReferenceType('com.vmware.vapi.std.errors_client',
'NotFound'),
}
get_input_value_validator_list = []
get_output_validator_list = []
get_rest_metadata = OperationRestMetadata(
http_method='GET',
url_template='/api/v1/eula/content',
path_variables={},
query_parameters={
'cursor': 'cursor',
'format': 'format',
'included_fields': 'included_fields',
'page_size': 'page_size',
'sort_ascending': 'sort_ascending',
'sort_by': 'sort_by',
},
content_type='application/json')
operations = {
'get': {
'input_type':
get_input_type,
'output_type':
type.ReferenceType('com.vmware.nsx.model_client',
'EULAContent'),
'errors':
get_error_dict,
'input_value_validator_list':
get_input_value_validator_list,
'output_validator_list':
get_output_validator_list,
'task_type':
TaskType.NONE,
},
}
rest_metadata = {
'get': get_rest_metadata,
}
ApiInterfaceStub.__init__(self,
iface_name='com.vmware.nsx.eula.content',
config=config,
operations=operations,
rest_metadata=rest_metadata,
is_vapi_rest=False)
def __init__(self, config):
# properties for create operation
create_input_type = type.StructType(
'operation-input', {
'domain_id':
type.StringType(),
'directory_ldap_server':
type.ReferenceType('com.vmware.nsx.model_client',
'DirectoryLdapServer'),
})
create_error_dict = {
'com.vmware.vapi.std.errors.service_unavailable':
type.ReferenceType('com.vmware.vapi.std.errors_client',
'ServiceUnavailable'),
'com.vmware.vapi.std.errors.invalid_request':
type.ReferenceType('com.vmware.vapi.std.errors_client',
'InvalidRequest'),
'com.vmware.vapi.std.errors.internal_server_error':
type.ReferenceType('com.vmware.vapi.std.errors_client',
'InternalServerError'),
'com.vmware.vapi.std.errors.unauthorized':
type.ReferenceType('com.vmware.vapi.std.errors_client',
'Unauthorized'),
'com.vmware.vapi.std.errors.not_found':
type.ReferenceType('com.vmware.vapi.std.errors_client',
'NotFound'),
}
create_input_value_validator_list = []
create_output_validator_list = []
create_rest_metadata = OperationRestMetadata(
http_method='POST',
url_template='/api/v1/directory/domains/{domain-id}/ldap-servers',
request_body_parameter='directory_ldap_server',
path_variables={
'domain_id': 'domain-id',
},
query_parameters={},
content_type='application/json')
# properties for create_0 operation
create_0_input_type = type.StructType(
'operation-input', {
'domain_id': type.StringType(),
'server_id': type.StringType(),
'action': type.StringType(),
})
create_0_error_dict = {
'com.vmware.vapi.std.errors.service_unavailable':
type.ReferenceType('com.vmware.vapi.std.errors_client',
'ServiceUnavailable'),
'com.vmware.vapi.std.errors.invalid_request':
type.ReferenceType('com.vmware.vapi.std.errors_client',
'InvalidRequest'),
'com.vmware.vapi.std.errors.internal_server_error':
type.ReferenceType('com.vmware.vapi.std.errors_client',
'InternalServerError'),
'com.vmware.vapi.std.errors.unauthorized':
type.ReferenceType('com.vmware.vapi.std.errors_client',
'Unauthorized'),
'com.vmware.vapi.std.errors.not_found':
type.ReferenceType('com.vmware.vapi.std.errors_client',
'NotFound'),
}
create_0_input_value_validator_list = []
create_0_output_validator_list = []
create_0_rest_metadata = OperationRestMetadata(
http_method='POST',
url_template=
'/api/v1/directory/domains/{domain-id}/ldap-servers/{server-id}',
path_variables={
'domain_id': 'domain-id',
'server_id': 'server-id',
},
query_parameters={
'action': 'action',
},
content_type='application/json')
# properties for delete operation
delete_input_type = type.StructType('operation-input', {
'domain_id': type.StringType(),
'server_id': type.StringType(),
})
delete_error_dict = {
'com.vmware.vapi.std.errors.service_unavailable':
type.ReferenceType('com.vmware.vapi.std.errors_client',
'ServiceUnavailable'),
'com.vmware.vapi.std.errors.invalid_request':
type.ReferenceType('com.vmware.vapi.std.errors_client',
'InvalidRequest'),
'com.vmware.vapi.std.errors.internal_server_error':
type.ReferenceType('com.vmware.vapi.std.errors_client',
'InternalServerError'),
'com.vmware.vapi.std.errors.unauthorized':
type.ReferenceType('com.vmware.vapi.std.errors_client',
'Unauthorized'),
'com.vmware.vapi.std.errors.not_found':
type.ReferenceType('com.vmware.vapi.std.errors_client',
'NotFound'),
}
delete_input_value_validator_list = []
delete_output_validator_list = []
delete_rest_metadata = OperationRestMetadata(
http_method='DELETE',
url_template=
'/api/v1/directory/domains/{domain-id}/ldap-servers/{server-id}',
path_variables={
'domain_id': 'domain-id',
'server_id': 'server-id',
},
query_parameters={},
content_type='application/json')
# properties for get operation
get_input_type = type.StructType('operation-input', {
'domain_id': type.StringType(),
'server_id': type.StringType(),
})
get_error_dict = {
'com.vmware.vapi.std.errors.service_unavailable':
type.ReferenceType('com.vmware.vapi.std.errors_client',
'ServiceUnavailable'),
'com.vmware.vapi.std.errors.invalid_request':
type.ReferenceType('com.vmware.vapi.std.errors_client',
'InvalidRequest'),
'com.vmware.vapi.std.errors.internal_server_error':
type.ReferenceType('com.vmware.vapi.std.errors_client',
'InternalServerError'),
'com.vmware.vapi.std.errors.unauthorized':
type.ReferenceType('com.vmware.vapi.std.errors_client',
'Unauthorized'),
'com.vmware.vapi.std.errors.not_found':
type.ReferenceType('com.vmware.vapi.std.errors_client',
'NotFound'),
}
get_input_value_validator_list = []
get_output_validator_list = []
get_rest_metadata = OperationRestMetadata(
http_method='GET',
url_template=
'/api/v1/directory/domains/{domain-id}/ldap-servers/{server-id}',
path_variables={
'domain_id': 'domain-id',
'server_id': 'server-id',
},
query_parameters={},
content_type='application/json')
# properties for list operation
list_input_type = type.StructType(
'operation-input', {
'domain_id': type.StringType(),
'cursor': type.OptionalType(type.StringType()),
'included_fields': type.OptionalType(type.StringType()),
'page_size': type.OptionalType(type.IntegerType()),
'sort_ascending': type.OptionalType(type.BooleanType()),
'sort_by': type.OptionalType(type.StringType()),
})
list_error_dict = {
'com.vmware.vapi.std.errors.service_unavailable':
type.ReferenceType('com.vmware.vapi.std.errors_client',
'ServiceUnavailable'),
'com.vmware.vapi.std.errors.invalid_request':
type.ReferenceType('com.vmware.vapi.std.errors_client',
'InvalidRequest'),
'com.vmware.vapi.std.errors.internal_server_error':
type.ReferenceType('com.vmware.vapi.std.errors_client',
'InternalServerError'),
'com.vmware.vapi.std.errors.unauthorized':
type.ReferenceType('com.vmware.vapi.std.errors_client',
'Unauthorized'),
'com.vmware.vapi.std.errors.not_found':
type.ReferenceType('com.vmware.vapi.std.errors_client',
'NotFound'),
}
list_input_value_validator_list = []
list_output_validator_list = []
list_rest_metadata = OperationRestMetadata(
http_method='GET',
url_template='/api/v1/directory/domains/{domain-id}/ldap-servers',
path_variables={
'domain_id': 'domain-id',
},
query_parameters={
'cursor': 'cursor',
'included_fields': 'included_fields',
'page_size': 'page_size',
'sort_ascending': 'sort_ascending',
'sort_by': 'sort_by',
},
content_type='application/json')
# properties for update operation
update_input_type = type.StructType(
'operation-input', {
'domain_id':
type.StringType(),
'server_id':
type.StringType(),
'directory_ldap_server':
type.ReferenceType('com.vmware.nsx.model_client',
'DirectoryLdapServer'),
})
update_error_dict = {
'com.vmware.vapi.std.errors.service_unavailable':
type.ReferenceType('com.vmware.vapi.std.errors_client',
'ServiceUnavailable'),
'com.vmware.vapi.std.errors.invalid_request':
type.ReferenceType('com.vmware.vapi.std.errors_client',
'InvalidRequest'),
'com.vmware.vapi.std.errors.internal_server_error':
type.ReferenceType('com.vmware.vapi.std.errors_client',
'InternalServerError'),
'com.vmware.vapi.std.errors.unauthorized':
type.ReferenceType('com.vmware.vapi.std.errors_client',
'Unauthorized'),
'com.vmware.vapi.std.errors.not_found':
type.ReferenceType('com.vmware.vapi.std.errors_client',
'NotFound'),
}
update_input_value_validator_list = []
update_output_validator_list = []
update_rest_metadata = OperationRestMetadata(
http_method='PUT',
url_template=
'/api/v1/directory/domains/{domain-id}/ldap-servers/{server-id}',
request_body_parameter='directory_ldap_server',
path_variables={
'domain_id': 'domain-id',
'server_id': 'server-id',
},
query_parameters={},
content_type='application/json')
operations = {
'create': {
'input_type':
create_input_type,
'output_type':
type.ReferenceType('com.vmware.nsx.model_client',
'DirectoryLdapServer'),
'errors':
create_error_dict,
'input_value_validator_list':
create_input_value_validator_list,
'output_validator_list':
create_output_validator_list,
'task_type':
TaskType.NONE,
},
'create_0': {
'input_type': create_0_input_type,
'output_type': type.VoidType(),
'errors': create_0_error_dict,
'input_value_validator_list':
create_0_input_value_validator_list,
'output_validator_list': create_0_output_validator_list,
'task_type': TaskType.NONE,
},
'delete': {
'input_type': delete_input_type,
'output_type': type.VoidType(),
'errors': delete_error_dict,
'input_value_validator_list':
delete_input_value_validator_list,
'output_validator_list': delete_output_validator_list,
'task_type': TaskType.NONE,
},
'get': {
'input_type':
get_input_type,
'output_type':
type.ReferenceType('com.vmware.nsx.model_client',
'DirectoryLdapServer'),
'errors':
get_error_dict,
'input_value_validator_list':
get_input_value_validator_list,
'output_validator_list':
get_output_validator_list,
'task_type':
TaskType.NONE,
},
'list': {
'input_type':
list_input_type,
'output_type':
type.ReferenceType('com.vmware.nsx.model_client',
'DirectoryLdapServerListResults'),
'errors':
list_error_dict,
'input_value_validator_list':
list_input_value_validator_list,
'output_validator_list':
list_output_validator_list,
'task_type':
TaskType.NONE,
},
'update': {
'input_type':
update_input_type,
'output_type':
type.ReferenceType('com.vmware.nsx.model_client',
'DirectoryLdapServer'),
'errors':
update_error_dict,
'input_value_validator_list':
update_input_value_validator_list,
'output_validator_list':
update_output_validator_list,
'task_type':
TaskType.NONE,
},
}
rest_metadata = {
'create': create_rest_metadata,
'create_0': create_0_rest_metadata,
'delete': delete_rest_metadata,
'get': get_rest_metadata,
'list': list_rest_metadata,
'update': update_rest_metadata,
}
ApiInterfaceStub.__init__(
self,
iface_name='com.vmware.nsx.directory.domains.ldap_servers',
config=config,
operations=operations,
rest_metadata=rest_metadata,
is_vapi_rest=False)
class ReplicationStatus(VapiInterface):
"""
The ``ReplicationStatus`` interface provides methods to retrieve
replication status information of vCenter and Platform Services Controller
nodes of type VCSA_EMBEDDED/PSC_EXTERNAL (see :attr:`Nodes.Info.type`).
This class was added in vSphere API 6.7.2.
"""
_VAPI_SERVICE_ID = 'com.vmware.vcenter.topology.replication_status'
"""
Identifier of the service in canonical form.
"""
def __init__(self, config):
"""
:type config: :class:`vmware.vapi.bindings.stub.StubConfiguration`
:param config: Configuration to be used for creating the stub.
"""
VapiInterface.__init__(self, config, _ReplicationStatusStub)
class Summary(VapiStruct):
"""
The ``ReplicationStatus.Summary`` class contains replication information of
partner vCenter or Platform Services Controller node of type
VCSA_EMBEDDED/PSC_EXTERNAL (see :attr:`Nodes.Info.type`). This class was
added in vSphere API 6.7.2.
.. tip::
The arguments are used to initialize data attributes with the same
names.
"""
def __init__(
self,
node=None,
replication_partner=None,
partner_available=None,
status_available=None,
replicating=None,
change_lag=None,
):
"""
:type node: :class:`str`
:param node: Identifier for the vCenter or Platform Services Controller node.
Identifier can be either IP address or DNS resolvable name of the
node. This attribute was added in vSphere API 6.7.2.
When clients pass a value of this class as a parameter, the
attribute must be an identifier for the resource type:
``com.vmware.vcenter.VCenter.name``. When methods return a value of
this class as a return value, the attribute will be an identifier
for the resource type: ``com.vmware.vcenter.VCenter.name``.
:type replication_partner: :class:`str`
:param replication_partner: Identifier for the vCenter or Platform Services Controller
replication partner. Identifier can be either IP address or DNS
resolvable name of the replication partner. This attribute was
added in vSphere API 6.7.2.
When clients pass a value of this class as a parameter, the
attribute must be an identifier for the resource type:
``com.vmware.vcenter.VCenter.name``. When methods return a value of
this class as a return value, the attribute will be an identifier
for the resource type: ``com.vmware.vcenter.VCenter.name``.
:type partner_available: :class:`bool`
:param partner_available: Indicates if the VMware Directory Service on partner is reachable
or not. This attribute was added in vSphere API 6.7.2.
:type status_available: :class:`bool`
:param status_available: Indicates if the replication status for the node with respect to
replication partner can be retrieved or not. This attribute was
added in vSphere API 6.7.2.
:type replicating: :class:`bool` or ``None``
:param replicating: Indicates if node is processing replication changes from the
replication partner. This attribute was added in vSphere API 6.7.2.
This attribute will be None if the partner host or replication
status is not available, i.e, if
:attr:`ReplicationStatus.Summary.partner_available` or
:attr:`ReplicationStatus.Summary.status_available` is false.
:type change_lag: :class:`long` or ``None``
:param change_lag: Number of replication changes node is behind the replication
partner. This attribute was added in vSphere API 6.7.2.
This attribute will be None if the partner host or replication
status is not available, i.e, if
:attr:`ReplicationStatus.Summary.partner_available` or
:attr:`ReplicationStatus.Summary.status_available` is false.
"""
self.node = node
self.replication_partner = replication_partner
self.partner_available = partner_available
self.status_available = status_available
self.replicating = replicating
self.change_lag = change_lag
VapiStruct.__init__(self)
Summary._set_binding_type(
type.StructType(
'com.vmware.vcenter.topology.replication_status.summary', {
'node':
type.IdType(resource_types='com.vmware.vcenter.VCenter.name'),
'replication_partner':
type.IdType(resource_types='com.vmware.vcenter.VCenter.name'),
'partner_available':
type.BooleanType(),
'status_available':
type.BooleanType(),
'replicating':
type.OptionalType(type.BooleanType()),
'change_lag':
type.OptionalType(type.IntegerType()),
}, Summary, False, None))
class FilterSpec(VapiStruct):
"""
The ``ReplicationStatus.FilterSpec`` class contains attribute used to
filter the results when listing replication status for the vCenter and
Platform Services Controller nodes (see :func:`ReplicationStatus.list`) of
type VCSA_EMBEDDED/PSC_EXTERNAL (see :attr:`Nodes.Info.type`). This class
was added in vSphere API 6.7.2.
.. tip::
The arguments are used to initialize data attributes with the same
names.
"""
def __init__(
self,
nodes=None,
):
"""
:type nodes: :class:`set` of :class:`str` or ``None``
:param nodes: Identifier that a vCenter and Platform Services Controller node
must have to match the filter. (see
:attr:`ReplicationStatus.Summary.node`). This attribute was added
in vSphere API 6.7.2.
When clients pass a value of this class as a parameter, the
attribute must contain identifiers for the resource type:
``com.vmware.vcenter.VCenter.name``. When methods return a value of
this class as a return value, the attribute will contain
identifiers for the resource type:
``com.vmware.vcenter.VCenter.name``.
If None or empty, all vCenter and Platform Services Controller
nodes of type VCSA_EMBEDDED/PSC_EXTERNAL match the filter.
"""
self.nodes = nodes
VapiStruct.__init__(self)
FilterSpec._set_binding_type(
type.StructType(
'com.vmware.vcenter.topology.replication_status.filter_spec', {
'nodes': type.OptionalType(type.SetType(type.IdType())),
}, FilterSpec, False, None))
def list(
self,
filter=None,
):
"""
Returns the replication information of vCenter and Platform Services
Controller nodes of type VCSA_EMBEDDED/PSC_EXTERNAL (see
:attr:`Nodes.Info.type`) matching the
:class:`ReplicationStatus.FilterSpec`. This method was added in vSphere
API 6.7.2.
:type filter: :class:`ReplicationStatus.FilterSpec` or ``None``
:param filter: Specification of matching vCenter and Platform Services Controller
nodes for which information should be returned.
If None, the behavior is equivalent to a
:class:`ReplicationStatus.FilterSpec` with all attributes None
which means all vCenter and Platform Services Controller nodes of
type VCSA_EMBEDDED/PSC_EXTERNAL match the filter.
:rtype: :class:`list` of :class:`ReplicationStatus.Summary`
:return: Commonly used replication information about vCenter and Platform
Services Controller nodes matching the
:class:`ReplicationStatus.FilterSpec`.
:raise: :class:`com.vmware.vapi.std.errors_client.Unauthenticated`
if the user can not be authenticated.
:raise: :class:`com.vmware.vapi.std.errors_client.Unauthorized`
if the user doesn't have the required privileges.
:raise: :class:`com.vmware.vapi.std.errors_client.InvalidArgument`
if the :attr:`ReplicationStatus.FilterSpec.nodes` attribute
contains a invalid value.
"""
return self._invoke('list', {
'filter': filter,
})
def __init__(self, config):
# properties for list operation
list_input_type = type.StructType(
'operation-input', {
'component_type': type.OptionalType(type.StringType()),
'cursor': type.OptionalType(type.StringType()),
'included_fields': type.OptionalType(type.StringType()),
'page_size': type.OptionalType(type.IntegerType()),
'sort_ascending': type.OptionalType(type.BooleanType()),
'sort_by': type.OptionalType(type.StringType()),
'summary': type.OptionalType(type.BooleanType()),
'sync': type.OptionalType(type.BooleanType()),
})
list_error_dict = {
'com.vmware.vapi.std.errors.service_unavailable':
type.ReferenceType('com.vmware.vapi.std.errors_client',
'ServiceUnavailable'),
'com.vmware.vapi.std.errors.invalid_request':
type.ReferenceType('com.vmware.vapi.std.errors_client',
'InvalidRequest'),
'com.vmware.vapi.std.errors.internal_server_error':
type.ReferenceType('com.vmware.vapi.std.errors_client',
'InternalServerError'),
'com.vmware.vapi.std.errors.unauthorized':
type.ReferenceType('com.vmware.vapi.std.errors_client',
'Unauthorized'),
'com.vmware.vapi.std.errors.not_found':
type.ReferenceType('com.vmware.vapi.std.errors_client',
'NotFound'),
}
list_input_value_validator_list = []
list_output_validator_list = []
list_rest_metadata = OperationRestMetadata(
http_method='GET',
url_template=
'/api/v1/migration/migration-unit-groups/aggregate-info',
path_variables={},
query_parameters={
'component_type': 'component_type',
'cursor': 'cursor',
'included_fields': 'included_fields',
'page_size': 'page_size',
'sort_ascending': 'sort_ascending',
'sort_by': 'sort_by',
'summary': 'summary',
'sync': 'sync',
},
content_type='application/json')
operations = {
'list': {
'input_type':
list_input_type,
'output_type':
type.ReferenceType(
'com.vmware.nsx.model_client',
'MigrationUnitGroupAggregateInfoListResult'),
'errors':
list_error_dict,
'input_value_validator_list':
list_input_value_validator_list,
'output_validator_list':
list_output_validator_list,
'task_type':
TaskType.NONE,
},
}
rest_metadata = {
'list': list_rest_metadata,
}
ApiInterfaceStub.__init__(
self,
iface_name=
'com.vmware.nsx.migration.migration_unit_groups.aggregate_info',
config=config,
operations=operations,
rest_metadata=rest_metadata,
is_vapi_rest=False)
def __init__(self, config):
# properties for decommission operation
decommission_input_type = type.StructType(
'operation-input', {
'hostname':
type.IdType(resource_types='com.vmware.vcenter.VCenter.name'),
'spec':
type.ReferenceType(__name__, 'Pscs.DecommissionSpec'),
'only_precheck':
type.OptionalType(type.BooleanType()),
})
decommission_error_dict = {
'com.vmware.vapi.std.errors.unsupported':
type.ReferenceType('com.vmware.vapi.std.errors_client',
'Unsupported'),
'com.vmware.vapi.std.errors.invalid_argument':
type.ReferenceType('com.vmware.vapi.std.errors_client',
'InvalidArgument'),
'com.vmware.vapi.std.errors.unverified_peer':
type.ReferenceType('com.vmware.vapi.std.errors_client',
'UnverifiedPeer'),
'com.vmware.vapi.std.errors.unauthenticated':
type.ReferenceType('com.vmware.vapi.std.errors_client',
'Unauthenticated'),
'com.vmware.vapi.std.errors.not_allowed_in_current_state':
type.ReferenceType('com.vmware.vapi.std.errors_client',
'NotAllowedInCurrentState'),
}
decommission_input_value_validator_list = []
decommission_output_validator_list = []
decommission_rest_metadata = OperationRestMetadata(
http_method='POST',
url_template=
'/vcenter/topology/pscs/{hostname}?action=decommission',
path_variables={
'hostname': 'hostname',
},
query_parameters={})
operations = {
'decommission$task': {
'input_type': decommission_input_type,
'output_type':
type.IdType(resource_types='com.vmware.cis.TASK'),
'errors': decommission_error_dict,
'input_value_validator_list':
decommission_input_value_validator_list,
'output_validator_list': [],
'task_type': TaskType.TASK_ONLY,
},
}
rest_metadata = {
'decommission': decommission_rest_metadata,
}
ApiInterfaceStub.__init__(
self,
iface_name='com.vmware.vcenter.topology.pscs',
config=config,
operations=operations,
rest_metadata=rest_metadata,
is_vapi_rest=True)
def __init__(self, config):
# properties for create operation
create_input_type = type.StructType(
'operation-input', {
'i_DS_event_data_request':
type.ReferenceType('com.vmware.nsx.model_client',
'IDSEventDataRequest'),
'cursor':
type.OptionalType(type.StringType()),
'included_fields':
type.OptionalType(type.StringType()),
'page_size':
type.OptionalType(type.IntegerType()),
'sort_ascending':
type.OptionalType(type.BooleanType()),
'sort_by':
type.OptionalType(type.StringType()),
})
create_error_dict = {
'com.vmware.vapi.std.errors.service_unavailable':
type.ReferenceType('com.vmware.vapi.std.errors_client',
'ServiceUnavailable'),
'com.vmware.vapi.std.errors.invalid_request':
type.ReferenceType('com.vmware.vapi.std.errors_client',
'InvalidRequest'),
'com.vmware.vapi.std.errors.internal_server_error':
type.ReferenceType('com.vmware.vapi.std.errors_client',
'InternalServerError'),
'com.vmware.vapi.std.errors.unauthorized':
type.ReferenceType('com.vmware.vapi.std.errors_client',
'Unauthorized'),
'com.vmware.vapi.std.errors.not_found':
type.ReferenceType('com.vmware.vapi.std.errors_client',
'NotFound'),
}
create_input_value_validator_list = []
create_output_validator_list = []
create_rest_metadata = OperationRestMetadata(
http_method='POST',
url_template='/api/v1/intrusion-services/ids-summary',
request_body_parameter='i_DS_event_data_request',
path_variables={},
query_parameters={
'cursor': 'cursor',
'included_fields': 'included_fields',
'page_size': 'page_size',
'sort_ascending': 'sort_ascending',
'sort_by': 'sort_by',
},
content_type='application/json')
operations = {
'create': {
'input_type':
create_input_type,
'output_type':
type.ReferenceType('com.vmware.nsx.model_client',
'IDSSummaryListResult'),
'errors':
create_error_dict,
'input_value_validator_list':
create_input_value_validator_list,
'output_validator_list':
create_output_validator_list,
'task_type':
TaskType.NONE,
},
}
rest_metadata = {
'create': create_rest_metadata,
}
ApiInterfaceStub.__init__(
self,
iface_name='com.vmware.nsx.intrusion_services.ids_summary',
config=config,
operations=operations,
rest_metadata=rest_metadata,
is_vapi_rest=False)
def __init__(self, config):
# properties for create operation
create_input_type = type.StructType(
'operation-input', {
'section_id':
type.StringType(),
'firewall_rule':
type.ReferenceType('com.vmware.nsx.model_client',
'FirewallRule'),
'id':
type.OptionalType(type.StringType()),
'operation':
type.OptionalType(type.StringType()),
})
create_error_dict = {
'com.vmware.vapi.std.errors.service_unavailable':
type.ReferenceType('com.vmware.vapi.std.errors_client',
'ServiceUnavailable'),
'com.vmware.vapi.std.errors.invalid_request':
type.ReferenceType('com.vmware.vapi.std.errors_client',
'InvalidRequest'),
'com.vmware.vapi.std.errors.internal_server_error':
type.ReferenceType('com.vmware.vapi.std.errors_client',
'InternalServerError'),
'com.vmware.vapi.std.errors.unauthorized':
type.ReferenceType('com.vmware.vapi.std.errors_client',
'Unauthorized'),
'com.vmware.vapi.std.errors.not_found':
type.ReferenceType('com.vmware.vapi.std.errors_client',
'NotFound'),
}
create_input_value_validator_list = [HasFieldsOfValidator()]
create_output_validator_list = [HasFieldsOfValidator()]
create_rest_metadata = OperationRestMetadata(
http_method='POST',
url_template='/api/v1/firewall/sections/{section-id}/rules',
request_body_parameter='firewall_rule',
path_variables={
'section_id': 'section-id',
},
query_parameters={
'id': 'id',
'operation': 'operation',
},
content_type='application/json')
# properties for createmultiple operation
createmultiple_input_type = type.StructType(
'operation-input', {
'section_id':
type.StringType(),
'firewall_rule_list':
type.ReferenceType('com.vmware.nsx.model_client',
'FirewallRuleList'),
'id':
type.OptionalType(type.StringType()),
'operation':
type.OptionalType(type.StringType()),
})
createmultiple_error_dict = {
'com.vmware.vapi.std.errors.service_unavailable':
type.ReferenceType('com.vmware.vapi.std.errors_client',
'ServiceUnavailable'),
'com.vmware.vapi.std.errors.invalid_request':
type.ReferenceType('com.vmware.vapi.std.errors_client',
'InvalidRequest'),
'com.vmware.vapi.std.errors.internal_server_error':
type.ReferenceType('com.vmware.vapi.std.errors_client',
'InternalServerError'),
'com.vmware.vapi.std.errors.unauthorized':
type.ReferenceType('com.vmware.vapi.std.errors_client',
'Unauthorized'),
'com.vmware.vapi.std.errors.not_found':
type.ReferenceType('com.vmware.vapi.std.errors_client',
'NotFound'),
}
createmultiple_input_value_validator_list = [HasFieldsOfValidator()]
createmultiple_output_validator_list = [HasFieldsOfValidator()]
createmultiple_rest_metadata = OperationRestMetadata(
http_method='POST',
url_template=
'/api/v1/firewall/sections/{section-id}/rules?action=create_multiple',
request_body_parameter='firewall_rule_list',
path_variables={
'section_id': 'section-id',
},
query_parameters={
'id': 'id',
'operation': 'operation',
},
content_type='application/json')
# properties for delete operation
delete_input_type = type.StructType('operation-input', {
'section_id': type.StringType(),
'rule_id': type.StringType(),
})
delete_error_dict = {
'com.vmware.vapi.std.errors.service_unavailable':
type.ReferenceType('com.vmware.vapi.std.errors_client',
'ServiceUnavailable'),
'com.vmware.vapi.std.errors.invalid_request':
type.ReferenceType('com.vmware.vapi.std.errors_client',
'InvalidRequest'),
'com.vmware.vapi.std.errors.internal_server_error':
type.ReferenceType('com.vmware.vapi.std.errors_client',
'InternalServerError'),
'com.vmware.vapi.std.errors.unauthorized':
type.ReferenceType('com.vmware.vapi.std.errors_client',
'Unauthorized'),
'com.vmware.vapi.std.errors.not_found':
type.ReferenceType('com.vmware.vapi.std.errors_client',
'NotFound'),
}
delete_input_value_validator_list = []
delete_output_validator_list = []
delete_rest_metadata = OperationRestMetadata(
http_method='DELETE',
url_template=
'/api/v1/firewall/sections/{section-id}/rules/{rule-id}',
path_variables={
'section_id': 'section-id',
'rule_id': 'rule-id',
},
query_parameters={},
content_type='application/json')
# properties for get operation
get_input_type = type.StructType('operation-input', {
'section_id': type.StringType(),
'rule_id': type.StringType(),
})
get_error_dict = {
'com.vmware.vapi.std.errors.service_unavailable':
type.ReferenceType('com.vmware.vapi.std.errors_client',
'ServiceUnavailable'),
'com.vmware.vapi.std.errors.invalid_request':
type.ReferenceType('com.vmware.vapi.std.errors_client',
'InvalidRequest'),
'com.vmware.vapi.std.errors.internal_server_error':
type.ReferenceType('com.vmware.vapi.std.errors_client',
'InternalServerError'),
'com.vmware.vapi.std.errors.unauthorized':
type.ReferenceType('com.vmware.vapi.std.errors_client',
'Unauthorized'),
'com.vmware.vapi.std.errors.not_found':
type.ReferenceType('com.vmware.vapi.std.errors_client',
'NotFound'),
}
get_input_value_validator_list = []
get_output_validator_list = [HasFieldsOfValidator()]
get_rest_metadata = OperationRestMetadata(
http_method='GET',
url_template=
'/api/v1/firewall/sections/{section-id}/rules/{rule-id}',
path_variables={
'section_id': 'section-id',
'rule_id': 'rule-id',
},
query_parameters={},
content_type='application/json')
# properties for list operation
list_input_type = type.StructType(
'operation-input', {
'section_id': type.StringType(),
'applied_tos': type.OptionalType(type.StringType()),
'context_profiles': type.OptionalType(type.StringType()),
'cursor': type.OptionalType(type.StringType()),
'deep_search': type.OptionalType(type.BooleanType()),
'destinations': type.OptionalType(type.StringType()),
'extended_sources': type.OptionalType(type.StringType()),
'filter_type': type.OptionalType(type.StringType()),
'included_fields': type.OptionalType(type.StringType()),
'page_size': type.OptionalType(type.IntegerType()),
'search_invalid_references': type.OptionalType(
type.BooleanType()),
'services': type.OptionalType(type.StringType()),
'sort_ascending': type.OptionalType(type.BooleanType()),
'sort_by': type.OptionalType(type.StringType()),
'sources': type.OptionalType(type.StringType()),
})
list_error_dict = {
'com.vmware.vapi.std.errors.service_unavailable':
type.ReferenceType('com.vmware.vapi.std.errors_client',
'ServiceUnavailable'),
'com.vmware.vapi.std.errors.invalid_request':
type.ReferenceType('com.vmware.vapi.std.errors_client',
'InvalidRequest'),
'com.vmware.vapi.std.errors.internal_server_error':
type.ReferenceType('com.vmware.vapi.std.errors_client',
'InternalServerError'),
'com.vmware.vapi.std.errors.unauthorized':
type.ReferenceType('com.vmware.vapi.std.errors_client',
'Unauthorized'),
'com.vmware.vapi.std.errors.not_found':
type.ReferenceType('com.vmware.vapi.std.errors_client',
'NotFound'),
}
list_input_value_validator_list = []
list_output_validator_list = [HasFieldsOfValidator()]
list_rest_metadata = OperationRestMetadata(
http_method='GET',
url_template='/api/v1/firewall/sections/{section-id}/rules',
path_variables={
'section_id': 'section-id',
},
query_parameters={
'applied_tos': 'applied_tos',
'context_profiles': 'context_profiles',
'cursor': 'cursor',
'deep_search': 'deep_search',
'destinations': 'destinations',
'extended_sources': 'extended_sources',
'filter_type': 'filter_type',
'included_fields': 'included_fields',
'page_size': 'page_size',
'search_invalid_references': 'search_invalid_references',
'services': 'services',
'sort_ascending': 'sort_ascending',
'sort_by': 'sort_by',
'sources': 'sources',
},
content_type='application/json')
# properties for revise operation
revise_input_type = type.StructType(
'operation-input', {
'section_id':
type.StringType(),
'rule_id':
type.StringType(),
'firewall_rule':
type.ReferenceType('com.vmware.nsx.model_client',
'FirewallRule'),
'id':
type.OptionalType(type.StringType()),
'operation':
type.OptionalType(type.StringType()),
})
revise_error_dict = {
'com.vmware.vapi.std.errors.service_unavailable':
type.ReferenceType('com.vmware.vapi.std.errors_client',
'ServiceUnavailable'),
'com.vmware.vapi.std.errors.invalid_request':
type.ReferenceType('com.vmware.vapi.std.errors_client',
'InvalidRequest'),
'com.vmware.vapi.std.errors.internal_server_error':
type.ReferenceType('com.vmware.vapi.std.errors_client',
'InternalServerError'),
'com.vmware.vapi.std.errors.unauthorized':
type.ReferenceType('com.vmware.vapi.std.errors_client',
'Unauthorized'),
'com.vmware.vapi.std.errors.not_found':
type.ReferenceType('com.vmware.vapi.std.errors_client',
'NotFound'),
}
revise_input_value_validator_list = [HasFieldsOfValidator()]
revise_output_validator_list = [HasFieldsOfValidator()]
revise_rest_metadata = OperationRestMetadata(
http_method='POST',
url_template=
'/api/v1/firewall/sections/{section-id}/rules/{rule-id}?action=revise',
request_body_parameter='firewall_rule',
path_variables={
'section_id': 'section-id',
'rule_id': 'rule-id',
},
query_parameters={
'id': 'id',
'operation': 'operation',
},
content_type='application/json')
# properties for update operation
update_input_type = type.StructType(
'operation-input', {
'section_id':
type.StringType(),
'rule_id':
type.StringType(),
'firewall_rule':
type.ReferenceType('com.vmware.nsx.model_client',
'FirewallRule'),
})
update_error_dict = {
'com.vmware.vapi.std.errors.service_unavailable':
type.ReferenceType('com.vmware.vapi.std.errors_client',
'ServiceUnavailable'),
'com.vmware.vapi.std.errors.invalid_request':
type.ReferenceType('com.vmware.vapi.std.errors_client',
'InvalidRequest'),
'com.vmware.vapi.std.errors.internal_server_error':
type.ReferenceType('com.vmware.vapi.std.errors_client',
'InternalServerError'),
'com.vmware.vapi.std.errors.unauthorized':
type.ReferenceType('com.vmware.vapi.std.errors_client',
'Unauthorized'),
'com.vmware.vapi.std.errors.not_found':
type.ReferenceType('com.vmware.vapi.std.errors_client',
'NotFound'),
}
update_input_value_validator_list = [HasFieldsOfValidator()]
update_output_validator_list = [HasFieldsOfValidator()]
update_rest_metadata = OperationRestMetadata(
http_method='PUT',
url_template=
'/api/v1/firewall/sections/{section-id}/rules/{rule-id}',
request_body_parameter='firewall_rule',
path_variables={
'section_id': 'section-id',
'rule_id': 'rule-id',
},
query_parameters={},
content_type='application/json')
operations = {
'create': {
'input_type':
create_input_type,
'output_type':
type.ReferenceType('com.vmware.nsx.model_client',
'FirewallRule'),
'errors':
create_error_dict,
'input_value_validator_list':
create_input_value_validator_list,
'output_validator_list':
create_output_validator_list,
'task_type':
TaskType.NONE,
},
'createmultiple': {
'input_type':
createmultiple_input_type,
'output_type':
type.ReferenceType('com.vmware.nsx.model_client',
'FirewallRuleList'),
'errors':
createmultiple_error_dict,
'input_value_validator_list':
createmultiple_input_value_validator_list,
'output_validator_list':
createmultiple_output_validator_list,
'task_type':
TaskType.NONE,
},
'delete': {
'input_type': delete_input_type,
'output_type': type.VoidType(),
'errors': delete_error_dict,
'input_value_validator_list':
delete_input_value_validator_list,
'output_validator_list': delete_output_validator_list,
'task_type': TaskType.NONE,
},
'get': {
'input_type':
get_input_type,
'output_type':
type.ReferenceType('com.vmware.nsx.model_client',
'FirewallRule'),
'errors':
get_error_dict,
'input_value_validator_list':
get_input_value_validator_list,
'output_validator_list':
get_output_validator_list,
'task_type':
TaskType.NONE,
},
'list': {
'input_type':
list_input_type,
'output_type':
type.ReferenceType('com.vmware.nsx.model_client',
'FirewallRuleListResult'),
'errors':
list_error_dict,
'input_value_validator_list':
list_input_value_validator_list,
'output_validator_list':
list_output_validator_list,
'task_type':
TaskType.NONE,
},
'revise': {
'input_type':
revise_input_type,
'output_type':
type.ReferenceType('com.vmware.nsx.model_client',
'FirewallRule'),
'errors':
revise_error_dict,
'input_value_validator_list':
revise_input_value_validator_list,
'output_validator_list':
revise_output_validator_list,
'task_type':
TaskType.NONE,
},
'update': {
'input_type':
update_input_type,
'output_type':
type.ReferenceType('com.vmware.nsx.model_client',
'FirewallRule'),
'errors':
update_error_dict,
'input_value_validator_list':
update_input_value_validator_list,
'output_validator_list':
update_output_validator_list,
'task_type':
TaskType.NONE,
},
}
rest_metadata = {
'create': create_rest_metadata,
'createmultiple': createmultiple_rest_metadata,
'delete': delete_rest_metadata,
'get': get_rest_metadata,
'list': list_rest_metadata,
'revise': revise_rest_metadata,
'update': update_rest_metadata,
}
ApiInterfaceStub.__init__(
self,
iface_name='com.vmware.nsx.firewall.sections.rules',
config=config,
operations=operations,
rest_metadata=rest_metadata,
is_vapi_rest=False)
def __init__(self, config):
# properties for get operation
get_input_type = type.StructType(
'operation-input', {
'tier1_id':
type.StringType(),
'segment_id':
type.StringType(),
'cursor':
type.OptionalType(type.StringType()),
'edge_path':
type.OptionalType(type.StringType()),
'enforcement_point_path':
type.OptionalType(type.StringType()),
'include_mark_for_delete_objects':
type.OptionalType(type.BooleanType()),
'included_fields':
type.OptionalType(type.StringType()),
'page_size':
type.OptionalType(type.IntegerType()),
'sort_ascending':
type.OptionalType(type.BooleanType()),
'sort_by':
type.OptionalType(type.StringType()),
})
get_error_dict = {
'com.vmware.vapi.std.errors.service_unavailable':
type.ReferenceType('com.vmware.vapi.std.errors_client',
'ServiceUnavailable'),
'com.vmware.vapi.std.errors.invalid_request':
type.ReferenceType('com.vmware.vapi.std.errors_client',
'InvalidRequest'),
'com.vmware.vapi.std.errors.internal_server_error':
type.ReferenceType('com.vmware.vapi.std.errors_client',
'InternalServerError'),
'com.vmware.vapi.std.errors.unauthorized':
type.ReferenceType('com.vmware.vapi.std.errors_client',
'Unauthorized'),
'com.vmware.vapi.std.errors.not_found':
type.ReferenceType('com.vmware.vapi.std.errors_client',
'NotFound'),
}
get_input_value_validator_list = []
get_output_validator_list = []
get_rest_metadata = OperationRestMetadata(
http_method='GET',
url_template=
'/policy/api/v1/global-infra/tier-1s/{tier-1-id}/segments/{segment-id}/inter-site-forwarder/status',
path_variables={
'tier1_id': 'tier-1-id',
'segment_id': 'segment-id',
},
query_parameters={
'cursor': 'cursor',
'edge_path': 'edge_path',
'enforcement_point_path': 'enforcement_point_path',
'include_mark_for_delete_objects':
'include_mark_for_delete_objects',
'included_fields': 'included_fields',
'page_size': 'page_size',
'sort_ascending': 'sort_ascending',
'sort_by': 'sort_by',
},
content_type='application/json')
operations = {
'get': {
'input_type':
get_input_type,
'output_type':
type.ReferenceType('com.vmware.nsx_policy.model_client',
'SegmentCrossSiteTrafficStats'),
'errors':
get_error_dict,
'input_value_validator_list':
get_input_value_validator_list,
'output_validator_list':
get_output_validator_list,
'task_type':
TaskType.NONE,
},
}
rest_metadata = {
'get': get_rest_metadata,
}
ApiInterfaceStub.__init__(
self,
iface_name=
'com.vmware.nsx_policy.global_infra.tier_1s.segments.inter_site_forwarder.status',
config=config,
operations=operations,
rest_metadata=rest_metadata,
is_vapi_rest=False)
def __init__(self, config):
# properties for delete operation
delete_input_type = type.StructType('operation-input', {
'ip_pool_id': type.StringType(),
'ip_subnet_id': type.StringType(),
})
delete_error_dict = {
'com.vmware.vapi.std.errors.service_unavailable':
type.ReferenceType('com.vmware.vapi.std.errors_client', 'ServiceUnavailable'),
'com.vmware.vapi.std.errors.invalid_request':
type.ReferenceType('com.vmware.vapi.std.errors_client', 'InvalidRequest'),
'com.vmware.vapi.std.errors.internal_server_error':
type.ReferenceType('com.vmware.vapi.std.errors_client', 'InternalServerError'),
'com.vmware.vapi.std.errors.unauthorized':
type.ReferenceType('com.vmware.vapi.std.errors_client', 'Unauthorized'),
'com.vmware.vapi.std.errors.not_found':
type.ReferenceType('com.vmware.vapi.std.errors_client', 'NotFound'),
}
delete_input_value_validator_list = [
]
delete_output_validator_list = [
]
delete_rest_metadata = OperationRestMetadata(
http_method='DELETE',
url_template='/policy/api/v1/infra/ip-pools/{ip-pool-id}/ip-subnets/{ip-subnet-id}',
path_variables={
'ip_pool_id': 'ip-pool-id',
'ip_subnet_id': 'ip-subnet-id',
},
query_parameters={
},
content_type='application/json'
)
# properties for get operation
get_input_type = type.StructType('operation-input', {
'ip_pool_id': type.StringType(),
'ip_subnet_id': type.StringType(),
})
get_error_dict = {
'com.vmware.vapi.std.errors.service_unavailable':
type.ReferenceType('com.vmware.vapi.std.errors_client', 'ServiceUnavailable'),
'com.vmware.vapi.std.errors.invalid_request':
type.ReferenceType('com.vmware.vapi.std.errors_client', 'InvalidRequest'),
'com.vmware.vapi.std.errors.internal_server_error':
type.ReferenceType('com.vmware.vapi.std.errors_client', 'InternalServerError'),
'com.vmware.vapi.std.errors.unauthorized':
type.ReferenceType('com.vmware.vapi.std.errors_client', 'Unauthorized'),
'com.vmware.vapi.std.errors.not_found':
type.ReferenceType('com.vmware.vapi.std.errors_client', 'NotFound'),
}
get_input_value_validator_list = [
]
get_output_validator_list = [
HasFieldsOfValidator()
]
get_rest_metadata = OperationRestMetadata(
http_method='GET',
url_template='/policy/api/v1/infra/ip-pools/{ip-pool-id}/ip-subnets/{ip-subnet-id}',
path_variables={
'ip_pool_id': 'ip-pool-id',
'ip_subnet_id': 'ip-subnet-id',
},
query_parameters={
},
content_type='application/json'
)
# properties for list operation
list_input_type = type.StructType('operation-input', {
'ip_pool_id': type.StringType(),
'cursor': type.OptionalType(type.StringType()),
'include_mark_for_delete_objects': type.OptionalType(type.BooleanType()),
'included_fields': type.OptionalType(type.StringType()),
'page_size': type.OptionalType(type.IntegerType()),
'sort_ascending': type.OptionalType(type.BooleanType()),
'sort_by': type.OptionalType(type.StringType()),
})
list_error_dict = {
'com.vmware.vapi.std.errors.service_unavailable':
type.ReferenceType('com.vmware.vapi.std.errors_client', 'ServiceUnavailable'),
'com.vmware.vapi.std.errors.invalid_request':
type.ReferenceType('com.vmware.vapi.std.errors_client', 'InvalidRequest'),
'com.vmware.vapi.std.errors.internal_server_error':
type.ReferenceType('com.vmware.vapi.std.errors_client', 'InternalServerError'),
'com.vmware.vapi.std.errors.unauthorized':
type.ReferenceType('com.vmware.vapi.std.errors_client', 'Unauthorized'),
'com.vmware.vapi.std.errors.not_found':
type.ReferenceType('com.vmware.vapi.std.errors_client', 'NotFound'),
}
list_input_value_validator_list = [
]
list_output_validator_list = [
HasFieldsOfValidator()
]
list_rest_metadata = OperationRestMetadata(
http_method='GET',
url_template='/policy/api/v1/infra/ip-pools/{ip-pool-id}/ip-subnets',
path_variables={
'ip_pool_id': 'ip-pool-id',
},
query_parameters={
'cursor': 'cursor',
'include_mark_for_delete_objects': 'include_mark_for_delete_objects',
'included_fields': 'included_fields',
'page_size': 'page_size',
'sort_ascending': 'sort_ascending',
'sort_by': 'sort_by',
},
content_type='application/json'
)
# properties for patch operation
patch_input_type = type.StructType('operation-input', {
'ip_pool_id': type.StringType(),
'ip_subnet_id': type.StringType(),
'ip_address_pool_subnet': type.DynamicStructType('vmware.vapi.dynamic_struct', {}, VapiStruct, [type.ReferenceType('com.vmware.nsx_policy.model_client', 'IpAddressPoolSubnet')]),
})
patch_error_dict = {
'com.vmware.vapi.std.errors.service_unavailable':
type.ReferenceType('com.vmware.vapi.std.errors_client', 'ServiceUnavailable'),
'com.vmware.vapi.std.errors.invalid_request':
type.ReferenceType('com.vmware.vapi.std.errors_client', 'InvalidRequest'),
'com.vmware.vapi.std.errors.internal_server_error':
type.ReferenceType('com.vmware.vapi.std.errors_client', 'InternalServerError'),
'com.vmware.vapi.std.errors.unauthorized':
type.ReferenceType('com.vmware.vapi.std.errors_client', 'Unauthorized'),
'com.vmware.vapi.std.errors.not_found':
type.ReferenceType('com.vmware.vapi.std.errors_client', 'NotFound'),
}
patch_input_value_validator_list = [
HasFieldsOfValidator()
]
patch_output_validator_list = [
]
patch_rest_metadata = OperationRestMetadata(
http_method='PATCH',
url_template='/policy/api/v1/infra/ip-pools/{ip-pool-id}/ip-subnets/{ip-subnet-id}',
request_body_parameter='ip_address_pool_subnet',
path_variables={
'ip_pool_id': 'ip-pool-id',
'ip_subnet_id': 'ip-subnet-id',
},
query_parameters={
},
content_type='application/json'
)
# properties for update operation
update_input_type = type.StructType('operation-input', {
'ip_pool_id': type.StringType(),
'ip_subnet_id': type.StringType(),
'ip_address_pool_subnet': type.DynamicStructType('vmware.vapi.dynamic_struct', {}, VapiStruct, [type.ReferenceType('com.vmware.nsx_policy.model_client', 'IpAddressPoolSubnet')]),
})
update_error_dict = {
'com.vmware.vapi.std.errors.service_unavailable':
type.ReferenceType('com.vmware.vapi.std.errors_client', 'ServiceUnavailable'),
'com.vmware.vapi.std.errors.invalid_request':
type.ReferenceType('com.vmware.vapi.std.errors_client', 'InvalidRequest'),
'com.vmware.vapi.std.errors.internal_server_error':
type.ReferenceType('com.vmware.vapi.std.errors_client', 'InternalServerError'),
'com.vmware.vapi.std.errors.unauthorized':
type.ReferenceType('com.vmware.vapi.std.errors_client', 'Unauthorized'),
'com.vmware.vapi.std.errors.not_found':
type.ReferenceType('com.vmware.vapi.std.errors_client', 'NotFound'),
}
update_input_value_validator_list = [
HasFieldsOfValidator()
]
update_output_validator_list = [
HasFieldsOfValidator()
]
update_rest_metadata = OperationRestMetadata(
http_method='PUT',
url_template='/policy/api/v1/infra/ip-pools/{ip-pool-id}/ip-subnets/{ip-subnet-id}',
request_body_parameter='ip_address_pool_subnet',
path_variables={
'ip_pool_id': 'ip-pool-id',
'ip_subnet_id': 'ip-subnet-id',
},
query_parameters={
},
content_type='application/json'
)
operations = {
'delete': {
'input_type': delete_input_type,
'output_type': type.VoidType(),
'errors': delete_error_dict,
'input_value_validator_list': delete_input_value_validator_list,
'output_validator_list': delete_output_validator_list,
'task_type': TaskType.NONE,
},
'get': {
'input_type': get_input_type,
'output_type': type.DynamicStructType('vmware.vapi.dynamic_struct', {}, VapiStruct, [type.ReferenceType('com.vmware.nsx_policy.model_client', 'IpAddressPoolSubnet')]),
'errors': get_error_dict,
'input_value_validator_list': get_input_value_validator_list,
'output_validator_list': get_output_validator_list,
'task_type': TaskType.NONE,
},
'list': {
'input_type': list_input_type,
'output_type': type.ReferenceType('com.vmware.nsx_policy.model_client', 'IpAddressPoolSubnetListResult'),
'errors': list_error_dict,
'input_value_validator_list': list_input_value_validator_list,
'output_validator_list': list_output_validator_list,
'task_type': TaskType.NONE,
},
'patch': {
'input_type': patch_input_type,
'output_type': type.VoidType(),
'errors': patch_error_dict,
'input_value_validator_list': patch_input_value_validator_list,
'output_validator_list': patch_output_validator_list,
'task_type': TaskType.NONE,
},
'update': {
'input_type': update_input_type,
'output_type': type.DynamicStructType('vmware.vapi.dynamic_struct', {}, VapiStruct, [type.ReferenceType('com.vmware.nsx_policy.model_client', 'IpAddressPoolSubnet')]),
'errors': update_error_dict,
'input_value_validator_list': update_input_value_validator_list,
'output_validator_list': update_output_validator_list,
'task_type': TaskType.NONE,
},
}
rest_metadata = {
'delete': delete_rest_metadata,
'get': get_rest_metadata,
'list': list_rest_metadata,
'patch': patch_rest_metadata,
'update': update_rest_metadata,
}
ApiInterfaceStub.__init__(
self, iface_name='com.vmware.nsx_policy.infra.ip_pools.ip_subnets',
config=config, operations=operations, rest_metadata=rest_metadata,
is_vapi_rest=False)
def __init__(self, config):
# properties for get operation
get_input_type = type.StructType('operation-input', {
'cc_ext_id': type.StringType(),
})
get_error_dict = {
'com.vmware.vapi.std.errors.service_unavailable':
type.ReferenceType('com.vmware.vapi.std.errors_client',
'ServiceUnavailable'),
'com.vmware.vapi.std.errors.invalid_request':
type.ReferenceType('com.vmware.vapi.std.errors_client',
'InvalidRequest'),
'com.vmware.vapi.std.errors.internal_server_error':
type.ReferenceType('com.vmware.vapi.std.errors_client',
'InternalServerError'),
'com.vmware.vapi.std.errors.unauthorized':
type.ReferenceType('com.vmware.vapi.std.errors_client',
'Unauthorized'),
'com.vmware.vapi.std.errors.not_found':
type.ReferenceType('com.vmware.vapi.std.errors_client',
'NotFound'),
}
get_input_value_validator_list = []
get_output_validator_list = []
get_rest_metadata = OperationRestMetadata(
http_method='GET',
url_template='/api/v1/idfw/idfw-compute-collections/{cc-ext-id}',
path_variables={
'cc_ext_id': 'cc-ext-id',
},
query_parameters={},
content_type='application/json')
# properties for list operation
list_input_type = type.StructType(
'operation-input', {
'cursor': type.OptionalType(type.StringType()),
'included_fields': type.OptionalType(type.StringType()),
'page_size': type.OptionalType(type.IntegerType()),
'sort_ascending': type.OptionalType(type.BooleanType()),
'sort_by': type.OptionalType(type.StringType()),
})
list_error_dict = {
'com.vmware.vapi.std.errors.service_unavailable':
type.ReferenceType('com.vmware.vapi.std.errors_client',
'ServiceUnavailable'),
'com.vmware.vapi.std.errors.invalid_request':
type.ReferenceType('com.vmware.vapi.std.errors_client',
'InvalidRequest'),
'com.vmware.vapi.std.errors.internal_server_error':
type.ReferenceType('com.vmware.vapi.std.errors_client',
'InternalServerError'),
'com.vmware.vapi.std.errors.unauthorized':
type.ReferenceType('com.vmware.vapi.std.errors_client',
'Unauthorized'),
'com.vmware.vapi.std.errors.not_found':
type.ReferenceType('com.vmware.vapi.std.errors_client',
'NotFound'),
}
list_input_value_validator_list = []
list_output_validator_list = []
list_rest_metadata = OperationRestMetadata(
http_method='GET',
url_template='/api/v1/idfw/idfw-compute-collections',
path_variables={},
query_parameters={
'cursor': 'cursor',
'included_fields': 'included_fields',
'page_size': 'page_size',
'sort_ascending': 'sort_ascending',
'sort_by': 'sort_by',
},
content_type='application/json')
# properties for update operation
update_input_type = type.StructType(
'operation-input', {
'cc_ext_id':
type.StringType(),
'idfw_enabled_compute_collection':
type.ReferenceType('com.vmware.nsx.model_client',
'IdfwEnabledComputeCollection'),
})
update_error_dict = {
'com.vmware.vapi.std.errors.service_unavailable':
type.ReferenceType('com.vmware.vapi.std.errors_client',
'ServiceUnavailable'),
'com.vmware.vapi.std.errors.invalid_request':
type.ReferenceType('com.vmware.vapi.std.errors_client',
'InvalidRequest'),
'com.vmware.vapi.std.errors.internal_server_error':
type.ReferenceType('com.vmware.vapi.std.errors_client',
'InternalServerError'),
'com.vmware.vapi.std.errors.unauthorized':
type.ReferenceType('com.vmware.vapi.std.errors_client',
'Unauthorized'),
'com.vmware.vapi.std.errors.not_found':
type.ReferenceType('com.vmware.vapi.std.errors_client',
'NotFound'),
}
update_input_value_validator_list = []
update_output_validator_list = []
update_rest_metadata = OperationRestMetadata(
http_method='PUT',
url_template='/api/v1/idfw/idfw-compute-collections/{cc-ext-id}',
request_body_parameter='idfw_enabled_compute_collection',
path_variables={
'cc_ext_id': 'cc-ext-id',
},
query_parameters={},
content_type='application/json')
operations = {
'get': {
'input_type':
get_input_type,
'output_type':
type.ReferenceType('com.vmware.nsx.model_client',
'IdfwEnabledComputeCollection'),
'errors':
get_error_dict,
'input_value_validator_list':
get_input_value_validator_list,
'output_validator_list':
get_output_validator_list,
'task_type':
TaskType.NONE,
},
'list': {
'input_type':
list_input_type,
'output_type':
type.ReferenceType('com.vmware.nsx.model_client',
'IdfwEnabledComputeCollectionListResult'),
'errors':
list_error_dict,
'input_value_validator_list':
list_input_value_validator_list,
'output_validator_list':
list_output_validator_list,
'task_type':
TaskType.NONE,
},
'update': {
'input_type':
update_input_type,
'output_type':
type.ReferenceType('com.vmware.nsx.model_client',
'IdfwEnabledComputeCollection'),
'errors':
update_error_dict,
'input_value_validator_list':
update_input_value_validator_list,
'output_validator_list':
update_output_validator_list,
'task_type':
TaskType.NONE,
},
}
rest_metadata = {
'get': get_rest_metadata,
'list': list_rest_metadata,
'update': update_rest_metadata,
}
ApiInterfaceStub.__init__(
self,
iface_name='com.vmware.nsx.idfw.idfw_compute_collections',
config=config,
operations=operations,
rest_metadata=rest_metadata,
is_vapi_rest=False)
