com.vmware.nsx_policy package¶

Subpackages¶

com.vmware.nsx_policy.infra package

Submodules¶

com.vmware.nsx_policy.aaa_client module¶

class com.vmware.nsx_policy.aaa_client.EffectivePermissions(config)¶

Bases: vmware.vapi.bindings.stub.VapiInterface

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

get(feature_name, object_path)¶

Returns none if user doesn’t have access or feature_name from required request parameter is empty/invalid/doesn’t match with object-path provided.

Parameters

feature_name (str) – Feature name (required)
object_path (str) – Exact object Policy path (required)

Return type

com.vmware.nsx_policy.model_client.PathPermissionGroup

Returns

com.vmware.nsx_policy.model.PathPermissionGroup

Raise

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

Raise

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

Raise

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

Raise

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

Raise

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

class com.vmware.nsx_policy.aaa_client.ObjectPermissions(config)¶

Bases: vmware.vapi.bindings.stub.VapiInterface

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

delete(cursor=None, include_mark_for_delete_objects=None, included_fields=None, inheritance_disabled=None, page_size=None, path_prefix=None, role_name=None, sort_ascending=None, sort_by=None)¶

Delete object-permissions entries

Parameters

cursor (str or None) – Opaque cursor to be used for getting next page of records (supplied by current result page) (optional)
include_mark_for_delete_objects (bool or None) – Include objects that are marked for deletion in results (optional, default to false)
included_fields (str or None) – Comma separated list of fields that should be included in query result (optional)
inheritance_disabled (bool or None) – Does children of this object inherit this rule (optional, default to false)
page_size (long or None) – Maximum number of results to return in this page (server may return fewer) (optional, default to 1000)
path_prefix (str or None) – Path prefix (optional)
role_name (str or None) – Role name (optional)
sort_ascending (bool or None) – (optional)
sort_by (str or None) – Field by which records are sorted (optional)

Raise

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

Raise

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

Raise

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

Raise

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

Raise

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

list(cursor=None, include_mark_for_delete_objects=None, included_fields=None, inheritance_disabled=None, page_size=None, path_prefix=None, role_name=None, sort_ascending=None, sort_by=None)¶

Get list of Object-level RBAC entries.

Parameters

cursor (str or None) – Opaque cursor to be used for getting next page of records (supplied by current result page) (optional)
include_mark_for_delete_objects (bool or None) – Include objects that are marked for deletion in results (optional, default to false)
included_fields (str or None) – Comma separated list of fields that should be included in query result (optional)
inheritance_disabled (bool or None) – Does children of this object inherit this rule (optional, default to false)
page_size (long or None) – Maximum number of results to return in this page (server may return fewer) (optional, default to 1000)
path_prefix (str or None) – Path prefix (optional)
role_name (str or None) – Role name (optional)
sort_ascending (bool or None) – (optional)
sort_by (str or None) – Field by which records are sorted (optional)

Return type

com.vmware.nsx_policy.model_client.ObjectRolePermissionGroupListResult

Returns

com.vmware.nsx_policy.model.ObjectRolePermissionGroupListResult

Raise

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

Raise

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

Raise

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

Raise

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

Raise

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

patch(object_role_permission_group)¶

Create/update object permission mappings

Parameters: object_role_permission_group (com.vmware.nsx_policy.model_client.ObjectRolePermissionGroup) – (required)
Raise: com.vmware.vapi.std.errors_client.ServiceUnavailable Service Unavailable
Raise: com.vmware.vapi.std.errors_client.InvalidRequest Bad Request, Precondition Failed
Raise: com.vmware.vapi.std.errors_client.InternalServerError Internal Server Error
Raise: com.vmware.vapi.std.errors_client.Unauthorized Forbidden
Raise: com.vmware.vapi.std.errors_client.NotFound Not Found

class com.vmware.nsx_policy.aaa_client.StubFactory(stub_config)¶

Bases: vmware.vapi.bindings.stub.StubFactoryBase

Initialize StubFactoryBase

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

com.vmware.nsx_policy.compliance_client module¶

class com.vmware.nsx_policy.compliance_client.Status(config)¶

Bases: vmware.vapi.bindings.stub.VapiInterface

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

get()¶

Returns the compliance status and details of non compliant configuration

Return type: com.vmware.nsx_policy.model_client.PolicyComplianceStatus
Returns: com.vmware.nsx_policy.model.PolicyComplianceStatus
Raise: com.vmware.vapi.std.errors_client.ServiceUnavailable Service Unavailable
Raise: com.vmware.vapi.std.errors_client.InvalidRequest Bad Request, Precondition Failed
Raise: com.vmware.vapi.std.errors_client.InternalServerError Internal Server Error
Raise: com.vmware.vapi.std.errors_client.Unauthorized Forbidden
Raise: com.vmware.vapi.std.errors_client.NotFound Not Found

class com.vmware.nsx_policy.compliance_client.StubFactory(stub_config)¶

Bases: vmware.vapi.bindings.stub.StubFactoryBase

Initialize StubFactoryBase

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

com.vmware.nsx_policy.enforcement_points_client module¶

class com.vmware.nsx_policy.enforcement_points_client.ServiceDefinitions(config)¶

Bases: vmware.vapi.bindings.stub.VapiInterface

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

create(enforcement_point_id, service_definition)¶

Create a Service Definition on given enforcement point.

Parameters

enforcement_point_id (str) – Enforcement point id (required)
service_definition (com.vmware.nsx_policy.model_client.ServiceDefinition) – (required)

Return type

com.vmware.nsx_policy.model_client.ServiceDefinition

Returns

com.vmware.nsx_policy.model.ServiceDefinition

Raise

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

Raise

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

Raise

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

Raise

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

Raise

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

delete(enforcement_point_id, service_definition_id)¶

Delete an existing Service Definition on the given enforcement point.

Parameters

enforcement_point_id (str) – Enforcement point id (required)
service_definition_id (str) – Id of service definition (required)

Raise

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

Raise

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

Raise

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

Raise

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

Raise

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

get(enforcement_point_id, service_definition_id)¶

Read Service Definition with given service-definition-id.

Parameters

enforcement_point_id (str) – Enforcement point id (required)
service_definition_id (str) – Id of service definition (required)

Return type

com.vmware.nsx_policy.model_client.ServiceDefinition

Returns

com.vmware.nsx_policy.model.ServiceDefinition

Raise

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

Raise

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

Raise

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

Raise

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

Raise

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

list(enforcement_point_id)¶

List all Service Definitions registered on given enforcement point.

Parameters: enforcement_point_id (str) – Enforcement point id (required)
Return type: com.vmware.nsx_policy.model_client.ServiceInsertionServiceListResult
Returns: com.vmware.nsx_policy.model.ServiceInsertionServiceListResult
Raise: com.vmware.vapi.std.errors_client.ServiceUnavailable Service Unavailable
Raise: com.vmware.vapi.std.errors_client.InvalidRequest Bad Request, Precondition Failed
Raise: com.vmware.vapi.std.errors_client.InternalServerError Internal Server Error
Raise: com.vmware.vapi.std.errors_client.Unauthorized Forbidden
Raise: com.vmware.vapi.std.errors_client.NotFound Not Found

update(enforcement_point_id, service_definition_id, service_definition)¶

Update an existing Service Definition on the given enforcement point.

Parameters

enforcement_point_id (str) – Enforcement point id (required)
service_definition_id (str) – Id of service definition (required)
service_definition (com.vmware.nsx_policy.model_client.ServiceDefinition) – (required)

Return type

com.vmware.nsx_policy.model_client.ServiceDefinition

Returns

com.vmware.nsx_policy.model.ServiceDefinition

Raise

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

Raise

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

Raise

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

Raise

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

Raise

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

class com.vmware.nsx_policy.enforcement_points_client.StubFactory(stub_config)¶

Bases: vmware.vapi.bindings.stub.StubFactoryBase

Initialize StubFactoryBase

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

com.vmware.nsx_policy.fine_tuning_client module¶

class com.vmware.nsx_policy.fine_tuning_client.Resources(config)¶

Bases: vmware.vapi.bindings.stub.VapiInterface

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

list(cursor=None, include_mark_for_delete_objects=None, included_fields=None, page_size=None, sort_ascending=None, sort_by=None, type=None)¶

This API provides field names of attributes in NSX types that are owned by Policy, as opposed to those owned by the enforcement point. For any type on NSX, some of the attributes of that type may be owned and set by Policy when realizing the intent, while some others may be owned and set by the enforcement point itself. This information can be used to disable updates to Policy owned attributes by the advanced networking UI, while allowing tweaking to the attributes owned by the management plane.

Parameters

cursor (str or None) – Opaque cursor to be used for getting next page of records (supplied by current result page) (optional)
include_mark_for_delete_objects (bool or None) – Include objects that are marked for deletion in results (optional, default to false)
included_fields (str or None) – Comma separated list of fields that should be included in query result (optional)
page_size (long or None) – Maximum number of results to return in this page (server may return fewer) (optional, default to 1000)
sort_ascending (bool or None) – (optional)
sort_by (str or None) – Field by which records are sorted (optional)
type (str or None) – Type query (optional)

Return type

com.vmware.nsx_policy.model_client.ResourceInfoListResult

Returns

com.vmware.nsx_policy.model.ResourceInfoListResult

Raise

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

Raise

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

Raise

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

Raise

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

Raise

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

class com.vmware.nsx_policy.fine_tuning_client.StubFactory(stub_config)¶

Bases: vmware.vapi.bindings.stub.StubFactoryBase

Initialize StubFactoryBase

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

com.vmware.nsx_policy.infra_client module¶

class com.vmware.nsx_policy.infra_client.Certificates(config)¶

Bases: vmware.vapi.bindings.stub.VapiInterface

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

LIST_TYPE_CERTIFICATE = 'cluster_api_certificate'¶: Possible value for type of method Certificates.list().

delete(certificate_id)¶

Removes the specified certificate. The private key associated with the certificate is also deleted.

Parameters: certificate_id (str) – ID of certificate to delete (required)
Raise: com.vmware.vapi.std.errors_client.ServiceUnavailable Service Unavailable
Raise: com.vmware.vapi.std.errors_client.InvalidRequest Bad Request, Precondition Failed
Raise: com.vmware.vapi.std.errors_client.InternalServerError Internal Server Error
Raise: com.vmware.vapi.std.errors_client.Unauthorized Forbidden
Raise: com.vmware.vapi.std.errors_client.NotFound Not Found

get(certificate_id, details=None)¶

Returns information for the specified certificate ID, including the certificate’s id; resource_type (for example, certificate_self_signed, certificate_ca, or certificate_signed); pem_encoded data; and history of the certificate (who created or modified it and when). For additional information, include the ?details=true modifier at the end of the request URI.

Parameters

certificate_id (str) – ID of certificate to read (required)
details (bool or None) – whether to expand the pem data and show all its details (optional, default to false)

Return type

com.vmware.nsx_policy.model_client.TlsCertificate

Returns

com.vmware.nsx_policy.model.TlsCertificate

Raise

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

Raise

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

Raise

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

Raise

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

Raise

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

list(cursor=None, details=None, included_fields=None, page_size=None, sort_ascending=None, sort_by=None, type=None)¶

Returns all certificate information viewable by the user, including each certificate’s id; resource_type (for example, certificate_self_signed, certificate_ca, or certificate_signed); pem_encoded data; and history of the certificate (who created or modified it and when). For additional information, include the ?details=true modifier at the end of the request URI.

Parameters

cursor (str or None) – Opaque cursor to be used for getting next page of records (supplied by current result page) (optional)
details (bool or None) – whether to expand the pem data and show all its details (optional, default to false)
included_fields (str or None) – Comma separated list of fields that should be included in query result (optional)
page_size (long or None) – Maximum number of results to return in this page (server may return fewer) (optional, default to 1000)
sort_ascending (bool or None) – (optional)
sort_by (str or None) – Field by which records are sorted (optional)
type (str or None) – Type of certificate to return (optional)

Return type

com.vmware.nsx_policy.model_client.TlsCertificateList

Returns

com.vmware.nsx_policy.model.TlsCertificateList

Raise

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

Raise

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

Raise

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

Raise

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

Raise

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

patch(certificate_id, tls_trust_data)¶

Adds a new private-public certificate and, optionally, a private key that can be applied to one of the user-facing components (appliance management or edge). The certificate and the key should be stored in PEM format. If no private key is provided, the certificate is used as a client certificate in the trust store. A certificate chain will not be expanded into separate certificate instances for reference, but would be pushed to the enforcement point as a single certificate. This patch method does not modify an existing certificate.

Parameters

certificate_id (str) – (required)
tls_trust_data (com.vmware.nsx_policy.model_client.TlsTrustData) – (required)

Raise

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

Raise

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

Raise

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

Raise

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

Raise

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

update(certificate_id, tls_trust_data)¶

Adds a new private-public certificate and, optionally, a private key that can be applied to one of the user-facing components (appliance management or edge). The certificate and the key should be stored in PEM format. If no private key is provided, the certificate is used as a client certificate in the trust store. A certificate chain will not be expanded into separate certificate instances for reference, but would be pushed to the enforcement point as a single certificate.

Parameters

certificate_id (str) – (required)
tls_trust_data (com.vmware.nsx_policy.model_client.TlsTrustData) – (required)

Return type

com.vmware.nsx_policy.model_client.TlsCertificate

Returns

com.vmware.nsx_policy.model.TlsCertificate

Raise

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

Raise

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

Raise

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

Raise

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

Raise

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

class com.vmware.nsx_policy.infra_client.ContextProfiles(config)¶

Bases: vmware.vapi.bindings.stub.VapiInterface

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

delete(context_profile_id, force=None)¶

Deletes the specified Policy Context Profile. If the Policy Context Profile is consumed in a firewall rule, it won’t get deleted.

Parameters

context_profile_id (str) – Policy Context Profile Id (required)
force (bool or None) – Force delete the resource even if it is being used somewhere (optional, default to false)

Raise

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

Raise

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

Raise

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

Raise

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

Raise

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

get(context_profile_id)¶

Get a single PolicyContextProfile by id

Parameters: context_profile_id (str) – (required)
Return type: com.vmware.nsx_policy.model_client.PolicyContextProfile
Returns: com.vmware.nsx_policy.model.PolicyContextProfile
Raise: com.vmware.vapi.std.errors_client.ServiceUnavailable Service Unavailable
Raise: com.vmware.vapi.std.errors_client.InvalidRequest Bad Request, Precondition Failed
Raise: com.vmware.vapi.std.errors_client.InternalServerError Internal Server Error
Raise: com.vmware.vapi.std.errors_client.Unauthorized Forbidden
Raise: com.vmware.vapi.std.errors_client.NotFound Not Found

list(cursor=None, include_mark_for_delete_objects=None, included_fields=None, page_size=None, sort_ascending=None, sort_by=None)¶

Get all PolicyContextProfiles

Parameters

cursor (str or None) – Opaque cursor to be used for getting next page of records (supplied by current result page) (optional)
include_mark_for_delete_objects (bool or None) – Include objects that are marked for deletion in results (optional, default to false)
included_fields (str or None) – Comma separated list of fields that should be included in query result (optional)
page_size (long or None) – Maximum number of results to return in this page (server may return fewer) (optional, default to 1000)
sort_ascending (bool or None) – (optional)
sort_by (str or None) – Field by which records are sorted (optional)

Return type

com.vmware.nsx_policy.model_client.PolicyContextProfileListResult

Returns

com.vmware.nsx_policy.model.PolicyContextProfileListResult

Raise

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

Raise

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

Raise

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

Raise

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

Raise

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

patch(context_profile_id, policy_context_profile)¶

Creates/Updates a PolicyContextProfile, which encapsulates attribute and sub-attributes of network services. Rules for using attributes and sub-attributes in single PolicyContextProfile 1. One type of attribute can’t have multiple occurrences. ( Eg. - Attribute type APP_ID can be used only once per PolicyContextProfile.) 2. For specifying multiple values for an attribute, provide them in an array. 3. If sub-attribtes are mentioned for an attribute, then only single value is allowed for that attribute. 4. To get a list of supported attributes and sub-attributes fire the following REST API GET https://<policy-mgr>/policy/api/v1/infra/context-profiles/attributes

Parameters

context_profile_id (str) – (required)
policy_context_profile (com.vmware.nsx_policy.model_client.PolicyContextProfile) – (required)

Raise

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

Raise

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

Raise

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

Raise

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

Raise

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

update(context_profile_id, policy_context_profile)¶

Creates/Updates a PolicyContextProfile, which encapsulates attribute and sub-attributes of network services. Rules for using attributes and sub-attributes in single PolicyContextProfile 1. One type of attribute can’t have multiple occurrences. ( Eg. - Attribute type APP_ID can be used only once per PolicyContextProfile.) 2. For specifying multiple values for an attribute, provide them in an array. 3. If sub-attribtes are mentioned for an attribute, then only single value is allowed for that attribute. 4. To get a list of supported attributes and sub-attributes fire the following REST API GET https://<policy-mgr>/policy/api/v1/infra/context-profiles/attributes

Parameters

context_profile_id (str) – (required)
policy_context_profile (com.vmware.nsx_policy.model_client.PolicyContextProfile) – (required)

Return type

com.vmware.nsx_policy.model_client.PolicyContextProfile

Returns

com.vmware.nsx_policy.model.PolicyContextProfile

Raise

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

Raise

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

Raise

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

Raise

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

Raise

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

class com.vmware.nsx_policy.infra_client.Crls(config)¶

Bases: vmware.vapi.bindings.stub.VapiInterface

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

LIST_TYPE_CERTIFICATE = 'cluster_api_certificate'¶: Possible value for type of method Crls.list().

delete(crl_id)¶

Deletes an existing CRL.

Parameters: crl_id (str) – (required)
Raise: com.vmware.vapi.std.errors_client.ServiceUnavailable Service Unavailable
Raise: com.vmware.vapi.std.errors_client.InvalidRequest Bad Request, Precondition Failed
Raise: com.vmware.vapi.std.errors_client.InternalServerError Internal Server Error
Raise: com.vmware.vapi.std.errors_client.Unauthorized Forbidden
Raise: com.vmware.vapi.std.errors_client.NotFound Not Found

get(crl_id, details=None)¶

Returns information about the specified CRL. For additional information, include the ?details=true modifier at the end of the request URI.

Parameters

crl_id (str) – (required)
details (bool or None) – whether to expand the pem data and show all its details (optional, default to false)

Return type

com.vmware.nsx_policy.model_client.TlsCrl

Returns

com.vmware.nsx_policy.model.TlsCrl

Raise

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

Raise

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

Raise

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

Raise

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

Raise

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

importcrl(crl_id, tls_crl)¶

Adds a new certificate revocation list (CRLs). The CRL is used to verify the client certificate status against the revocation lists published by the CA. For this reason, the administrator needs to add the CRL in certificate repository as well. The CRL can contain a single CRL or multiple CRLs depending on the PEM data. - Single CRL: a single CRL is created with the given id. - Composite CRL: multiple CRLs are generated. Each of the CRL is created with an id generated based on the given id. First CRL is created with crl-id, second with crl-id-1, third with crl-id-2, etc.

Parameters

crl_id (str) – (required)
tls_crl (com.vmware.nsx_policy.model_client.TlsCrl) – (required)

Return type

com.vmware.nsx_policy.model_client.TlsCrlListResult

Returns

com.vmware.nsx_policy.model.TlsCrlListResult

Raise

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

Raise

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

Raise

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

Raise

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

Raise

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

list(cursor=None, details=None, included_fields=None, page_size=None, sort_ascending=None, sort_by=None, type=None)¶

Returns information about all CRLs. For additional information, include the ?details=true modifier at the end of the request URI.

Parameters

cursor (str or None) – Opaque cursor to be used for getting next page of records (supplied by current result page) (optional)
details (bool or None) – whether to expand the pem data and show all its details (optional, default to false)
included_fields (str or None) – Comma separated list of fields that should be included in query result (optional)
page_size (long or None) – Maximum number of results to return in this page (server may return fewer) (optional, default to 1000)
sort_ascending (bool or None) – (optional)
sort_by (str or None) – Field by which records are sorted (optional)
type (str or None) – Type of certificate to return (optional)

Return type

com.vmware.nsx_policy.model_client.TlsCrlListResult

Returns

com.vmware.nsx_policy.model.TlsCrlListResult

Raise

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

Raise

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

Raise

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

Raise

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

Raise

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

patch(crl_id, tls_crl)¶

Create or patch a Certificate Revocation List for the given id. The CRL is used to verify the client certificate status against the revocation lists published by the CA. For this reason, the administrator needs to add the CRL in certificate repository as well. The CRL must contain PEM data for a single CRL.

Parameters

crl_id (str) – (required)
tls_crl (com.vmware.nsx_policy.model_client.TlsCrl) – (required)

Raise

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

Raise

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

Raise

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

Raise

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

Raise

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

update(crl_id, tls_crl)¶

Create or replace a Certificate Revocation List for the given id. The CRL is used to verify the client certificate status against the revocation lists published by the CA. For this reason, the administrator needs to add the CRL in certificate repository as well. The CRL must contain PEM data for a single CRL. Revision is required.

Parameters

crl_id (str) – (required)
tls_crl (com.vmware.nsx_policy.model_client.TlsCrl) – (required)

Return type

com.vmware.nsx_policy.model_client.TlsCrl

Returns

com.vmware.nsx_policy.model.TlsCrl

Raise

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

Raise

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

Raise

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

Raise

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

Raise

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

class com.vmware.nsx_policy.infra_client.DhcpRelayConfigs(config)¶

Bases: vmware.vapi.bindings.stub.VapiInterface

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

delete(dhcp_relay_config_id)¶

Delete DHCP relay configuration

Parameters: dhcp_relay_config_id (str) – DHCP relay config ID (required)
Raise: com.vmware.vapi.std.errors_client.ServiceUnavailable Service Unavailable
Raise: com.vmware.vapi.std.errors_client.InvalidRequest Bad Request, Precondition Failed
Raise: com.vmware.vapi.std.errors_client.InternalServerError Internal Server Error
Raise: com.vmware.vapi.std.errors_client.Unauthorized Forbidden
Raise: com.vmware.vapi.std.errors_client.NotFound Not Found

get(dhcp_relay_config_id)¶

Read DHCP relay configuration

Parameters: dhcp_relay_config_id (str) – DHCP relay config ID (required)
Return type: com.vmware.nsx_policy.model_client.DhcpRelayConfig
Returns: com.vmware.nsx_policy.model.DhcpRelayConfig
Raise: com.vmware.vapi.std.errors_client.ServiceUnavailable Service Unavailable
Raise: com.vmware.vapi.std.errors_client.InvalidRequest Bad Request, Precondition Failed
Raise: com.vmware.vapi.std.errors_client.InternalServerError Internal Server Error
Raise: com.vmware.vapi.std.errors_client.Unauthorized Forbidden
Raise: com.vmware.vapi.std.errors_client.NotFound Not Found

list(cursor=None, include_mark_for_delete_objects=None, included_fields=None, page_size=None, sort_ascending=None, sort_by=None)¶

Paginated list of all DHCP relay config instances

Parameters

cursor (str or None) – Opaque cursor to be used for getting next page of records (supplied by current result page) (optional)
include_mark_for_delete_objects (bool or None) – Include objects that are marked for deletion in results (optional, default to false)
included_fields (str or None) – Comma separated list of fields that should be included in query result (optional)
page_size (long or None) – Maximum number of results to return in this page (server may return fewer) (optional, default to 1000)
sort_ascending (bool or None) – (optional)
sort_by (str or None) – Field by which records are sorted (optional)

Return type

com.vmware.nsx_policy.model_client.DhcpRelayConfigListResult

Returns

com.vmware.nsx_policy.model.DhcpRelayConfigListResult

Raise

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

Raise

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

Raise

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

Raise

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

Raise

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

patch(dhcp_relay_config_id, dhcp_relay_config)¶

If DHCP relay config with the dhcp-relay-config-id is not already present, create a new DHCP relay config instance. If it already exists, update the DHCP relay config instance with specified attributes.

Parameters

dhcp_relay_config_id (str) – DHCP relay config ID (required)
dhcp_relay_config (com.vmware.nsx_policy.model_client.DhcpRelayConfig) – (required)

Raise

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

Raise

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

Raise

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

Raise

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

Raise

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

update(dhcp_relay_config_id, dhcp_relay_config)¶

If DHCP relay config with the dhcp-relay-config-id is not already present, create a new DHCP relay config instance. If it already exists, replace the DHCP relay config instance with this object.

Parameters

dhcp_relay_config_id (str) – DHCP relay config ID (required)
dhcp_relay_config (com.vmware.nsx_policy.model_client.DhcpRelayConfig) – (required)

Return type

com.vmware.nsx_policy.model_client.DhcpRelayConfig

Returns

com.vmware.nsx_policy.model.DhcpRelayConfig

Raise

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

Raise

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

Raise

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

Raise

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

Raise

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

class com.vmware.nsx_policy.infra_client.DhcpServerConfigs(config)¶

Bases: vmware.vapi.bindings.stub.VapiInterface

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

delete(dhcp_server_config_id)¶

Delete DHCP server configuration

Parameters: dhcp_server_config_id (str) – DHCP server config ID (required)
Raise: com.vmware.vapi.std.errors_client.ServiceUnavailable Service Unavailable
Raise: com.vmware.vapi.std.errors_client.InvalidRequest Bad Request, Precondition Failed
Raise: com.vmware.vapi.std.errors_client.InternalServerError Internal Server Error
Raise: com.vmware.vapi.std.errors_client.Unauthorized Forbidden
Raise: com.vmware.vapi.std.errors_client.NotFound Not Found

get(dhcp_server_config_id)¶

Read DHCP server configuration

Parameters: dhcp_server_config_id (str) – DHCP server config ID (required)
Return type: com.vmware.nsx_policy.model_client.DhcpServerConfig
Returns: com.vmware.nsx_policy.model.DhcpServerConfig
Raise: com.vmware.vapi.std.errors_client.ServiceUnavailable Service Unavailable
Raise: com.vmware.vapi.std.errors_client.InvalidRequest Bad Request, Precondition Failed
Raise: com.vmware.vapi.std.errors_client.InternalServerError Internal Server Error
Raise: com.vmware.vapi.std.errors_client.Unauthorized Forbidden
Raise: com.vmware.vapi.std.errors_client.NotFound Not Found

list(cursor=None, include_mark_for_delete_objects=None, included_fields=None, page_size=None, sort_ascending=None, sort_by=None)¶

Paginated list of all DHCP server config instances

Parameters

cursor (str or None) – Opaque cursor to be used for getting next page of records (supplied by current result page) (optional)
include_mark_for_delete_objects (bool or None) – Include objects that are marked for deletion in results (optional, default to false)
included_fields (str or None) – Comma separated list of fields that should be included in query result (optional)
page_size (long or None) – Maximum number of results to return in this page (server may return fewer) (optional, default to 1000)
sort_ascending (bool or None) – (optional)
sort_by (str or None) – Field by which records are sorted (optional)

Return type

com.vmware.nsx_policy.model_client.DhcpServerConfigListResult

Returns

com.vmware.nsx_policy.model.DhcpServerConfigListResult

Raise

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

Raise

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

Raise

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

Raise

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

Raise

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

patch(dhcp_server_config_id, dhcp_server_config)¶

If DHCP server config with the dhcp-server-config-id is not already present, create a new DHCP server config instance. If it already exists, update the DHCP server config instance with specified attributes. Realized entities of this API can be found using the path of Tier-0 that this config is applied on.

Parameters

dhcp_server_config_id (str) – DHCP server config ID (required)
dhcp_server_config (com.vmware.nsx_policy.model_client.DhcpServerConfig) – (required)

Raise

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

Raise

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

Raise

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

Raise

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

Raise

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

update(dhcp_server_config_id, dhcp_server_config)¶

If DHCP server config with the dhcp-server-config-id is not already present, create a new DHCP server config instance. If it already exists, replace the DHCP server config instance with this object. Realized entities of this API can be found using the path of Tier-0 that this config is applied on.

Parameters

dhcp_server_config_id (str) – DHCP server config ID (required)
dhcp_server_config (com.vmware.nsx_policy.model_client.DhcpServerConfig) – (required)

Return type

com.vmware.nsx_policy.model_client.DhcpServerConfig

Returns

com.vmware.nsx_policy.model.DhcpServerConfig

Raise

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

Raise

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

Raise

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

Raise

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

Raise

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

class com.vmware.nsx_policy.infra_client.DnsForwarderZones(config)¶

Bases: vmware.vapi.bindings.stub.VapiInterface

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

delete(dns_forwarder_zone_id)¶

Delete the DNS Forwarder Zone

Parameters: dns_forwarder_zone_id (str) – DNS Forwarder Zone ID (required)
Raise: com.vmware.vapi.std.errors_client.ServiceUnavailable Service Unavailable
Raise: com.vmware.vapi.std.errors_client.InvalidRequest Bad Request, Precondition Failed
Raise: com.vmware.vapi.std.errors_client.InternalServerError Internal Server Error
Raise: com.vmware.vapi.std.errors_client.Unauthorized Forbidden
Raise: com.vmware.vapi.std.errors_client.NotFound Not Found

get(dns_forwarder_zone_id)¶

Read the DNS Forwarder Zone

Parameters: dns_forwarder_zone_id (str) – DNS Forwarder Zone ID (required)
Return type: com.vmware.nsx_policy.model_client.PolicyDnsForwarderZone
Returns: com.vmware.nsx_policy.model.PolicyDnsForwarderZone
Raise: com.vmware.vapi.std.errors_client.ServiceUnavailable Service Unavailable
Raise: com.vmware.vapi.std.errors_client.InvalidRequest Bad Request, Precondition Failed
Raise: com.vmware.vapi.std.errors_client.InternalServerError Internal Server Error
Raise: com.vmware.vapi.std.errors_client.Unauthorized Forbidden
Raise: com.vmware.vapi.std.errors_client.NotFound Not Found

list(cursor=None, include_mark_for_delete_objects=None, included_fields=None, page_size=None, sort_ascending=None, sort_by=None)¶

Paginated list of all Dns Forwarder Zones

Parameters

cursor (str or None) – Opaque cursor to be used for getting next page of records (supplied by current result page) (optional)
include_mark_for_delete_objects (bool or None) – Include objects that are marked for deletion in results (optional, default to false)
included_fields (str or None) – Comma separated list of fields that should be included in query result (optional)
page_size (long or None) – Maximum number of results to return in this page (server may return fewer) (optional, default to 1000)
sort_ascending (bool or None) – (optional)
sort_by (str or None) – Field by which records are sorted (optional)

Return type

com.vmware.nsx_policy.model_client.PolicyDnsForwarderZoneListResult

Returns

com.vmware.nsx_policy.model.PolicyDnsForwarderZoneListResult

Raise

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

Raise

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

Raise

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

Raise

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

Raise

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

patch(dns_forwarder_zone_id, policy_dns_forwarder_zone)¶

Create or update the DNS Forwarder Zone

Parameters

dns_forwarder_zone_id (str) – DNS Forwarder Zone ID (required)
policy_dns_forwarder_zone (com.vmware.nsx_policy.model_client.PolicyDnsForwarderZone) – (required)

Raise

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

Raise

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

Raise

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

Raise

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

Raise

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

update(dns_forwarder_zone_id, policy_dns_forwarder_zone)¶

Create or update the DNS Forwarder Zone

Parameters

dns_forwarder_zone_id (str) – DNS Forwarder Zone ID (required)
policy_dns_forwarder_zone (com.vmware.nsx_policy.model_client.PolicyDnsForwarderZone) – (required)

Return type

com.vmware.nsx_policy.model_client.PolicyDnsForwarderZone

Returns

com.vmware.nsx_policy.model.PolicyDnsForwarderZone

Raise

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

Raise

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

Raise

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

Raise

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

Raise

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

class com.vmware.nsx_policy.infra_client.DnsSecurityProfiles(config)¶

Bases: vmware.vapi.bindings.stub.VapiInterface

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

delete(profile_id)¶

Delete DNS security profile

Parameters: profile_id (str) – (required)
Raise: com.vmware.vapi.std.errors_client.ServiceUnavailable Service Unavailable
Raise: com.vmware.vapi.std.errors_client.InvalidRequest Bad Request, Precondition Failed
Raise: com.vmware.vapi.std.errors_client.InternalServerError Internal Server Error
Raise: com.vmware.vapi.std.errors_client.Unauthorized Forbidden
Raise: com.vmware.vapi.std.errors_client.NotFound Not Found

get(profile_id)¶

Read the DNS Forwarder for the given tier-0 instance

Parameters: profile_id (str) – (required)
Return type: com.vmware.nsx_policy.model_client.DnsSecurityProfile
Returns: com.vmware.nsx_policy.model.DnsSecurityProfile
Raise: com.vmware.vapi.std.errors_client.ServiceUnavailable Service Unavailable
Raise: com.vmware.vapi.std.errors_client.InvalidRequest Bad Request, Precondition Failed
Raise: com.vmware.vapi.std.errors_client.InternalServerError Internal Server Error
Raise: com.vmware.vapi.std.errors_client.Unauthorized Forbidden
Raise: com.vmware.vapi.std.errors_client.NotFound Not Found

list(cursor=None, include_mark_for_delete_objects=None, included_fields=None, page_size=None, sort_ascending=None, sort_by=None)¶

List all DNS security profiles

Parameters

cursor (str or None) – Opaque cursor to be used for getting next page of records (supplied by current result page) (optional)
include_mark_for_delete_objects (bool or None) – Include objects that are marked for deletion in results (optional, default to false)
included_fields (str or None) – Comma separated list of fields that should be included in query result (optional)
page_size (long or None) – Maximum number of results to return in this page (server may return fewer) (optional, default to 1000)
sort_ascending (bool or None) – (optional)
sort_by (str or None) – Field by which records are sorted (optional)

Return type

com.vmware.nsx_policy.model_client.DnsSecurityProfileListResult

Returns

com.vmware.nsx_policy.model.DnsSecurityProfileListResult

Raise

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

Raise

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

Raise

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

Raise

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

Raise

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

patch(profile_id, dns_security_profile)¶

Create or update DNS security profile

Parameters

profile_id (str) – (required)
dns_security_profile (com.vmware.nsx_policy.model_client.DnsSecurityProfile) – (required)

Raise

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

Raise

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

Raise

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

Raise

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

Raise

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

update(profile_id, dns_security_profile)¶

Create or update DNS security profile

Parameters

profile_id (str) – (required)
dns_security_profile (com.vmware.nsx_policy.model_client.DnsSecurityProfile) – (required)

Return type

com.vmware.nsx_policy.model_client.DnsSecurityProfile

Returns

com.vmware.nsx_policy.model.DnsSecurityProfile

Raise

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

Raise

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

Raise

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

Raise

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

Raise

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

class com.vmware.nsx_policy.infra_client.Domains(config)¶

Bases: vmware.vapi.bindings.stub.VapiInterface

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

delete(domain_id)¶

Delete the domain along with all the entities contained by this domain. The groups that are a part of this domain are also deleted along with the domain.

Parameters: domain_id (str) – Domain ID (required)
Raise: com.vmware.vapi.std.errors_client.ServiceUnavailable Service Unavailable
Raise: com.vmware.vapi.std.errors_client.InvalidRequest Bad Request, Precondition Failed
Raise: com.vmware.vapi.std.errors_client.InternalServerError Internal Server Error
Raise: com.vmware.vapi.std.errors_client.Unauthorized Forbidden
Raise: com.vmware.vapi.std.errors_client.NotFound Not Found

get(domain_id)¶

Read a domain.

Parameters: domain_id (str) – Domain ID (required)
Return type: com.vmware.nsx_policy.model_client.Domain
Returns: com.vmware.nsx_policy.model.Domain
Raise: com.vmware.vapi.std.errors_client.ServiceUnavailable Service Unavailable
Raise: com.vmware.vapi.std.errors_client.InvalidRequest Bad Request, Precondition Failed
Raise: com.vmware.vapi.std.errors_client.InternalServerError Internal Server Error
Raise: com.vmware.vapi.std.errors_client.Unauthorized Forbidden
Raise: com.vmware.vapi.std.errors_client.NotFound Not Found

list(cursor=None, include_mark_for_delete_objects=None, included_fields=None, page_size=None, sort_ascending=None, sort_by=None)¶

Paginated list of all domains for infra.

Parameters

cursor (str or None) – Opaque cursor to be used for getting next page of records (supplied by current result page) (optional)
include_mark_for_delete_objects (bool or None) – Include objects that are marked for deletion in results (optional, default to false)
included_fields (str or None) – Comma separated list of fields that should be included in query result (optional)
page_size (long or None) – Maximum number of results to return in this page (server may return fewer) (optional, default to 1000)
sort_ascending (bool or None) – (optional)
sort_by (str or None) – Field by which records are sorted (optional)

Return type

com.vmware.nsx_policy.model_client.DomainListResult

Returns

com.vmware.nsx_policy.model.DomainListResult

Raise

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

Raise

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

Raise

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

Raise

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

Raise

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

patch(domain_id, domain)¶

If a domain with the domain-id is not already present, create a new domain. If it already exists, patch the domain

Parameters

domain_id (str) – Domain ID (required)
domain (com.vmware.nsx_policy.model_client.Domain) – (required)

Raise

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

Raise

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

Raise

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

Raise

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

Raise

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

update(domain_id, domain)¶

If a domain with the domain-id is not already present, create a new domain. If it already exists, update the domain including the nested groups. This is a full replace

Parameters

domain_id (str) – Domain ID (required)
domain (com.vmware.nsx_policy.model_client.Domain) – (required)

Return type

com.vmware.nsx_policy.model_client.Domain

Returns

com.vmware.nsx_policy.model.Domain

Raise

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

Raise

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

Raise

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

Raise

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

Raise

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

class com.vmware.nsx_policy.infra_client.Drafts(config)¶

Bases: vmware.vapi.bindings.stub.VapiInterface

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

abort(draft_id)¶

If there is a failure during publish, the admin can choose to abort the publishing attempts. This will bring back the system to the current configuration, i.e just before the publish was invoked. If draft publishing is not in progress or already completed, then this is a NO-OP

Parameters: draft_id (str) – (required)
Raise: com.vmware.vapi.std.errors_client.ServiceUnavailable Service Unavailable
Raise: com.vmware.vapi.std.errors_client.InvalidRequest Bad Request, Precondition Failed
Raise: com.vmware.vapi.std.errors_client.InternalServerError Internal Server Error
Raise: com.vmware.vapi.std.errors_client.Unauthorized Forbidden
Raise: com.vmware.vapi.std.errors_client.NotFound Not Found

delete(draft_id)¶

Delete a manual draft.

Parameters: draft_id (str) – (required)
Raise: com.vmware.vapi.std.errors_client.ServiceUnavailable Service Unavailable
Raise: com.vmware.vapi.std.errors_client.InvalidRequest Bad Request, Precondition Failed
Raise: com.vmware.vapi.std.errors_client.InternalServerError Internal Server Error
Raise: com.vmware.vapi.std.errors_client.Unauthorized Forbidden
Raise: com.vmware.vapi.std.errors_client.NotFound Not Found

get(draft_id)¶

Read a draft for a given draft identifier.

Parameters: draft_id (str) – (required)
Return type: com.vmware.nsx_policy.model_client.PolicyDraft
Returns: com.vmware.nsx_policy.model.PolicyDraft
Raise: com.vmware.vapi.std.errors_client.ServiceUnavailable Service Unavailable
Raise: com.vmware.vapi.std.errors_client.InvalidRequest Bad Request, Precondition Failed
Raise: com.vmware.vapi.std.errors_client.InternalServerError Internal Server Error
Raise: com.vmware.vapi.std.errors_client.Unauthorized Forbidden
Raise: com.vmware.vapi.std.errors_client.NotFound Not Found

list(auto_drafts=None, cursor=None, include_mark_for_delete_objects=None, included_fields=None, page_size=None, sort_ascending=None, sort_by=None)¶

List policy drafts.

Parameters

auto_drafts (bool or None) – Fetch list of draft based on is_auto_draft flag (optional)
cursor (str or None) – Opaque cursor to be used for getting next page of records (supplied by current result page) (optional)
include_mark_for_delete_objects (bool or None) – Include objects that are marked for deletion in results (optional, default to false)
included_fields (str or None) – Comma separated list of fields that should be included in query result (optional)
page_size (long or None) – Maximum number of results to return in this page (server may return fewer) (optional, default to 1000)
sort_ascending (bool or None) – (optional)
sort_by (str or None) – Field by which records are sorted (optional)

Return type

com.vmware.nsx_policy.model_client.PolicyDraftListResult

Returns

com.vmware.nsx_policy.model.PolicyDraftListResult

Raise

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

Raise

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

Raise

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

Raise

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

Raise

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

patch(draft_id, policy_draft)¶

Create a new manual draft if the specified draft id does not correspond to an existing draft. Update the manual draft otherwise. Auto draft can not be updated.

Parameters

draft_id (str) – (required)
policy_draft (com.vmware.nsx_policy.model_client.PolicyDraft) – (required)

Raise

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

Raise

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

Raise

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

Raise

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

Raise

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

publish(draft_id, infra)¶

Read a draft and publish it by applying changes onto current configuration.

Parameters

draft_id (str) – (required)
infra (com.vmware.nsx_policy.model_client.Infra) – (required)

Raise

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

Raise

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

Raise

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

Raise

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

Raise

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

update(draft_id, policy_draft)¶

Create a new manual draft if the specified draft id does not correspond to an existing draft. Update the manual draft otherwise. Auto draft can not be updated.

Parameters

draft_id (str) – (required)
policy_draft (com.vmware.nsx_policy.model_client.PolicyDraft) – (required)

Return type

com.vmware.nsx_policy.model_client.PolicyDraft

Returns

com.vmware.nsx_policy.model.PolicyDraft

Raise

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

Raise

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

Raise

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

Raise

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

Raise

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

class com.vmware.nsx_policy.infra_client.FirewallSessionTimerProfiles(config)¶

Bases: vmware.vapi.bindings.stub.VapiInterface

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

delete(firewall_session_timer_profile_id)¶

API will delete Firewall Session Timer Profile

Parameters: firewall_session_timer_profile_id (str) – Firewall Session Timer Profile ID (required)
Raise: com.vmware.vapi.std.errors_client.ServiceUnavailable Service Unavailable
Raise: com.vmware.vapi.std.errors_client.InvalidRequest Bad Request, Precondition Failed
Raise: com.vmware.vapi.std.errors_client.InternalServerError Internal Server Error
Raise: com.vmware.vapi.std.errors_client.Unauthorized Forbidden
Raise: com.vmware.vapi.std.errors_client.NotFound Not Found

get(firewall_session_timer_profile_id)¶

API will get Firewall Session Timer Profile

Parameters: firewall_session_timer_profile_id (str) – Firewall Session Timer Profile ID (required)
Return type: com.vmware.nsx_policy.model_client.PolicyFirewallSessionTimerProfile
Returns: com.vmware.nsx_policy.model.PolicyFirewallSessionTimerProfile
Raise: com.vmware.vapi.std.errors_client.ServiceUnavailable Service Unavailable
Raise: com.vmware.vapi.std.errors_client.InvalidRequest Bad Request, Precondition Failed
Raise: com.vmware.vapi.std.errors_client.InternalServerError Internal Server Error
Raise: com.vmware.vapi.std.errors_client.Unauthorized Forbidden
Raise: com.vmware.vapi.std.errors_client.NotFound Not Found

list(cursor=None, include_mark_for_delete_objects=None, included_fields=None, page_size=None, sort_ascending=None, sort_by=None)¶

API will list all Firewall Session Timer Profiles

Parameters

cursor (str or None) – Opaque cursor to be used for getting next page of records (supplied by current result page) (optional)
include_mark_for_delete_objects (bool or None) – Include objects that are marked for deletion in results (optional, default to false)
included_fields (str or None) – Comma separated list of fields that should be included in query result (optional)
page_size (long or None) – Maximum number of results to return in this page (server may return fewer) (optional, default to 1000)
sort_ascending (bool or None) – (optional)
sort_by (str or None) – Field by which records are sorted (optional)

Return type

com.vmware.nsx_policy.model_client.PolicyFirewallSessionTimerProfileListResult

Returns

com.vmware.nsx_policy.model.PolicyFirewallSessionTimerProfileListResult

Raise

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

Raise

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

Raise

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

Raise

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

Raise

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

patch(firewall_session_timer_profile_id, policy_firewall_session_timer_profile)¶

API will create/update Firewall Session Timer Profile

Parameters

firewall_session_timer_profile_id (str) – Firewall Session Timer Profile ID (required)
policy_firewall_session_timer_profile (com.vmware.nsx_policy.model_client.PolicyFirewallSessionTimerProfile) – (required)

Raise

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

Raise

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

Raise

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

Raise

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

Raise

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

update(firewall_session_timer_profile_id, policy_firewall_session_timer_profile)¶

API will update Firewall Session Timer Profile

Parameters

firewall_session_timer_profile_id (str) – Firewall Session Timer Profile ID (required)
policy_firewall_session_timer_profile (com.vmware.nsx_policy.model_client.PolicyFirewallSessionTimerProfile) – (required)

Return type

com.vmware.nsx_policy.model_client.PolicyFirewallSessionTimerProfile

Returns

com.vmware.nsx_policy.model.PolicyFirewallSessionTimerProfile

Raise

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

Raise

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

Raise

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

Raise

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

Raise

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

class com.vmware.nsx_policy.infra_client.FloodProtectionProfiles(config)¶

Bases: vmware.vapi.bindings.stub.VapiInterface

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

delete(flood_protection_profile_id)¶

API will delete Flood Protection Profile

Parameters: flood_protection_profile_id (str) – Flood Protection Profile ID (required)
Raise: com.vmware.vapi.std.errors_client.ServiceUnavailable Service Unavailable
Raise: com.vmware.vapi.std.errors_client.InvalidRequest Bad Request, Precondition Failed
Raise: com.vmware.vapi.std.errors_client.InternalServerError Internal Server Error
Raise: com.vmware.vapi.std.errors_client.Unauthorized Forbidden
Raise: com.vmware.vapi.std.errors_client.NotFound Not Found

get(flood_protection_profile_id)¶

API will get Flood Protection Profile

Parameters: flood_protection_profile_id (str) – Flood Protection Profile ID (required)
Return type: vmware.vapi.struct.VapiStruct
Returns: com.vmware.nsx_policy.model.FloodProtectionProfile The return value will contain all the attributes defined in com.vmware.nsx_policy.model_client.FloodProtectionProfile.
Raise: com.vmware.vapi.std.errors_client.ServiceUnavailable Service Unavailable
Raise: com.vmware.vapi.std.errors_client.InvalidRequest Bad Request, Precondition Failed
Raise: com.vmware.vapi.std.errors_client.InternalServerError Internal Server Error
Raise: com.vmware.vapi.std.errors_client.Unauthorized Forbidden
Raise: com.vmware.vapi.std.errors_client.NotFound Not Found

list(cursor=None, include_mark_for_delete_objects=None, included_fields=None, page_size=None, sort_ascending=None, sort_by=None)¶

API will list all Flood Protection Profiles

Parameters

cursor (str or None) – Opaque cursor to be used for getting next page of records (supplied by current result page) (optional)
include_mark_for_delete_objects (bool or None) – Include objects that are marked for deletion in results (optional, default to false)
included_fields (str or None) – Comma separated list of fields that should be included in query result (optional)
page_size (long or None) – Maximum number of results to return in this page (server may return fewer) (optional, default to 1000)
sort_ascending (bool or None) – (optional)
sort_by (str or None) – Field by which records are sorted (optional)

Return type

com.vmware.nsx_policy.model_client.FloodProtectionProfileListResult

Returns

com.vmware.nsx_policy.model.FloodProtectionProfileListResult

Raise

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

Raise

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

Raise

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

Raise

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

Raise

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

patch(flood_protection_profile_id, flood_protection_profile)¶

API will create/update Flood Protection Profile

Parameters

flood_protection_profile_id (str) – Firewall Flood Protection Profile ID (required)
flood_protection_profile (vmware.vapi.struct.VapiStruct) – (required) The parameter must contain all the attributes defined in com.vmware.nsx_policy.model_client.FloodProtectionProfile.

Raise

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

Raise

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

Raise

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

Raise

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

Raise

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

update(flood_protection_profile_id, flood_protection_profile)¶

API will update Firewall Flood Protection Profile

Parameters

flood_protection_profile_id (str) – Flood Protection Profile ID (required)
flood_protection_profile (vmware.vapi.struct.VapiStruct) – (required) The parameter must contain all the attributes defined in com.vmware.nsx_policy.model_client.FloodProtectionProfile.

Return type

vmware.vapi.struct.VapiStruct

Returns

com.vmware.nsx_policy.model.FloodProtectionProfile The return value will contain all the attributes defined in com.vmware.nsx_policy.model_client.FloodProtectionProfile.

Raise

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

Raise

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

Raise

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

Raise

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

Raise

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

class com.vmware.nsx_policy.infra_client.GlobalConfig(config)¶

Bases: vmware.vapi.bindings.stub.VapiInterface

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

get()¶

Read global configuration

Return type: com.vmware.nsx_policy.model_client.GlobalConfig
Returns: com.vmware.nsx_policy.model.GlobalConfig
Raise: com.vmware.vapi.std.errors_client.ServiceUnavailable Service Unavailable
Raise: com.vmware.vapi.std.errors_client.InvalidRequest Bad Request, Precondition Failed
Raise: com.vmware.vapi.std.errors_client.InternalServerError Internal Server Error
Raise: com.vmware.vapi.std.errors_client.Unauthorized Forbidden
Raise: com.vmware.vapi.std.errors_client.NotFound Not Found

patch(global_config)¶

Update the global configuration

Parameters: global_config (com.vmware.nsx_policy.model_client.GlobalConfig) – (required)
Raise: com.vmware.vapi.std.errors_client.ServiceUnavailable Service Unavailable
Raise: com.vmware.vapi.std.errors_client.InvalidRequest Bad Request, Precondition Failed
Raise: com.vmware.vapi.std.errors_client.InternalServerError Internal Server Error
Raise: com.vmware.vapi.std.errors_client.Unauthorized Forbidden
Raise: com.vmware.vapi.std.errors_client.NotFound Not Found

update(global_config)¶

Update the global configuration

Parameters: global_config (com.vmware.nsx_policy.model_client.GlobalConfig) – (required)
Return type: com.vmware.nsx_policy.model_client.GlobalConfig
Returns: com.vmware.nsx_policy.model.GlobalConfig
Raise: com.vmware.vapi.std.errors_client.ServiceUnavailable Service Unavailable
Raise: com.vmware.vapi.std.errors_client.InvalidRequest Bad Request, Precondition Failed
Raise: com.vmware.vapi.std.errors_client.InternalServerError Internal Server Error
Raise: com.vmware.vapi.std.errors_client.Unauthorized Forbidden
Raise: com.vmware.vapi.std.errors_client.NotFound Not Found

class com.vmware.nsx_policy.infra_client.GroupAssociations(config)¶

Bases: vmware.vapi.bindings.stub.VapiInterface

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

list(intent_path, cursor=None, enforcement_point_path=None, include_mark_for_delete_objects=None, included_fields=None, page_size=None, sort_ascending=None, sort_by=None)¶

Get policy groups for which the given object is a member.

Parameters

intent_path (str) – String path of the intent object (required)
cursor (str or None) – Opaque cursor to be used for getting next page of records (supplied by current result page) (optional)
enforcement_point_path (str or None) – String Path of the enforcement point (optional)
include_mark_for_delete_objects (bool or None) – Include objects that are marked for deletion in results (optional, default to false)
included_fields (str or None) – Comma separated list of fields that should be included in query result (optional)
page_size (long or None) – Maximum number of results to return in this page (server may return fewer) (optional, default to 1000)
sort_ascending (bool or None) – (optional)
sort_by (str or None) – Field by which records are sorted (optional)

Return type

com.vmware.nsx_policy.model_client.PolicyResourceReferenceForEPListResult

Returns

com.vmware.nsx_policy.model.PolicyResourceReferenceForEPListResult

Raise

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

Raise

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

Raise

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

Raise

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

Raise

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

class com.vmware.nsx_policy.infra_client.IpBlocks(config)¶

Bases: vmware.vapi.bindings.stub.VapiInterface

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

delete(ip_block_id)¶

Delete the IpAddressBlock with the given id.

Parameters: ip_block_id (str) – (required)
Raise: com.vmware.vapi.std.errors_client.ServiceUnavailable Service Unavailable
Raise: com.vmware.vapi.std.errors_client.InvalidRequest Bad Request, Precondition Failed
Raise: com.vmware.vapi.std.errors_client.InternalServerError Internal Server Error
Raise: com.vmware.vapi.std.errors_client.Unauthorized Forbidden
Raise: com.vmware.vapi.std.errors_client.NotFound Not Found

get(ip_block_id)¶

Read IpAddressBlock with given Id.

Parameters: ip_block_id (str) – (required)
Return type: com.vmware.nsx_policy.model_client.IpAddressBlock
Returns: com.vmware.nsx_policy.model.IpAddressBlock
Raise: com.vmware.vapi.std.errors_client.ServiceUnavailable Service Unavailable
Raise: com.vmware.vapi.std.errors_client.InvalidRequest Bad Request, Precondition Failed
Raise: com.vmware.vapi.std.errors_client.InternalServerError Internal Server Error
Raise: com.vmware.vapi.std.errors_client.Unauthorized Forbidden
Raise: com.vmware.vapi.std.errors_client.NotFound Not Found

list(cursor=None, include_mark_for_delete_objects=None, included_fields=None, page_size=None, sort_ascending=None, sort_by=None)¶

Paginated list of IpAddressBlocks.

Parameters

cursor (str or None) – Opaque cursor to be used for getting next page of records (supplied by current result page) (optional)
include_mark_for_delete_objects (bool or None) – Include objects that are marked for deletion in results (optional, default to false)
included_fields (str or None) – Comma separated list of fields that should be included in query result (optional)
page_size (long or None) – Maximum number of results to return in this page (server may return fewer) (optional, default to 1000)
sort_ascending (bool or None) – (optional)
sort_by (str or None) – Field by which records are sorted (optional)

Return type

com.vmware.nsx_policy.model_client.IpAddressBlockListResult

Returns

com.vmware.nsx_policy.model.IpAddressBlockListResult

Raise

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

Raise

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

Raise

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

Raise

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

Raise

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

patch(ip_block_id, ip_address_block)¶

Creates a new IpAddressBlock with specified ID if not already present. If IpAddressBlock of given ID is already present, then the instance is updated with specified attributes.

Parameters

ip_block_id (str) – (required)
ip_address_block (com.vmware.nsx_policy.model_client.IpAddressBlock) – (required)

Raise

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

Raise

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

Raise

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

Raise

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

Raise

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

update(ip_block_id, ip_address_block)¶

Create a new IpAddressBlock with given ID if it does not exist. If IpAddressBlock with given ID already exists, it will update existing instance. This is a full replace.

Parameters

ip_block_id (str) – (required)
ip_address_block (com.vmware.nsx_policy.model_client.IpAddressBlock) – (required)

Return type

com.vmware.nsx_policy.model_client.IpAddressBlock

Returns

com.vmware.nsx_policy.model.IpAddressBlock

Raise

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

Raise

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

Raise

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

Raise

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

Raise

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

class com.vmware.nsx_policy.infra_client.IpDiscoveryProfiles(config)¶

Bases: vmware.vapi.bindings.stub.VapiInterface

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

delete(ip_discovery_profile_id)¶

API will delete IP Discovery profile.

Parameters: ip_discovery_profile_id (str) – IP Discovery Profile ID (required)
Raise: com.vmware.vapi.std.errors_client.ServiceUnavailable Service Unavailable
Raise: com.vmware.vapi.std.errors_client.InvalidRequest Bad Request, Precondition Failed
Raise: com.vmware.vapi.std.errors_client.InternalServerError Internal Server Error
Raise: com.vmware.vapi.std.errors_client.Unauthorized Forbidden
Raise: com.vmware.vapi.std.errors_client.NotFound Not Found

get(ip_discovery_profile_id)¶

API will get IP Discovery profile.

Parameters: ip_discovery_profile_id (str) – IP Discovery Profile ID (required)
Return type: com.vmware.nsx_policy.model_client.IPDiscoveryProfile
Returns: com.vmware.nsx_policy.model.IPDiscoveryProfile
Raise: com.vmware.vapi.std.errors_client.ServiceUnavailable Service Unavailable
Raise: com.vmware.vapi.std.errors_client.InvalidRequest Bad Request, Precondition Failed
Raise: com.vmware.vapi.std.errors_client.InternalServerError Internal Server Error
Raise: com.vmware.vapi.std.errors_client.Unauthorized Forbidden
Raise: com.vmware.vapi.std.errors_client.NotFound Not Found

list(cursor=None, include_mark_for_delete_objects=None, included_fields=None, page_size=None, sort_ascending=None, sort_by=None)¶

API will list all IP Discovery Profiles active in current discovery profile id.

Parameters

cursor (str or None) – Opaque cursor to be used for getting next page of records (supplied by current result page) (optional)
include_mark_for_delete_objects (bool or None) – Include objects that are marked for deletion in results (optional, default to false)
included_fields (str or None) – Comma separated list of fields that should be included in query result (optional)
page_size (long or None) – Maximum number of results to return in this page (server may return fewer) (optional, default to 1000)
sort_ascending (bool or None) – (optional)
sort_by (str or None) – Field by which records are sorted (optional)

Return type

com.vmware.nsx_policy.model_client.IPDiscoveryProfileListResult

Returns

com.vmware.nsx_policy.model.IPDiscoveryProfileListResult

Raise

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

Raise

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

Raise

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

Raise

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

Raise

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

patch(ip_discovery_profile_id, ip_discovery_profile)¶

API will create IP Discovery profile.

Parameters

ip_discovery_profile_id (str) – IP Discovery Profile ID (required)
ip_discovery_profile (com.vmware.nsx_policy.model_client.IPDiscoveryProfile) – (required)

Raise

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

Raise

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

Raise

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

Raise

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

Raise

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

update(ip_discovery_profile_id, ip_discovery_profile)¶

API will update IP Discovery profile.

Parameters

ip_discovery_profile_id (str) – IP Discovery Profile ID (required)
ip_discovery_profile (com.vmware.nsx_policy.model_client.IPDiscoveryProfile) – (required)

Return type

com.vmware.nsx_policy.model_client.IPDiscoveryProfile

Returns

com.vmware.nsx_policy.model.IPDiscoveryProfile

Raise

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

Raise

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

Raise

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

Raise

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

Raise

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

class com.vmware.nsx_policy.infra_client.IpPools(config)¶

Bases: vmware.vapi.bindings.stub.VapiInterface

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

delete(ip_pool_id)¶

Delete the IpAddressPool with the given id.

Parameters: ip_pool_id (str) – (required)
Raise: com.vmware.vapi.std.errors_client.ServiceUnavailable Service Unavailable
Raise: com.vmware.vapi.std.errors_client.InvalidRequest Bad Request, Precondition Failed
Raise: com.vmware.vapi.std.errors_client.InternalServerError Internal Server Error
Raise: com.vmware.vapi.std.errors_client.Unauthorized Forbidden
Raise: com.vmware.vapi.std.errors_client.NotFound Not Found

get(ip_pool_id)¶

Read IpAddressPool with given Id.

Parameters: ip_pool_id (str) – (required)
Return type: com.vmware.nsx_policy.model_client.IpAddressPool
Returns: com.vmware.nsx_policy.model.IpAddressPool
Raise: com.vmware.vapi.std.errors_client.ServiceUnavailable Service Unavailable
Raise: com.vmware.vapi.std.errors_client.InvalidRequest Bad Request, Precondition Failed
Raise: com.vmware.vapi.std.errors_client.InternalServerError Internal Server Error
Raise: com.vmware.vapi.std.errors_client.Unauthorized Forbidden
Raise: com.vmware.vapi.std.errors_client.NotFound Not Found

list(cursor=None, include_mark_for_delete_objects=None, included_fields=None, page_size=None, sort_ascending=None, sort_by=None)¶

Paginated list of IpAddressPools.

Parameters

cursor (str or None) – Opaque cursor to be used for getting next page of records (supplied by current result page) (optional)
include_mark_for_delete_objects (bool or None) – Include objects that are marked for deletion in results (optional, default to false)
included_fields (str or None) – Comma separated list of fields that should be included in query result (optional)
page_size (long or None) – Maximum number of results to return in this page (server may return fewer) (optional, default to 1000)
sort_ascending (bool or None) – (optional)
sort_by (str or None) – Field by which records are sorted (optional)

Return type

com.vmware.nsx_policy.model_client.IpAddressPoolListResult

Returns

com.vmware.nsx_policy.model.IpAddressPoolListResult

Raise

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

Raise

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

Raise

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

Raise

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

Raise

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

patch(ip_pool_id, ip_address_pool)¶

Creates a new IpAddressPool with specified ID if not already present. If IpAddressPool of given ID is already present, then the instance is updated. This is a full replace.

Parameters

ip_pool_id (str) – (required)
ip_address_pool (com.vmware.nsx_policy.model_client.IpAddressPool) – (required)

Raise

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

Raise

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

Raise

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

Raise

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

Raise

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

update(ip_pool_id, ip_address_pool)¶

Create a new IpAddressPool with given ID if it does not exist. If IpAddressPool with given ID already exists, it will update existing instance. This is a full replace.

Parameters

ip_pool_id (str) – (required)
ip_address_pool (com.vmware.nsx_policy.model_client.IpAddressPool) – (required)

Return type

com.vmware.nsx_policy.model_client.IpAddressPool

Returns

com.vmware.nsx_policy.model.IpAddressPool

Raise

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

Raise

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

Raise

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

Raise

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

Raise

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

class com.vmware.nsx_policy.infra_client.IpfixCollectorProfiles(config)¶

Bases: vmware.vapi.bindings.stub.VapiInterface

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

delete(ipfix_collector_profile_id)¶

API deletes IPFIX collector profile. Flow forwarding to collector will be stopped. This API is deprecated. Please use the following API: https://<policy-mgr>/policy/api/v1/infra/ipfix-l2-collector-profiles

Parameters: ipfix_collector_profile_id (str) – IPFIX collector Profile id (required)
Raise: com.vmware.vapi.std.errors_client.ServiceUnavailable Service Unavailable
Raise: com.vmware.vapi.std.errors_client.InvalidRequest Bad Request, Precondition Failed
Raise: com.vmware.vapi.std.errors_client.InternalServerError Internal Server Error
Raise: com.vmware.vapi.std.errors_client.Unauthorized Forbidden
Raise: com.vmware.vapi.std.errors_client.NotFound Not Found

get(ipfix_collector_profile_id)¶

API will return details of IPFIX collector profile. If profile does not exist, it will return 404. This API is deprecated. Please use the following API: https://<policy-mgr>/policy/api/v1/infra/ipfix-l2-collector-profiles

Parameters: ipfix_collector_profile_id (str) – IPFIX collector profile id (required)
Return type: com.vmware.nsx_policy.model_client.IPFIXCollectorProfile
Returns: com.vmware.nsx_policy.model.IPFIXCollectorProfile
Raise: com.vmware.vapi.std.errors_client.ServiceUnavailable Service Unavailable
Raise: com.vmware.vapi.std.errors_client.InvalidRequest Bad Request, Precondition Failed
Raise: com.vmware.vapi.std.errors_client.InternalServerError Internal Server Error
Raise: com.vmware.vapi.std.errors_client.Unauthorized Forbidden
Raise: com.vmware.vapi.std.errors_client.NotFound Not Found

list(cursor=None, include_mark_for_delete_objects=None, included_fields=None, page_size=None, sort_ascending=None, sort_by=None)¶

API will provide list of all IPFIX collector profiles and their details. This API is deprecated. Please use the following API: https://<policy-mgr>/policy/api/v1/infra/ipfix-l2-collector-profiles

Parameters

cursor (str or None) – Opaque cursor to be used for getting next page of records (supplied by current result page) (optional)
include_mark_for_delete_objects (bool or None) – Include objects that are marked for deletion in results (optional, default to false)
included_fields (str or None) – Comma separated list of fields that should be included in query result (optional)
page_size (long or None) – Maximum number of results to return in this page (server may return fewer) (optional, default to 1000)
sort_ascending (bool or None) – (optional)
sort_by (str or None) – Field by which records are sorted (optional)

Return type

com.vmware.nsx_policy.model_client.IPFIXCollectorProfileListResult

Returns

com.vmware.nsx_policy.model.IPFIXCollectorProfileListResult

Raise

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

Raise

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

Raise

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

Raise

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

Raise

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

patch(ipfix_collector_profile_id, i_pfix_collector_profile)¶

Create a new IPFIX collector profile if the IPFIX collector profile with given id does not already exist. If the IPFIX collector profile with the given id already exists, patch with the existing IPFIX collector profile. This API is deprecated. Please use the following API: https://<policy-mgr>/policy/api/v1/infra/ipfix-l2-collector-profiles

Parameters

ipfix_collector_profile_id (str) – IPFIX collector profile id (required)
i_pfix_collector_profile (com.vmware.nsx_policy.model_client.IPFIXCollectorProfile) – (required)

Raise

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

Raise

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

Raise

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

Raise

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

Raise

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

update(ipfix_collector_profile_id, i_pfix_collector_profile)¶

Create or Replace IPFIX collector profile. IPFIX data will be sent to IPFIX collector port. This API is deprecated. Please use the following API: https://<policy-mgr>/policy/api/v1/infra/ipfix-l2-collector-profiles

Parameters

ipfix_collector_profile_id (str) – IPFIX collector profile id (required)
i_pfix_collector_profile (com.vmware.nsx_policy.model_client.IPFIXCollectorProfile) – (required)

Return type

com.vmware.nsx_policy.model_client.IPFIXCollectorProfile

Returns

com.vmware.nsx_policy.model.IPFIXCollectorProfile

Raise

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

Raise

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

Raise

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

Raise

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

Raise

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

class com.vmware.nsx_policy.infra_client.IpfixDfwCollectorProfiles(config)¶

Bases: vmware.vapi.bindings.stub.VapiInterface

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

delete(ipfix_dfw_collector_profile_id)¶

API deletes IPFIX dfw collector profile. Flow forwarding to collector will be stopped.

Parameters: ipfix_dfw_collector_profile_id (str) – IPFIX dfw collector Profile id (required)
Raise: com.vmware.vapi.std.errors_client.ServiceUnavailable Service Unavailable
Raise: com.vmware.vapi.std.errors_client.InvalidRequest Bad Request, Precondition Failed
Raise: com.vmware.vapi.std.errors_client.InternalServerError Internal Server Error
Raise: com.vmware.vapi.std.errors_client.Unauthorized Forbidden
Raise: com.vmware.vapi.std.errors_client.NotFound Not Found

get(ipfix_dfw_collector_profile_id)¶

API will return details of IPFIX dfw collector profile. If profile does not exist, it will return 404.

Parameters: ipfix_dfw_collector_profile_id (str) – IPFIX dfw collector profile id (required)
Return type: com.vmware.nsx_policy.model_client.IPFIXDFWCollectorProfile
Returns: com.vmware.nsx_policy.model.IPFIXDFWCollectorProfile
Raise: com.vmware.vapi.std.errors_client.ServiceUnavailable Service Unavailable
Raise: com.vmware.vapi.std.errors_client.InvalidRequest Bad Request, Precondition Failed
Raise: com.vmware.vapi.std.errors_client.InternalServerError Internal Server Error
Raise: com.vmware.vapi.std.errors_client.Unauthorized Forbidden
Raise: com.vmware.vapi.std.errors_client.NotFound Not Found

list(cursor=None, include_mark_for_delete_objects=None, included_fields=None, page_size=None, sort_ascending=None, sort_by=None)¶

API will provide list of all IPFIX dfw collector profiles and their details.

Parameters

cursor (str or None) – Opaque cursor to be used for getting next page of records (supplied by current result page) (optional)
include_mark_for_delete_objects (bool or None) – Include objects that are marked for deletion in results (optional, default to false)
included_fields (str or None) – Comma separated list of fields that should be included in query result (optional)
page_size (long or None) – Maximum number of results to return in this page (server may return fewer) (optional, default to 1000)
sort_ascending (bool or None) – (optional)
sort_by (str or None) – Field by which records are sorted (optional)

Return type

com.vmware.nsx_policy.model_client.IPFIXDFWCollectorProfileListResult

Returns

com.vmware.nsx_policy.model.IPFIXDFWCollectorProfileListResult

Raise

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

Raise

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

Raise

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

Raise

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

Raise

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

patch(ipfix_dfw_collector_profile_id, i_pfixdfw_collector_profile)¶

Create a new IPFIX dfw collector profile if the IPFIX dfw collector profile with given id does not already exist. If the IPFIX dfw collector profile with the given id already exists, patch with the existing IPFIX dfw collector profile.

Parameters

ipfix_dfw_collector_profile_id (str) – (required)
i_pfixdfw_collector_profile (com.vmware.nsx_policy.model_client.IPFIXDFWCollectorProfile) – (required)

Raise

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

Raise

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

Raise

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

Raise

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

Raise

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

update(ipfix_dfw_collector_profile_id, i_pfixdfw_collector_profile)¶

Create or Replace IPFIX dfw collector profile. IPFIX data will be sent to IPFIX collector port.

Parameters

ipfix_dfw_collector_profile_id (str) – IPFIX dfw collector profile id (required)
i_pfixdfw_collector_profile (com.vmware.nsx_policy.model_client.IPFIXDFWCollectorProfile) – (required)

Return type

com.vmware.nsx_policy.model_client.IPFIXDFWCollectorProfile

Returns

com.vmware.nsx_policy.model.IPFIXDFWCollectorProfile

Raise

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

Raise

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

Raise

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

Raise

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

Raise

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

class com.vmware.nsx_policy.infra_client.IpfixDfwProfiles(config)¶

Bases: vmware.vapi.bindings.stub.VapiInterface

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

delete(ipfix_dfw_profile_id)¶

API deletes IPFIX DFW Profile. Selected IPFIX Collectors will stop receiving flows.

Parameters: ipfix_dfw_profile_id (str) – IPFIX DFW Profile ID (required)
Raise: com.vmware.vapi.std.errors_client.ServiceUnavailable Service Unavailable
Raise: com.vmware.vapi.std.errors_client.InvalidRequest Bad Request, Precondition Failed
Raise: com.vmware.vapi.std.errors_client.InternalServerError Internal Server Error
Raise: com.vmware.vapi.std.errors_client.Unauthorized Forbidden
Raise: com.vmware.vapi.std.errors_client.NotFound Not Found

get(ipfix_dfw_profile_id)¶

API will return details of IPFIX DFW profile.

Parameters: ipfix_dfw_profile_id (str) – IPFIX DFW collection id (required)
Return type: com.vmware.nsx_policy.model_client.IPFIXDFWProfile
Returns: com.vmware.nsx_policy.model.IPFIXDFWProfile
Raise: com.vmware.vapi.std.errors_client.ServiceUnavailable Service Unavailable
Raise: com.vmware.vapi.std.errors_client.InvalidRequest Bad Request, Precondition Failed
Raise: com.vmware.vapi.std.errors_client.InternalServerError Internal Server Error
Raise: com.vmware.vapi.std.errors_client.Unauthorized Forbidden
Raise: com.vmware.vapi.std.errors_client.NotFound Not Found

list(cursor=None, include_mark_for_delete_objects=None, included_fields=None, page_size=None, sort_ascending=None, sort_by=None)¶

API provides list IPFIX DFW profiles available on selected logical DFW.

Parameters

cursor (str or None) – Opaque cursor to be used for getting next page of records (supplied by current result page) (optional)
include_mark_for_delete_objects (bool or None) – Include objects that are marked for deletion in results (optional, default to false)
included_fields (str or None) – Comma separated list of fields that should be included in query result (optional)
page_size (long or None) – Maximum number of results to return in this page (server may return fewer) (optional, default to 1000)
sort_ascending (bool or None) – (optional)
sort_by (str or None) – Field by which records are sorted (optional)

Return type

com.vmware.nsx_policy.model_client.IPFIXDFWProfileListResult

Returns

com.vmware.nsx_policy.model.IPFIXDFWProfileListResult

Raise

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

Raise

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

Raise

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

Raise

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

Raise

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

patch(ipfix_dfw_profile_id, i_pfixdfw_profile)¶

Create a new IPFIX DFW profile if the IPFIX DFW profile with given id does not already exist. If the IPFIX DFW profile with the given id already exists, patch with the existing IPFIX DFW profile.

Parameters

ipfix_dfw_profile_id (str) – IPFIX DFW Profile ID (required)
i_pfixdfw_profile (com.vmware.nsx_policy.model_client.IPFIXDFWProfile) – (required)

Raise

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

Raise

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

Raise

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

Raise

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

Raise

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

update(ipfix_dfw_profile_id, i_pfixdfw_profile)¶

Create or replace IPFIX DFW profile. Config will start forwarding data to provided IPFIX DFW collector.

Parameters

ipfix_dfw_profile_id (str) – IPFIX DFW Profile ID (required)
i_pfixdfw_profile (com.vmware.nsx_policy.model_client.IPFIXDFWProfile) – (required)

Return type

com.vmware.nsx_policy.model_client.IPFIXDFWProfile

Returns

com.vmware.nsx_policy.model.IPFIXDFWProfile

Raise

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

Raise

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

Raise

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

Raise

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

Raise

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

class com.vmware.nsx_policy.infra_client.IpfixL2CollectorProfiles(config)¶

Bases: vmware.vapi.bindings.stub.VapiInterface

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

delete(ipfix_l2_collector_profile_id)¶

API deletes IPFIX collector profile. Flow forwarding to collector will be stopped.

Parameters: ipfix_l2_collector_profile_id (str) – IPFIX collector Profile id (required)
Raise: com.vmware.vapi.std.errors_client.ServiceUnavailable Service Unavailable
Raise: com.vmware.vapi.std.errors_client.InvalidRequest Bad Request, Precondition Failed
Raise: com.vmware.vapi.std.errors_client.InternalServerError Internal Server Error
Raise: com.vmware.vapi.std.errors_client.Unauthorized Forbidden
Raise: com.vmware.vapi.std.errors_client.NotFound Not Found

get(ipfix_l2_collector_profile_id)¶

API will return details of IPFIX collector profile.

Parameters: ipfix_l2_collector_profile_id (str) – IPFIX collector profile id (required)
Return type: com.vmware.nsx_policy.model_client.IPFIXL2CollectorProfile
Returns: com.vmware.nsx_policy.model.IPFIXL2CollectorProfile
Raise: com.vmware.vapi.std.errors_client.ServiceUnavailable Service Unavailable
Raise: com.vmware.vapi.std.errors_client.InvalidRequest Bad Request, Precondition Failed
Raise: com.vmware.vapi.std.errors_client.InternalServerError Internal Server Error
Raise: com.vmware.vapi.std.errors_client.Unauthorized Forbidden
Raise: com.vmware.vapi.std.errors_client.NotFound Not Found

list(cursor=None, include_mark_for_delete_objects=None, included_fields=None, page_size=None, sort_ascending=None, sort_by=None)¶

API will provide list of all IPFIX collector profiles and their details.

Parameters

cursor (str or None) – Opaque cursor to be used for getting next page of records (supplied by current result page) (optional)
include_mark_for_delete_objects (bool or None) – Include objects that are marked for deletion in results (optional, default to false)
included_fields (str or None) – Comma separated list of fields that should be included in query result (optional)
page_size (long or None) – Maximum number of results to return in this page (server may return fewer) (optional, default to 1000)
sort_ascending (bool or None) – (optional)
sort_by (str or None) – Field by which records are sorted (optional)

Return type

com.vmware.nsx_policy.model_client.IPFIXL2CollectorProfileListResult

Returns

com.vmware.nsx_policy.model.IPFIXL2CollectorProfileListResult

Raise

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

Raise

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

Raise

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

Raise

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

Raise

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

patch(ipfix_l2_collector_profile_id, i_pfix_l2_collector_profile)¶

Create a new IPFIX collector profile if the IPFIX collector profile with given id does not already exist. If the IPFIX collector profile with the given id already exists, patch with the existing IPFIX collector profile.

Parameters

ipfix_l2_collector_profile_id (str) – IPFIX collector profile id (required)
i_pfix_l2_collector_profile (com.vmware.nsx_policy.model_client.IPFIXL2CollectorProfile) – (required)

Raise

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

Raise

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

Raise

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

Raise

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

Raise

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

update(ipfix_l2_collector_profile_id, i_pfix_l2_collector_profile)¶

Create or Replace IPFIX collector profile. IPFIX data will be sent to IPFIX collector.

Parameters

ipfix_l2_collector_profile_id (str) – IPFIX collector profile id (required)
i_pfix_l2_collector_profile (com.vmware.nsx_policy.model_client.IPFIXL2CollectorProfile) – (required)

Return type

com.vmware.nsx_policy.model_client.IPFIXL2CollectorProfile

Returns

com.vmware.nsx_policy.model.IPFIXL2CollectorProfile

Raise

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

Raise

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

Raise

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

Raise

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

Raise

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

class com.vmware.nsx_policy.infra_client.IpfixL2Profiles(config)¶

Bases: vmware.vapi.bindings.stub.VapiInterface

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

delete(ipfix_l2_profile_id)¶

API deletes IPFIX L2 Profile. Flow forwarding to selected collector will be stopped.

Parameters: ipfix_l2_profile_id (str) – IPFIX L2 Profile ID (required)
Raise: com.vmware.vapi.std.errors_client.ServiceUnavailable Service Unavailable
Raise: com.vmware.vapi.std.errors_client.InvalidRequest Bad Request, Precondition Failed
Raise: com.vmware.vapi.std.errors_client.InternalServerError Internal Server Error
Raise: com.vmware.vapi.std.errors_client.Unauthorized Forbidden
Raise: com.vmware.vapi.std.errors_client.NotFound Not Found

get(ipfix_l2_profile_id)¶

API will return details of IPFIX L2 profile.

Parameters: ipfix_l2_profile_id (str) – IPFIX L2 profile id (required)
Return type: com.vmware.nsx_policy.model_client.IPFIXL2Profile
Returns: com.vmware.nsx_policy.model.IPFIXL2Profile
Raise: com.vmware.vapi.std.errors_client.ServiceUnavailable Service Unavailable
Raise: com.vmware.vapi.std.errors_client.InvalidRequest Bad Request, Precondition Failed
Raise: com.vmware.vapi.std.errors_client.InternalServerError Internal Server Error
Raise: com.vmware.vapi.std.errors_client.Unauthorized Forbidden
Raise: com.vmware.vapi.std.errors_client.NotFound Not Found

list(cursor=None, include_mark_for_delete_objects=None, included_fields=None, page_size=None, sort_ascending=None, sort_by=None)¶

API provides list IPFIX L2 Profiles available on selected logical l2.

Parameters

cursor (str or None) – Opaque cursor to be used for getting next page of records (supplied by current result page) (optional)
include_mark_for_delete_objects (bool or None) – Include objects that are marked for deletion in results (optional, default to false)
included_fields (str or None) – Comma separated list of fields that should be included in query result (optional)
page_size (long or None) – Maximum number of results to return in this page (server may return fewer) (optional, default to 1000)
sort_ascending (bool or None) – (optional)
sort_by (str or None) – Field by which records are sorted (optional)

Return type

com.vmware.nsx_policy.model_client.IPFIXL2ProfileListResult

Returns

com.vmware.nsx_policy.model.IPFIXL2ProfileListResult

Raise

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

Raise

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

Raise

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

Raise

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

Raise

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

patch(ipfix_l2_profile_id, i_pfix_l2_profile)¶

Create a new IPFIX L2 profile if the IPFIX L2 profile with given id does not already exist. If the IPFIX L2 profile with the given id already exists, patch with the existing IPFIX L2 profile.

Parameters

ipfix_l2_profile_id (str) – IPFIX L2 Profile ID (required)
i_pfix_l2_profile (com.vmware.nsx_policy.model_client.IPFIXL2Profile) – (required)

Raise

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

Raise

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

Raise

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

Raise

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

Raise

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

update(ipfix_l2_profile_id, i_pfix_l2_profile)¶

Create or replace IPFIX L2 Profile. Profile is reusable entity. Single profile can attached multiple bindings e.g group, segment and port.

Parameters

ipfix_l2_profile_id (str) – IPFIX L2 Profile ID (required)
i_pfix_l2_profile (com.vmware.nsx_policy.model_client.IPFIXL2Profile) – (required)

Return type

com.vmware.nsx_policy.model_client.IPFIXL2Profile

Returns

com.vmware.nsx_policy.model.IPFIXL2Profile

Raise

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

Raise

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

Raise

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

Raise

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

Raise

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

class com.vmware.nsx_policy.infra_client.IpsecVpnDpdProfiles(config)¶

Bases: vmware.vapi.bindings.stub.VapiInterface

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

delete(dpd_profile_id)¶

Delete custom dead peer detection (DPD) profile. Profile can not be deleted if profile has references to it.

Parameters: dpd_profile_id (str) – (required)
Raise: com.vmware.vapi.std.errors_client.ServiceUnavailable Service Unavailable
Raise: com.vmware.vapi.std.errors_client.InvalidRequest Bad Request, Precondition Failed
Raise: com.vmware.vapi.std.errors_client.InternalServerError Internal Server Error
Raise: com.vmware.vapi.std.errors_client.Unauthorized Forbidden
Raise: com.vmware.vapi.std.errors_client.NotFound Not Found

get(dpd_profile_id)¶

Get custom dead peer detection (DPD) profile, given the particular id.

Parameters: dpd_profile_id (str) – (required)
Return type: com.vmware.nsx_policy.model_client.IPSecVpnDpdProfile
Returns: com.vmware.nsx_policy.model.IPSecVpnDpdProfile
Raise: com.vmware.vapi.std.errors_client.ServiceUnavailable Service Unavailable
Raise: com.vmware.vapi.std.errors_client.InvalidRequest Bad Request, Precondition Failed
Raise: com.vmware.vapi.std.errors_client.InternalServerError Internal Server Error
Raise: com.vmware.vapi.std.errors_client.Unauthorized Forbidden
Raise: com.vmware.vapi.std.errors_client.NotFound Not Found

list(cursor=None, include_mark_for_delete_objects=None, included_fields=None, page_size=None, sort_ascending=None, sort_by=None)¶

Get paginated list of all DPD Profiles.

Parameters

cursor (str or None) – Opaque cursor to be used for getting next page of records (supplied by current result page) (optional)
include_mark_for_delete_objects (bool or None) – Include objects that are marked for deletion in results (optional, default to false)
included_fields (str or None) – Comma separated list of fields that should be included in query result (optional)
page_size (long or None) – Maximum number of results to return in this page (server may return fewer) (optional, default to 1000)
sort_ascending (bool or None) – (optional)
sort_by (str or None) – Field by which records are sorted (optional)

Return type

com.vmware.nsx_policy.model_client.IPSecVpnDpdProfileListResult

Returns

com.vmware.nsx_policy.model.IPSecVpnDpdProfileListResult

Raise

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

Raise

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

Raise

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

Raise

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

Raise

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

patch(dpd_profile_id, ip_sec_vpn_dpd_profile)¶

Create or patch dead peer detection (DPD) profile. Any change in profile affects all sessions consuming this profile. System will be provisioned with system owned editable default DPD profile. Any change in profile affects all sessions consuming this profile.

Parameters

dpd_profile_id (str) – (required)
ip_sec_vpn_dpd_profile (com.vmware.nsx_policy.model_client.IPSecVpnDpdProfile) – (required)

Raise

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

Raise

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

Raise

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

Raise

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

Raise

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

update(dpd_profile_id, ip_sec_vpn_dpd_profile)¶

Create or patch dead peer detection (DPD) profile. Any change in profile affects all sessions consuming this profile. System will be provisioned with system owned editable default DPD profile. Any change in profile affects all sessions consuming this profile. Revision is optional for creation and required for update.

Parameters

dpd_profile_id (str) – (required)
ip_sec_vpn_dpd_profile (com.vmware.nsx_policy.model_client.IPSecVpnDpdProfile) – (required)

Return type

com.vmware.nsx_policy.model_client.IPSecVpnDpdProfile

Returns

com.vmware.nsx_policy.model.IPSecVpnDpdProfile

Raise

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

Raise

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

Raise

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

Raise

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

Raise

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

class com.vmware.nsx_policy.infra_client.IpsecVpnIkeProfiles(config)¶

Bases: vmware.vapi.bindings.stub.VapiInterface

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

delete(ike_profile_id)¶

Delete custom IKE Profile. Profile can not be deleted if profile has references to it.

Parameters: ike_profile_id (str) – (required)
Raise: com.vmware.vapi.std.errors_client.ServiceUnavailable Service Unavailable
Raise: com.vmware.vapi.std.errors_client.InvalidRequest Bad Request, Precondition Failed
Raise: com.vmware.vapi.std.errors_client.InternalServerError Internal Server Error
Raise: com.vmware.vapi.std.errors_client.Unauthorized Forbidden
Raise: com.vmware.vapi.std.errors_client.NotFound Not Found

get(ike_profile_id)¶

Get custom IKE Profile, given the particular id.

Parameters: ike_profile_id (str) – (required)
Return type: com.vmware.nsx_policy.model_client.IPSecVpnIkeProfile
Returns: com.vmware.nsx_policy.model.IPSecVpnIkeProfile
Raise: com.vmware.vapi.std.errors_client.ServiceUnavailable Service Unavailable
Raise: com.vmware.vapi.std.errors_client.InvalidRequest Bad Request, Precondition Failed
Raise: com.vmware.vapi.std.errors_client.InternalServerError Internal Server Error
Raise: com.vmware.vapi.std.errors_client.Unauthorized Forbidden
Raise: com.vmware.vapi.std.errors_client.NotFound Not Found

list(cursor=None, include_mark_for_delete_objects=None, included_fields=None, page_size=None, sort_ascending=None, sort_by=None)¶

Get paginated list of all IKE Profiles.

Parameters

cursor (str or None) – Opaque cursor to be used for getting next page of records (supplied by current result page) (optional)
include_mark_for_delete_objects (bool or None) – Include objects that are marked for deletion in results (optional, default to false)
included_fields (str or None) – Comma separated list of fields that should be included in query result (optional)
page_size (long or None) – Maximum number of results to return in this page (server may return fewer) (optional, default to 1000)
sort_ascending (bool or None) – (optional)
sort_by (str or None) – Field by which records are sorted (optional)

Return type

com.vmware.nsx_policy.model_client.IPSecVpnIkeProfileListResult

Returns

com.vmware.nsx_policy.model.IPSecVpnIkeProfileListResult

Raise

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

Raise

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

Raise

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

Raise

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

Raise

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

patch(ike_profile_id, ip_sec_vpn_ike_profile)¶

Create or patch custom internet key exchange (IKE) Profile. IKE Profile is a reusable profile that captures IKE and phase one negotiation parameters. System will be pre provisioned with system owned editable default IKE profile and suggested set of profiles that can be used for peering with popular remote peers like AWS VPN. User can create custom profiles as needed. Any change in profile affects all sessions consuming this profile.

Parameters

ike_profile_id (str) – (required)
ip_sec_vpn_ike_profile (com.vmware.nsx_policy.model_client.IPSecVpnIkeProfile) – (required)

Raise

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

Raise

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

Raise

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

Raise

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

Raise

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

update(ike_profile_id, ip_sec_vpn_ike_profile)¶

Create or fully replace custom internet key exchange (IKE) Profile. IKE Profile is a reusable profile that captures IKE and phase one negotiation parameters. System will be pre provisioned with system owned editable default IKE profile and suggested set of profiles that can be used for peering with popular remote peers like AWS VPN. User can create custom profiles as needed. Any change in profile affects all sessions consuming this profile. Revision is optional for creation and required for update.

Parameters

ike_profile_id (str) – (required)
ip_sec_vpn_ike_profile (com.vmware.nsx_policy.model_client.IPSecVpnIkeProfile) – (required)

Return type

com.vmware.nsx_policy.model_client.IPSecVpnIkeProfile

Returns

com.vmware.nsx_policy.model.IPSecVpnIkeProfile

Raise

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

Raise

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

Raise

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

Raise

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

Raise

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

class com.vmware.nsx_policy.infra_client.IpsecVpnTunnelProfiles(config)¶

Bases: vmware.vapi.bindings.stub.VapiInterface

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

delete(tunnel_profile_id)¶

Delete custom IPSec tunnel Profile. Profile can not be deleted if profile has references to it.

Parameters: tunnel_profile_id (str) – (required)
Raise: com.vmware.vapi.std.errors_client.ServiceUnavailable Service Unavailable
Raise: com.vmware.vapi.std.errors_client.InvalidRequest Bad Request, Precondition Failed
Raise: com.vmware.vapi.std.errors_client.InternalServerError Internal Server Error
Raise: com.vmware.vapi.std.errors_client.Unauthorized Forbidden
Raise: com.vmware.vapi.std.errors_client.NotFound Not Found

get(tunnel_profile_id)¶

Get custom IPSec tunnel Profile, given the particular id.

Parameters: tunnel_profile_id (str) – (required)
Return type: com.vmware.nsx_policy.model_client.IPSecVpnTunnelProfile
Returns: com.vmware.nsx_policy.model.IPSecVpnTunnelProfile
Raise: com.vmware.vapi.std.errors_client.ServiceUnavailable Service Unavailable
Raise: com.vmware.vapi.std.errors_client.InvalidRequest Bad Request, Precondition Failed
Raise: com.vmware.vapi.std.errors_client.InternalServerError Internal Server Error
Raise: com.vmware.vapi.std.errors_client.Unauthorized Forbidden
Raise: com.vmware.vapi.std.errors_client.NotFound Not Found

list(cursor=None, include_mark_for_delete_objects=None, included_fields=None, page_size=None, sort_ascending=None, sort_by=None)¶

Get paginated list of all IPSec tunnel Profiles.

Parameters

cursor (str or None) – Opaque cursor to be used for getting next page of records (supplied by current result page) (optional)
include_mark_for_delete_objects (bool or None) – Include objects that are marked for deletion in results (optional, default to false)
included_fields (str or None) – Comma separated list of fields that should be included in query result (optional)
page_size (long or None) – Maximum number of results to return in this page (server may return fewer) (optional, default to 1000)
sort_ascending (bool or None) – (optional)
sort_by (str or None) – Field by which records are sorted (optional)

Return type

com.vmware.nsx_policy.model_client.IPSecVpnTunnelProfileListResult

Returns

com.vmware.nsx_policy.model.IPSecVpnTunnelProfileListResult

Raise

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

Raise

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

Raise

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

Raise

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

Raise

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

patch(tunnel_profile_id, ip_sec_vpn_tunnel_profile)¶

Create or patch custom IPSec tunnel profile. IPSec tunnel profile is a reusable profile that captures phase two negotiation parameters and tunnel properties. System will be provisioned with system owned editable default IPSec tunnel profile. Any change in profile affects all sessions consuming this profile.

Parameters

tunnel_profile_id (str) – (required)
ip_sec_vpn_tunnel_profile (com.vmware.nsx_policy.model_client.IPSecVpnTunnelProfile) – (required)

Raise

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

Raise

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

Raise

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

Raise

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

Raise

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

update(tunnel_profile_id, ip_sec_vpn_tunnel_profile)¶

Create or fully replace custom IPSec tunnel profile. IPSec tunnel profile is a reusable profile that captures phase two negotiation parameters and tunnel properties. System will be provisioned with system owned editable default IPSec tunnel profile. Any change in profile affects all sessions consuming this profile. Revision is optional for creation and required for update.

Parameters

tunnel_profile_id (str) – (required)
ip_sec_vpn_tunnel_profile (com.vmware.nsx_policy.model_client.IPSecVpnTunnelProfile) – (required)

Return type

com.vmware.nsx_policy.model_client.IPSecVpnTunnelProfile

Returns

com.vmware.nsx_policy.model.IPSecVpnTunnelProfile

Raise

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

Raise

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

Raise

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

Raise

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

Raise

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

class com.vmware.nsx_policy.infra_client.Ipv6DadProfiles(config)¶

Bases: vmware.vapi.bindings.stub.VapiInterface

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

delete(dad_profile_id)¶

Delete IPv6 DAD profile

Parameters: dad_profile_id (str) – (required)
Raise: com.vmware.vapi.std.errors_client.ServiceUnavailable Service Unavailable
Raise: com.vmware.vapi.std.errors_client.InvalidRequest Bad Request, Precondition Failed
Raise: com.vmware.vapi.std.errors_client.InternalServerError Internal Server Error
Raise: com.vmware.vapi.std.errors_client.Unauthorized Forbidden
Raise: com.vmware.vapi.std.errors_client.NotFound Not Found

get(dad_profile_id)¶

Read IPv6 DAD profile

Parameters: dad_profile_id (str) – (required)
Return type: com.vmware.nsx_policy.model_client.Ipv6DadProfile
Returns: com.vmware.nsx_policy.model.Ipv6DadProfile
Raise: com.vmware.vapi.std.errors_client.ServiceUnavailable Service Unavailable
Raise: com.vmware.vapi.std.errors_client.InvalidRequest Bad Request, Precondition Failed
Raise: com.vmware.vapi.std.errors_client.InternalServerError Internal Server Error
Raise: com.vmware.vapi.std.errors_client.Unauthorized Forbidden
Raise: com.vmware.vapi.std.errors_client.NotFound Not Found

list(cursor=None, include_mark_for_delete_objects=None, included_fields=None, page_size=None, sort_ascending=None, sort_by=None)¶

Paginated list of all DHCP relay config instances

Parameters

cursor (str or None) – Opaque cursor to be used for getting next page of records (supplied by current result page) (optional)
include_mark_for_delete_objects (bool or None) – Include objects that are marked for deletion in results (optional, default to false)
included_fields (str or None) – Comma separated list of fields that should be included in query result (optional)
page_size (long or None) – Maximum number of results to return in this page (server may return fewer) (optional, default to 1000)
sort_ascending (bool or None) – (optional)
sort_by (str or None) – Field by which records are sorted (optional)

Return type

com.vmware.nsx_policy.model_client.Ipv6DadProfileListResult

Returns

com.vmware.nsx_policy.model.Ipv6DadProfileListResult

Raise

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

Raise

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

Raise

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

Raise

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

Raise

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

patch(dad_profile_id, ipv6_dad_profile)¶

If profile with the dad-profile-id is not already present, create a new IPv6 DAD profile instance. If it already exists, update the IPv6 DAD profile instance with specified attributes.

Parameters

dad_profile_id (str) – (required)
ipv6_dad_profile (com.vmware.nsx_policy.model_client.Ipv6DadProfile) – (required)

Raise

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

Raise

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

Raise

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

Raise

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

Raise

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

update(dad_profile_id, ipv6_dad_profile)¶

If profile with the dad-profile-id is not already present, create a new IPv6 DAD profile instance. If it already exists, replace the IPv6 DAD profile instance with this object.

Parameters

dad_profile_id (str) – (required)
ipv6_dad_profile (com.vmware.nsx_policy.model_client.Ipv6DadProfile) – (required)

Return type

com.vmware.nsx_policy.model_client.Ipv6DadProfile

Returns

com.vmware.nsx_policy.model.Ipv6DadProfile

Raise

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

Raise

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

Raise

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

Raise

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

Raise

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

class com.vmware.nsx_policy.infra_client.Ipv6NdraProfiles(config)¶

Bases: vmware.vapi.bindings.stub.VapiInterface

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

delete(ndra_profile_id)¶

Delete IPv6 NDRA profile

Parameters: ndra_profile_id (str) – (required)
Raise: com.vmware.vapi.std.errors_client.ServiceUnavailable Service Unavailable
Raise: com.vmware.vapi.std.errors_client.InvalidRequest Bad Request, Precondition Failed
Raise: com.vmware.vapi.std.errors_client.InternalServerError Internal Server Error
Raise: com.vmware.vapi.std.errors_client.Unauthorized Forbidden
Raise: com.vmware.vapi.std.errors_client.NotFound Not Found

get(ndra_profile_id)¶

Read IPv6 NDRA profile

Parameters: ndra_profile_id (str) – (required)
Return type: com.vmware.nsx_policy.model_client.Ipv6NdraProfile
Returns: com.vmware.nsx_policy.model.Ipv6NdraProfile
Raise: com.vmware.vapi.std.errors_client.ServiceUnavailable Service Unavailable
Raise: com.vmware.vapi.std.errors_client.InvalidRequest Bad Request, Precondition Failed
Raise: com.vmware.vapi.std.errors_client.InternalServerError Internal Server Error
Raise: com.vmware.vapi.std.errors_client.Unauthorized Forbidden
Raise: com.vmware.vapi.std.errors_client.NotFound Not Found

list(cursor=None, include_mark_for_delete_objects=None, included_fields=None, page_size=None, sort_ascending=None, sort_by=None)¶

Paginated list of all DHCP relay config instances

Parameters

cursor (str or None) – Opaque cursor to be used for getting next page of records (supplied by current result page) (optional)
include_mark_for_delete_objects (bool or None) – Include objects that are marked for deletion in results (optional, default to false)
included_fields (str or None) – Comma separated list of fields that should be included in query result (optional)
page_size (long or None) – Maximum number of results to return in this page (server may return fewer) (optional, default to 1000)
sort_ascending (bool or None) – (optional)
sort_by (str or None) – Field by which records are sorted (optional)

Return type

com.vmware.nsx_policy.model_client.Ipv6NdraProfileListResult

Returns

com.vmware.nsx_policy.model.Ipv6NdraProfileListResult

Raise

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

Raise

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

Raise

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

Raise

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

Raise

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

patch(ndra_profile_id, ipv6_ndra_profile)¶

If profile with the ndra-profile-id is not already present, create a new IPv6 NDRA profile instance. If it already exists, update the IPv6 NDRA profile instance with specified attributes.

Parameters

ndra_profile_id (str) – (required)
ipv6_ndra_profile (com.vmware.nsx_policy.model_client.Ipv6NdraProfile) – (required)

Raise

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

Raise

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

Raise

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

Raise

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

Raise

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

update(ndra_profile_id, ipv6_ndra_profile)¶

If profile with the ndra-profile-id is not already present, create a new IPv6 NDRA profile instance. If it already exists, replace the IPv6 NDRA profile instance with this object.

Parameters

ndra_profile_id (str) – (required)
ipv6_ndra_profile (com.vmware.nsx_policy.model_client.Ipv6NdraProfile) – (required)

Return type

com.vmware.nsx_policy.model_client.Ipv6NdraProfile

Returns

com.vmware.nsx_policy.model.Ipv6NdraProfile

Raise

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

Raise

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

Raise

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

Raise

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

Raise

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

class com.vmware.nsx_policy.infra_client.MacDiscoveryProfiles(config)¶

Bases: vmware.vapi.bindings.stub.VapiInterface

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

delete(mac_discovery_profile_id)¶

API will delete Mac Discovery profile.

Parameters: mac_discovery_profile_id (str) – Mac Discovery Profile ID (required)
Raise: com.vmware.vapi.std.errors_client.ServiceUnavailable Service Unavailable
Raise: com.vmware.vapi.std.errors_client.InvalidRequest Bad Request, Precondition Failed
Raise: com.vmware.vapi.std.errors_client.InternalServerError Internal Server Error
Raise: com.vmware.vapi.std.errors_client.Unauthorized Forbidden
Raise: com.vmware.vapi.std.errors_client.NotFound Not Found

get(mac_discovery_profile_id)¶

API will get Mac Discovery profile.

Parameters: mac_discovery_profile_id (str) – Mac Discovery Profile ID (required)
Return type: com.vmware.nsx_policy.model_client.MacDiscoveryProfile
Returns: com.vmware.nsx_policy.model.MacDiscoveryProfile
Raise: com.vmware.vapi.std.errors_client.ServiceUnavailable Service Unavailable
Raise: com.vmware.vapi.std.errors_client.InvalidRequest Bad Request, Precondition Failed
Raise: com.vmware.vapi.std.errors_client.InternalServerError Internal Server Error
Raise: com.vmware.vapi.std.errors_client.Unauthorized Forbidden
Raise: com.vmware.vapi.std.errors_client.NotFound Not Found

list(cursor=None, include_mark_for_delete_objects=None, included_fields=None, page_size=None, sort_ascending=None, sort_by=None)¶

API will list all Mac Discovery Profiles active in current discovery profile id.

Parameters

cursor (str or None) – Opaque cursor to be used for getting next page of records (supplied by current result page) (optional)
include_mark_for_delete_objects (bool or None) – Include objects that are marked for deletion in results (optional, default to false)
included_fields (str or None) – Comma separated list of fields that should be included in query result (optional)
page_size (long or None) – Maximum number of results to return in this page (server may return fewer) (optional, default to 1000)
sort_ascending (bool or None) – (optional)
sort_by (str or None) – Field by which records are sorted (optional)

Return type

com.vmware.nsx_policy.model_client.MacDiscoveryProfileListResult

Returns

com.vmware.nsx_policy.model.MacDiscoveryProfileListResult

Raise

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

Raise

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

Raise

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

Raise

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

Raise

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

patch(mac_discovery_profile_id, mac_discovery_profile)¶

API will create Mac Discovery profile.

Parameters

mac_discovery_profile_id (str) – Mac Discovery Profile ID (required)
mac_discovery_profile (com.vmware.nsx_policy.model_client.MacDiscoveryProfile) – (required)

Raise

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

Raise

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

Raise

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

Raise

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

Raise

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

update(mac_discovery_profile_id, mac_discovery_profile)¶

API will update Mac Discovery profile.

Parameters

mac_discovery_profile_id (str) – Mac Discovery Profile ID (required)
mac_discovery_profile (com.vmware.nsx_policy.model_client.MacDiscoveryProfile) – (required)

Return type

com.vmware.nsx_policy.model_client.MacDiscoveryProfile

Returns

com.vmware.nsx_policy.model.MacDiscoveryProfile

Raise

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

Raise

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

Raise

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

Raise

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

Raise

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

class com.vmware.nsx_policy.infra_client.PartnerServices(config)¶

Bases: vmware.vapi.bindings.stub.VapiInterface

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

get(service_name)¶

Read the specific partner service identified by provided name.

Parameters: service_name (str) – Name of the service (required)
Return type: com.vmware.nsx_policy.model_client.ServiceDefinition
Returns: com.vmware.nsx_policy.model.ServiceDefinition
Raise: com.vmware.vapi.std.errors_client.ServiceUnavailable Service Unavailable
Raise: com.vmware.vapi.std.errors_client.InvalidRequest Bad Request, Precondition Failed
Raise: com.vmware.vapi.std.errors_client.InternalServerError Internal Server Error
Raise: com.vmware.vapi.std.errors_client.Unauthorized Forbidden
Raise: com.vmware.vapi.std.errors_client.NotFound Not Found

list(cursor=None, include_mark_for_delete_objects=None, included_fields=None, page_size=None, sort_ascending=None, sort_by=None)¶

Read all the partner services available for service insertion

Parameters

cursor (str or None) – Opaque cursor to be used for getting next page of records (supplied by current result page) (optional)
include_mark_for_delete_objects (bool or None) – Include objects that are marked for deletion in results (optional, default to false)
included_fields (str or None) – Comma separated list of fields that should be included in query result (optional)
page_size (long or None) – Maximum number of results to return in this page (server may return fewer) (optional, default to 1000)
sort_ascending (bool or None) – (optional)
sort_by (str or None) – Field by which records are sorted (optional)

Return type

com.vmware.nsx_policy.model_client.ServiceInsertionServiceListResult

Returns

com.vmware.nsx_policy.model.ServiceInsertionServiceListResult

Raise

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

Raise

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

Raise

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

Raise

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

Raise

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

class com.vmware.nsx_policy.infra_client.PortMirroringProfiles(config)¶

Bases: vmware.vapi.bindings.stub.VapiInterface

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

delete(port_mirroring_profile_id)¶

API will delete port mirroring profile. Mirroring from source to destination ports will be stopped.

Parameters: port_mirroring_profile_id (str) – Port Mirroring Profile Id (required)
Raise: com.vmware.vapi.std.errors_client.ServiceUnavailable Service Unavailable
Raise: com.vmware.vapi.std.errors_client.InvalidRequest Bad Request, Precondition Failed
Raise: com.vmware.vapi.std.errors_client.InternalServerError Internal Server Error
Raise: com.vmware.vapi.std.errors_client.Unauthorized Forbidden
Raise: com.vmware.vapi.std.errors_client.NotFound Not Found

get(port_mirroring_profile_id)¶

API will return details of port mirroring profile.

Parameters: port_mirroring_profile_id (str) – Port Mirroring Profile Id (required)
Return type: com.vmware.nsx_policy.model_client.PortMirroringProfile
Returns: com.vmware.nsx_policy.model.PortMirroringProfile
Raise: com.vmware.vapi.std.errors_client.ServiceUnavailable Service Unavailable
Raise: com.vmware.vapi.std.errors_client.InvalidRequest Bad Request, Precondition Failed
Raise: com.vmware.vapi.std.errors_client.InternalServerError Internal Server Error
Raise: com.vmware.vapi.std.errors_client.Unauthorized Forbidden
Raise: com.vmware.vapi.std.errors_client.NotFound Not Found

list(cursor=None, included_fields=None, page_size=None, sort_ascending=None, sort_by=None)¶

API will list all port mirroring profiles group.

Parameters

cursor (str or None) – Opaque cursor to be used for getting next page of records (supplied by current result page) (optional)
included_fields (str or None) – Comma separated list of fields that should be included in query result (optional)
page_size (long or None) – Maximum number of results to return in this page (server may return fewer) (optional, default to 1000)
sort_ascending (bool or None) – (optional)
sort_by (str or None) – Field by which records are sorted (optional)

Return type

com.vmware.nsx_policy.model_client.PortMirroringProfileListResult

Returns

com.vmware.nsx_policy.model.PortMirroringProfileListResult

Raise

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

Raise

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

Raise

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

Raise

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

Raise

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

patch(port_mirroring_profile_id, port_mirroring_profile)¶

Create a new Port Mirroring Profile if the Port Mirroring Profile with given id does not already exist. If the Port Mirroring Profile with the given id already exists, patch with the existing Port Mirroring Profile. Realized entities of this API can be found using the path of monitoring profile binding map that is used to apply this profile.

Parameters

port_mirroring_profile_id (str) – Port Mirroring Profile Id (required)
port_mirroring_profile (com.vmware.nsx_policy.model_client.PortMirroringProfile) – (required)

Raise

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

Raise

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

Raise

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

Raise

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

Raise

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

update(port_mirroring_profile_id, port_mirroring_profile)¶

Create or Replace port mirroring profile. Packets will be mirrored from source group, segment, port to destination group. Realized entities of this API can be found using the path of monitoring profile binding map that is used to apply this profile.

Parameters

port_mirroring_profile_id (str) – Port Mirroring Profiles Id (required)
port_mirroring_profile (com.vmware.nsx_policy.model_client.PortMirroringProfile) – (required)

Return type

com.vmware.nsx_policy.model_client.PortMirroringProfile

Returns

com.vmware.nsx_policy.model.PortMirroringProfile

Raise

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

Raise

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

Raise

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

Raise

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

Raise

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

class com.vmware.nsx_policy.infra_client.QosProfiles(config)¶

Bases: vmware.vapi.bindings.stub.VapiInterface

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

delete(qos_profile_id)¶

API will delete QoS profile.

Parameters: qos_profile_id (str) – QoS profile Id (required)
Raise: com.vmware.vapi.std.errors_client.ServiceUnavailable Service Unavailable
Raise: com.vmware.vapi.std.errors_client.InvalidRequest Bad Request, Precondition Failed
Raise: com.vmware.vapi.std.errors_client.InternalServerError Internal Server Error
Raise: com.vmware.vapi.std.errors_client.Unauthorized Forbidden
Raise: com.vmware.vapi.std.errors_client.NotFound Not Found

get(qos_profile_id)¶

API will return details of QoS profile.

Parameters: qos_profile_id (str) – QoS profile Id (required)
Return type: com.vmware.nsx_policy.model_client.QosProfile
Returns: com.vmware.nsx_policy.model.QoSProfile
Raise: com.vmware.vapi.std.errors_client.ServiceUnavailable Service Unavailable
Raise: com.vmware.vapi.std.errors_client.InvalidRequest Bad Request, Precondition Failed
Raise: com.vmware.vapi.std.errors_client.InternalServerError Internal Server Error
Raise: com.vmware.vapi.std.errors_client.Unauthorized Forbidden
Raise: com.vmware.vapi.std.errors_client.NotFound Not Found

list(cursor=None, included_fields=None, page_size=None, sort_ascending=None, sort_by=None)¶

API will list all QoS profiles.

Parameters

cursor (str or None) – Opaque cursor to be used for getting next page of records (supplied by current result page) (optional)
included_fields (str or None) – Comma separated list of fields that should be included in query result (optional)
page_size (long or None) – Maximum number of results to return in this page (server may return fewer) (optional, default to 1000)
sort_ascending (bool or None) – (optional)
sort_by (str or None) – Field by which records are sorted (optional)

Return type

com.vmware.nsx_policy.model_client.QosProfileListResult

Returns

com.vmware.nsx_policy.model.QoSProfileListResult

Raise

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

Raise

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

Raise

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

Raise

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

Raise

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

patch(qos_profile_id, qos_profile)¶

Create a new QoS profile if the QoS profile with given id does not already exist. If the QoS profile with the given id already exists, patch with the existing QoS profile.

Parameters

qos_profile_id (str) – QoS profile Id (required)
qos_profile (com.vmware.nsx_policy.model_client.QosProfile) – (required)

Raise

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

Raise

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

Raise

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

Raise

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

Raise

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

update(qos_profile_id, qos_profile)¶

Create or Replace QoS profile.

Parameters

qos_profile_id (str) – QoS profile Id (required)
qos_profile (com.vmware.nsx_policy.model_client.QosProfile) – (required)

Return type

com.vmware.nsx_policy.model_client.QosProfile

Returns

com.vmware.nsx_policy.model.QoSProfile

Raise

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

Raise

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

Raise

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

Raise

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

Raise

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

class com.vmware.nsx_policy.infra_client.SegmentSecurityProfiles(config)¶

Bases: vmware.vapi.bindings.stub.VapiInterface

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

delete(segment_security_profile_id)¶

API will delete segment security profile with the given id.

Parameters: segment_security_profile_id (str) – Segment security profile id (required)
Raise: com.vmware.vapi.std.errors_client.ServiceUnavailable Service Unavailable
Raise: com.vmware.vapi.std.errors_client.InvalidRequest Bad Request, Precondition Failed
Raise: com.vmware.vapi.std.errors_client.InternalServerError Internal Server Error
Raise: com.vmware.vapi.std.errors_client.Unauthorized Forbidden
Raise: com.vmware.vapi.std.errors_client.NotFound Not Found

get(segment_security_profile_id)¶

API will return details of the segment security profile with given id. If the profile does not exist, it will return 404.

Parameters: segment_security_profile_id (str) – Segment security profile id (required)
Return type: com.vmware.nsx_policy.model_client.SegmentSecurityProfile
Returns: com.vmware.nsx_policy.model.SegmentSecurityProfile
Raise: com.vmware.vapi.std.errors_client.ServiceUnavailable Service Unavailable
Raise: com.vmware.vapi.std.errors_client.InvalidRequest Bad Request, Precondition Failed
Raise: com.vmware.vapi.std.errors_client.InternalServerError Internal Server Error
Raise: com.vmware.vapi.std.errors_client.Unauthorized Forbidden
Raise: com.vmware.vapi.std.errors_client.NotFound Not Found

list(cursor=None, include_mark_for_delete_objects=None, included_fields=None, page_size=None, sort_ascending=None, sort_by=None)¶

API will list all segment security profiles.

Parameters

cursor (str or None) – Opaque cursor to be used for getting next page of records (supplied by current result page) (optional)
include_mark_for_delete_objects (bool or None) – Include objects that are marked for deletion in results (optional, default to false)
included_fields (str or None) – Comma separated list of fields that should be included in query result (optional)
page_size (long or None) – Maximum number of results to return in this page (server may return fewer) (optional, default to 1000)
sort_ascending (bool or None) – (optional)
sort_by (str or None) – Field by which records are sorted (optional)

Return type

com.vmware.nsx_policy.model_client.SegmentSecurityProfileListResult

Returns

com.vmware.nsx_policy.model.SegmentSecurityProfileListResult

Raise

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

Raise

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

Raise

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

Raise

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

Raise

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

patch(segment_security_profile_id, segment_security_profile)¶

Create a new segment security profile if the segment security profile with given id does not exist. Otherwise, PATCH the existing segment security profile

Parameters

segment_security_profile_id (str) – Segment security profile id (required)
segment_security_profile (com.vmware.nsx_policy.model_client.SegmentSecurityProfile) – (required)

Raise

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

Raise

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

Raise

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

Raise

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

Raise

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

update(segment_security_profile_id, segment_security_profile)¶

Create or replace a segment security profile

Parameters

segment_security_profile_id (str) – Segment security profile id (required)
segment_security_profile (com.vmware.nsx_policy.model_client.SegmentSecurityProfile) – (required)

Return type

com.vmware.nsx_policy.model_client.SegmentSecurityProfile

Returns

com.vmware.nsx_policy.model.SegmentSecurityProfile

Raise

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

Raise

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

Raise

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

Raise

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

Raise

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

class com.vmware.nsx_policy.infra_client.Segments(config)¶

Bases: vmware.vapi.bindings.stub.VapiInterface

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

delete(segment_id)¶

Delete infra segment

Parameters: segment_id (str) – Segment ID (required)
Raise: com.vmware.vapi.std.errors_client.ServiceUnavailable Service Unavailable
Raise: com.vmware.vapi.std.errors_client.InvalidRequest Bad Request, Precondition Failed
Raise: com.vmware.vapi.std.errors_client.InternalServerError Internal Server Error
Raise: com.vmware.vapi.std.errors_client.Unauthorized Forbidden
Raise: com.vmware.vapi.std.errors_client.NotFound Not Found

delete_0(segment_id)¶

Force delete bypasses validations during segment deletion. This may result in an inconsistent connectivity.

Parameters: segment_id (str) – (required)
Raise: com.vmware.vapi.std.errors_client.ServiceUnavailable Service Unavailable
Raise: com.vmware.vapi.std.errors_client.InvalidRequest Bad Request, Precondition Failed
Raise: com.vmware.vapi.std.errors_client.InternalServerError Internal Server Error
Raise: com.vmware.vapi.std.errors_client.Unauthorized Forbidden
Raise: com.vmware.vapi.std.errors_client.NotFound Not Found

get(segment_id)¶

Read infra segment

Parameters: segment_id (str) – Segment ID (required)
Return type: com.vmware.nsx_policy.model_client.Segment
Returns: com.vmware.nsx_policy.model.Segment
Raise: com.vmware.vapi.std.errors_client.ServiceUnavailable Service Unavailable
Raise: com.vmware.vapi.std.errors_client.InvalidRequest Bad Request, Precondition Failed
Raise: com.vmware.vapi.std.errors_client.InternalServerError Internal Server Error
Raise: com.vmware.vapi.std.errors_client.Unauthorized Forbidden
Raise: com.vmware.vapi.std.errors_client.NotFound Not Found

list(cursor=None, include_mark_for_delete_objects=None, included_fields=None, page_size=None, sort_ascending=None, sort_by=None)¶

Paginated list of all segments under infra.

Parameters

cursor (str or None) – Opaque cursor to be used for getting next page of records (supplied by current result page) (optional)
include_mark_for_delete_objects (bool or None) – Include objects that are marked for deletion in results (optional, default to false)
included_fields (str or None) – Comma separated list of fields that should be included in query result (optional)
page_size (long or None) – Maximum number of results to return in this page (server may return fewer) (optional, default to 1000)
sort_ascending (bool or None) – (optional)
sort_by (str or None) – Field by which records are sorted (optional)

Return type

com.vmware.nsx_policy.model_client.SegmentListResult

Returns

com.vmware.nsx_policy.model.SegmentListResult

Raise

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

Raise

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

Raise

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

Raise

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

Raise

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

patch(segment_id, segment)¶

If segment with the segment-id is not already present, create a new segment. If it already exists, update the segment with specified attributes.

Parameters

segment_id (str) – Segment ID (required)
segment (com.vmware.nsx_policy.model_client.Segment) – (required)

Raise

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

Raise

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

Raise

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

Raise

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

Raise

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

update(segment_id, segment)¶

If segment with the segment-id is not already present, create a new segment. If it already exists, replace the segment with this object.

Parameters

segment_id (str) – Segment ID (required)
segment (com.vmware.nsx_policy.model_client.Segment) – (required)

Return type

com.vmware.nsx_policy.model_client.Segment

Returns

com.vmware.nsx_policy.model.Segment

Raise

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

Raise

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

Raise

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

Raise

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

Raise

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

class com.vmware.nsx_policy.infra_client.Services(config)¶

Bases: vmware.vapi.bindings.stub.VapiInterface

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

delete(service_id)¶

Delete Service

Parameters: service_id (str) – Service ID (required)
Raise: com.vmware.vapi.std.errors_client.ServiceUnavailable Service Unavailable
Raise: com.vmware.vapi.std.errors_client.InvalidRequest Bad Request, Precondition Failed
Raise: com.vmware.vapi.std.errors_client.InternalServerError Internal Server Error
Raise: com.vmware.vapi.std.errors_client.Unauthorized Forbidden
Raise: com.vmware.vapi.std.errors_client.NotFound Not Found

get(service_id)¶

Read a service

Parameters: service_id (str) – Service ID (required)
Return type: com.vmware.nsx_policy.model_client.Service
Returns: com.vmware.nsx_policy.model.Service
Raise: com.vmware.vapi.std.errors_client.ServiceUnavailable Service Unavailable
Raise: com.vmware.vapi.std.errors_client.InvalidRequest Bad Request, Precondition Failed
Raise: com.vmware.vapi.std.errors_client.InternalServerError Internal Server Error
Raise: com.vmware.vapi.std.errors_client.Unauthorized Forbidden
Raise: com.vmware.vapi.std.errors_client.NotFound Not Found

list(cursor=None, default_service=None, include_mark_for_delete_objects=None, included_fields=None, page_size=None, sort_ascending=None, sort_by=None)¶

Paginated list of Services for infra.

Parameters

cursor (str or None) – Opaque cursor to be used for getting next page of records (supplied by current result page) (optional)
default_service (bool or None) – Fetch all default services (optional)
include_mark_for_delete_objects (bool or None) – Include objects that are marked for deletion in results (optional, default to false)
included_fields (str or None) – Comma separated list of fields that should be included in query result (optional)
page_size (long or None) – Maximum number of results to return in this page (server may return fewer) (optional, default to 1000)
sort_ascending (bool or None) – (optional)
sort_by (str or None) – Field by which records are sorted (optional)

Return type

com.vmware.nsx_policy.model_client.ServiceListResult

Returns

com.vmware.nsx_policy.model.ServiceListResult

Raise

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

Raise

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

Raise

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

Raise

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

Raise

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

patch(service_id, service)¶

Create a new service if a service with the given ID does not already exist. Creates new service entries if populated in the service. If a service with the given ID already exists, patch the service including the nested service entries.

Parameters

service_id (str) – Service ID (required)
service (com.vmware.nsx_policy.model_client.Service) – (required)

Raise

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

Raise

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

Raise

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

Raise

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

Raise

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

update(service_id, service)¶

Create a new service if a service with the given ID does not already exist. Creates new service entries if populated in the service. If a service with the given ID already exists, update the service including the nested service entries. This is a full replace.

Parameters

service_id (str) – Service ID (required)
service (com.vmware.nsx_policy.model_client.Service) – (required)

Return type

com.vmware.nsx_policy.model_client.Service

Returns

com.vmware.nsx_policy.model.Service

Raise

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

Raise

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

Raise

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

Raise

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

Raise

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

class com.vmware.nsx_policy.infra_client.Sites(config)¶

Bases: vmware.vapi.bindings.stub.VapiInterface

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

get(site_id)¶

Read a site

Parameters: site_id (str) – site id (required)
Return type: com.vmware.nsx_policy.model_client.Site
Returns: com.vmware.nsx_policy.model.Site
Raise: com.vmware.vapi.std.errors_client.ServiceUnavailable Service Unavailable
Raise: com.vmware.vapi.std.errors_client.InvalidRequest Bad Request, Precondition Failed
Raise: com.vmware.vapi.std.errors_client.InternalServerError Internal Server Error
Raise: com.vmware.vapi.std.errors_client.Unauthorized Forbidden
Raise: com.vmware.vapi.std.errors_client.NotFound Not Found

list(cursor=None, include_mark_for_delete_objects=None, included_fields=None, page_size=None, sort_ascending=None, sort_by=None)¶

Paginated list of all sites for infra.

Parameters

cursor (str or None) – Opaque cursor to be used for getting next page of records (supplied by current result page) (optional)
include_mark_for_delete_objects (bool or None) – Include objects that are marked for deletion in results (optional, default to false)
included_fields (str or None) – Comma separated list of fields that should be included in query result (optional)
page_size (long or None) – Maximum number of results to return in this page (server may return fewer) (optional, default to 1000)
sort_ascending (bool or None) – (optional)
sort_by (str or None) – Field by which records are sorted (optional)

Return type

com.vmware.nsx_policy.model_client.SiteListResult

Returns

com.vmware.nsx_policy.model.SiteListResult

Raise

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

Raise

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

Raise

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

Raise

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

Raise

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

class com.vmware.nsx_policy.infra_client.SpoofguardProfiles(config)¶

Bases: vmware.vapi.bindings.stub.VapiInterface

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

delete(spoofguard_profile_id)¶

API will delete SpoofGuard profile with the given id.

Parameters: spoofguard_profile_id (str) – SpoofGuard profile id (required)
Raise: com.vmware.vapi.std.errors_client.ServiceUnavailable Service Unavailable
Raise: com.vmware.vapi.std.errors_client.InvalidRequest Bad Request, Precondition Failed
Raise: com.vmware.vapi.std.errors_client.InternalServerError Internal Server Error
Raise: com.vmware.vapi.std.errors_client.Unauthorized Forbidden
Raise: com.vmware.vapi.std.errors_client.NotFound Not Found

get(spoofguard_profile_id)¶

API will return details of the SpoofGuard profile with given id. If the profile does not exist, it will return 404.

Parameters: spoofguard_profile_id (str) – SpoofGuard profile id (required)
Return type: com.vmware.nsx_policy.model_client.SpoofGuardProfile
Returns: com.vmware.nsx_policy.model.SpoofGuardProfile
Raise: com.vmware.vapi.std.errors_client.ServiceUnavailable Service Unavailable
Raise: com.vmware.vapi.std.errors_client.InvalidRequest Bad Request, Precondition Failed
Raise: com.vmware.vapi.std.errors_client.InternalServerError Internal Server Error
Raise: com.vmware.vapi.std.errors_client.Unauthorized Forbidden
Raise: com.vmware.vapi.std.errors_client.NotFound Not Found

list(cursor=None, include_mark_for_delete_objects=None, included_fields=None, page_size=None, sort_ascending=None, sort_by=None)¶

API will list all SpoofGuard profiles.

Parameters

cursor (str or None) – Opaque cursor to be used for getting next page of records (supplied by current result page) (optional)
include_mark_for_delete_objects (bool or None) – Include objects that are marked for deletion in results (optional, default to false)
included_fields (str or None) – Comma separated list of fields that should be included in query result (optional)
page_size (long or None) – Maximum number of results to return in this page (server may return fewer) (optional, default to 1000)
sort_ascending (bool or None) – (optional)
sort_by (str or None) – Field by which records are sorted (optional)

Return type

com.vmware.nsx_policy.model_client.SpoofGuardProfileListResult

Returns

com.vmware.nsx_policy.model.SpoofGuardProfileListResult

Raise

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

Raise

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

Raise

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

Raise

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

Raise

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

patch(spoofguard_profile_id, spoof_guard_profile)¶

Create a new SpoofGuard profile if the SpoofGuard profile with the given id does not exist. Otherwise, patch with the existing SpoofGuard profile.

Parameters

spoofguard_profile_id (str) – SpoofGuard profile id (required)
spoof_guard_profile (com.vmware.nsx_policy.model_client.SpoofGuardProfile) – (required)

Raise

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

Raise

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

Raise

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

Raise

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

Raise

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

update(spoofguard_profile_id, spoof_guard_profile)¶

API will create or replace SpoofGuard profile.

Parameters

spoofguard_profile_id (str) – SpoofGuard profile id (required)
spoof_guard_profile (com.vmware.nsx_policy.model_client.SpoofGuardProfile) – (required)

Return type

com.vmware.nsx_policy.model_client.SpoofGuardProfile

Returns

com.vmware.nsx_policy.model.SpoofGuardProfile

Raise

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

Raise

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

Raise

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

Raise

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

Raise

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

class com.vmware.nsx_policy.infra_client.StubFactory(stub_config)¶

Bases: vmware.vapi.bindings.stub.StubFactoryBase

Initialize StubFactoryBase

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

class com.vmware.nsx_policy.infra_client.Tier0s(config)¶

Bases: vmware.vapi.bindings.stub.VapiInterface

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

delete(tier0_id)¶

Delete Tier-0

Parameters: tier0_id (str) – (required)
Raise: com.vmware.vapi.std.errors_client.ServiceUnavailable Service Unavailable
Raise: com.vmware.vapi.std.errors_client.InvalidRequest Bad Request, Precondition Failed
Raise: com.vmware.vapi.std.errors_client.InternalServerError Internal Server Error
Raise: com.vmware.vapi.std.errors_client.Unauthorized Forbidden
Raise: com.vmware.vapi.std.errors_client.NotFound Not Found

get(tier0_id)¶

Read Tier-0

Parameters: tier0_id (str) – (required)
Return type: com.vmware.nsx_policy.model_client.Tier0
Returns: com.vmware.nsx_policy.model.Tier0
Raise: com.vmware.vapi.std.errors_client.ServiceUnavailable Service Unavailable
Raise: com.vmware.vapi.std.errors_client.InvalidRequest Bad Request, Precondition Failed
Raise: com.vmware.vapi.std.errors_client.InternalServerError Internal Server Error
Raise: com.vmware.vapi.std.errors_client.Unauthorized Forbidden
Raise: com.vmware.vapi.std.errors_client.NotFound Not Found

list(cursor=None, include_mark_for_delete_objects=None, included_fields=None, page_size=None, sort_ascending=None, sort_by=None)¶

Paginated list of all Tier-0s

Parameters

cursor (str or None) – Opaque cursor to be used for getting next page of records (supplied by current result page) (optional)
include_mark_for_delete_objects (bool or None) – Include objects that are marked for deletion in results (optional, default to false)
included_fields (str or None) – Comma separated list of fields that should be included in query result (optional)
page_size (long or None) – Maximum number of results to return in this page (server may return fewer) (optional, default to 1000)
sort_ascending (bool or None) – (optional)
sort_by (str or None) – Field by which records are sorted (optional)

Return type

com.vmware.nsx_policy.model_client.Tier0ListResult

Returns

com.vmware.nsx_policy.model.Tier0ListResult

Raise

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

Raise

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

Raise

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

Raise

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

Raise

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

patch(tier0_id, tier0)¶

If a Tier-0 with the tier-0-id is not already present, create a new Tier-0. If it already exists, update the Tier-0 for specified attributes.

Parameters

tier0_id (str) – (required)
tier0 (com.vmware.nsx_policy.model_client.Tier0) – (required)

Raise

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

Raise

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

Raise

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

Raise

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

Raise

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

update(tier0_id, tier0)¶

If a Tier-0 with the tier-0-id is not already present, create a new Tier-0. If it already exists, replace the Tier-0 instance with the new object.

Parameters

tier0_id (str) – (required)
tier0 (com.vmware.nsx_policy.model_client.Tier0) – (required)

Return type

com.vmware.nsx_policy.model_client.Tier0

Returns

com.vmware.nsx_policy.model.Tier0

Raise

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

Raise

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

Raise

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

Raise

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

Raise

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

class com.vmware.nsx_policy.infra_client.Tier1s(config)¶

Bases: vmware.vapi.bindings.stub.VapiInterface

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

delete(tier1_id)¶

Delete Tier-1 configuration

Parameters: tier1_id (str) – (required)
Raise: com.vmware.vapi.std.errors_client.ServiceUnavailable Service Unavailable
Raise: com.vmware.vapi.std.errors_client.InvalidRequest Bad Request, Precondition Failed
Raise: com.vmware.vapi.std.errors_client.InternalServerError Internal Server Error
Raise: com.vmware.vapi.std.errors_client.Unauthorized Forbidden
Raise: com.vmware.vapi.std.errors_client.NotFound Not Found

get(tier1_id)¶

Read Tier-1 configuration

Parameters: tier1_id (str) – (required)
Return type: com.vmware.nsx_policy.model_client.Tier1
Returns: com.vmware.nsx_policy.model.Tier1
Raise: com.vmware.vapi.std.errors_client.ServiceUnavailable Service Unavailable
Raise: com.vmware.vapi.std.errors_client.InvalidRequest Bad Request, Precondition Failed
Raise: com.vmware.vapi.std.errors_client.InternalServerError Internal Server Error
Raise: com.vmware.vapi.std.errors_client.Unauthorized Forbidden
Raise: com.vmware.vapi.std.errors_client.NotFound Not Found

patch(tier1_id, tier1)¶

If Tier-1 with the tier-1-id is not already present, create a new Tier-1 instance. If it already exists, update the tier-1 instance with specified attributes.

Parameters

tier1_id (str) – (required)
tier1 (com.vmware.nsx_policy.model_client.Tier1) – (required)

Raise

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

Raise

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

Raise

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

Raise

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

Raise

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

update(tier1_id, tier1)¶

If Tier-1 with the tier-1-id is not already present, create a new Tier-1 instance. If it already exists, replace the Tier-1 instance with this object.

Parameters

tier1_id (str) – (required)
tier1 (com.vmware.nsx_policy.model_client.Tier1) – (required)

Return type

com.vmware.nsx_policy.model_client.Tier1

Returns

com.vmware.nsx_policy.model.Tier1

Raise

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

Raise

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

Raise

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

Raise

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

Raise

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

com.vmware.nsx_policy.model_client module¶

class com.vmware.nsx_policy.model_client.ALGTypeServiceEntry(alg=None, destination_ports=None, source_ports=None, links=None, schema=None, self_=None, revision=None, create_time=None, create_user=None, last_modified_time=None, last_modified_user=None, protection=None, system_owned=None, description=None, display_name=None, id=None, resource_type='ALGTypeServiceEntry', tags=None, parent_path=None, path=None, relative_path=None, children=None, marked_for_delete=None)¶

Bases: vmware.vapi.bindings.struct.VapiStruct

An ServiceEntry that represents an ALG protocol

Tip

The arguments are used to initialize data attributes with the same names.

Parameters

alg (str) –
Possible values are:
- ALGTypeServiceEntry.ALG_ORACLE_TNS
- ALGTypeServiceEntry.ALG_FTP
- ALGTypeServiceEntry.ALG_SUN_RPC_TCP
- ALGTypeServiceEntry.ALG_SUN_RPC_UDP
- ALGTypeServiceEntry.ALG_MS_RPC_TCP
- ALGTypeServiceEntry.ALG_MS_RPC_UDP
- ALGTypeServiceEntry.ALG_NBNS_BROADCAST
- ALGTypeServiceEntry.ALG_NBDG_BROADCAST
- ALGTypeServiceEntry.ALG_TFTP
The Application Layer Gateway (ALG) protocol. Please note, protocol NBNS_BROADCAST and NBDG_BROADCAST are deprecated. Please use UDP protocol and create L4 Port Set type of service instead.
destination_ports (list of str) – The destination_port cannot be empty and must be a single value. format: port-or-range
source_ports (list of str or None) –
links (list of ResourceLink or None) – The server will populate this field when returing the resource. Ignored on PUT and POST. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
schema (str or None) – Schema for this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
self (SelfResourceLink or None) – Link to this resource
revision (long or None) – The _revision property describes the current revision of the resource. To prevent clients from overwriting each other’s changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected. format: int32
create_time (long or None) – Timestamp of resource creation format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
create_user (str or None) – ID of the user who created this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
last_modified_time (long or None) – Timestamp of last modification format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
last_modified_user (str or None) – ID of the user who last modified this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
protection (str or None) – Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super user and can modify it, but only when providing the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this entity. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
system_owned (bool or None) – Indicates system owned resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
description (str or None) – Description of this resource
display_name (str or None) – Defaults to ID if not set
id (str or None) – Unique identifier of this resource
resource_type (str) –
Possible values are:
- ServiceEntry.RESOURCE_TYPE_IPPROTOCOLSERVICEENTRY
- ServiceEntry.RESOURCE_TYPE_IGMPTYPESERVICEENTRY
- ServiceEntry.RESOURCE_TYPE_ICMPTYPESERVICEENTRY
- ServiceEntry.RESOURCE_TYPE_ALGTYPESERVICEENTRY
- ServiceEntry.RESOURCE_TYPE_L4PORTSETSERVICEENTRY
- ServiceEntry.RESOURCE_TYPE_ETHERTYPESERVICEENTRY
tags (list of Tag or None) – Opaque identifiers meaningful to the API user
parent_path (str or None) – Path of its parent This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
path (str or None) – Absolute path of this object This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
relative_path (str or None) – Path relative from its parent This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
children (list of vmware.vapi.struct.VapiStruct or None) – subtree for this type within policy tree containing nested elements. When clients pass a value of this class as a parameter, the attribute must contain all the attributes defined in ChildPolicyConfigResource. When methods return a value of this class as a return value, the attribute will contain all the attributes defined in ChildPolicyConfigResource.
marked_for_delete (bool or None) – Intent objects are not directly deleted from the system when a delete is invoked on them. They are marked for deletion and only when all the realized entities for that intent object gets deleted, the intent object is deleted. Objects that are marked for deletion are not returned in GET call. One can use the search API to get these objects. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.

ALG_FTP = 'FTP'¶

ALG_MS_RPC_TCP = 'MS_RPC_TCP'¶

ALG_MS_RPC_UDP = 'MS_RPC_UDP'¶

ALG_NBDG_BROADCAST = 'NBDG_BROADCAST'¶

ALG_NBNS_BROADCAST = 'NBNS_BROADCAST'¶

ALG_ORACLE_TNS = 'ORACLE_TNS'¶

ALG_SUN_RPC_TCP = 'SUN_RPC_TCP'¶

ALG_SUN_RPC_UDP = 'SUN_RPC_UDP'¶

ALG_TFTP = 'TFTP'¶

property resource_type¶: Return the discriminator value

class com.vmware.nsx_policy.model_client.AbstractSpace(links=None, schema=None, self_=None, revision=None, create_time=None, create_user=None, last_modified_time=None, last_modified_user=None, protection=None, system_owned=None, description=None, display_name=None, id=None, resource_type=None, tags=None, parent_path=None, path=None, relative_path=None, children=None, marked_for_delete=None, connectivity_strategy=None)¶

Bases: vmware.vapi.bindings.struct.VapiStruct

Represents the space in which the policy is being defined.

Tip

The arguments are used to initialize data attributes with the same names.

Parameters

links (list of ResourceLink or None) – The server will populate this field when returing the resource. Ignored on PUT and POST. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
schema (str or None) – Schema for this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
self (SelfResourceLink or None) – Link to this resource
revision (long or None) – The _revision property describes the current revision of the resource. To prevent clients from overwriting each other’s changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected. format: int32
create_time (long or None) – Timestamp of resource creation format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
create_user (str or None) – ID of the user who created this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
last_modified_time (long or None) – Timestamp of last modification format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
last_modified_user (str or None) – ID of the user who last modified this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
protection (str or None) – Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super user and can modify it, but only when providing the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this entity. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
system_owned (bool or None) – Indicates system owned resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
description (str or None) – Description of this resource
display_name (str or None) – Defaults to ID if not set
id (str or None) – Unique identifier of this resource
resource_type (str or None) – The type of this resource.
tags (list of Tag or None) – Opaque identifiers meaningful to the API user
parent_path (str or None) – Path of its parent This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
path (str or None) – Absolute path of this object This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
relative_path (str or None) – Path relative from its parent This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
children (list of vmware.vapi.struct.VapiStruct or None) – subtree for this type within policy tree containing nested elements. When clients pass a value of this class as a parameter, the attribute must contain all the attributes defined in ChildPolicyConfigResource. When methods return a value of this class as a return value, the attribute will contain all the attributes defined in ChildPolicyConfigResource.
marked_for_delete (bool or None) – Intent objects are not directly deleted from the system when a delete is invoked on them. They are marked for deletion and only when all the realized entities for that intent object gets deleted, the intent object is deleted. Objects that are marked for deletion are not returned in GET call. One can use the search API to get these objects. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
connectivity_strategy (str or None) –
Possible values are:
- AbstractSpace.CONNECTIVITY_STRATEGY_WHITELIST
- AbstractSpace.CONNECTIVITY_STRATEGY_BLACKLIST
- AbstractSpace.CONNECTIVITY_STRATEGY_WHITELIST_ENABLE_LOGGING
- AbstractSpace.CONNECTIVITY_STRATEGY_BLACKLIST_ENABLE_LOGGING
- AbstractSpace.CONNECTIVITY_STRATEGY_NONE
This field indicates the default connectivity policy for the infra or tenant space WHITELIST - Adds a default drop rule. Administrator can then use “allow” rules (aka whitelist) to allow traffic between groups BLACKLIST - Adds a default allow rule. Admin can then use “drop” rules (aka blacklist) to block traffic between groups WHITELIST_ENABLE_LOGGING - Whitelising with logging enabled BLACKLIST_ENABLE_LOGGING - Blacklisting with logging enabled NONE - No default rules are added.

CONNECTIVITY_STRATEGY_BLACKLIST = 'BLACKLIST'¶

CONNECTIVITY_STRATEGY_BLACKLIST_ENABLE_LOGGING = 'BLACKLIST_ENABLE_LOGGING'¶

CONNECTIVITY_STRATEGY_NONE = 'NONE'¶

CONNECTIVITY_STRATEGY_WHITELIST = 'WHITELIST'¶

CONNECTIVITY_STRATEGY_WHITELIST_ENABLE_LOGGING = 'WHITELIST_ENABLE_LOGGING'¶

class com.vmware.nsx_policy.model_client.Action(resource_type='Action')¶

Bases: vmware.vapi.bindings.struct.VapiStruct

Reaction Action is the action to take when the stipulated criteria specified in the event exist over the source. Some example actions include: - Notify Admin (or VMC’s SRE) via email. - Populate a specific label with the IPSec VPN Session. - Remove the IPSec VPN Session from a specific label.

Tip

The arguments are used to initialize data attributes with the same names.

Parameters

resource_type (str) –

Possible values are:

Action.RESOURCE_TYPE_PATCHRESOURCES
Action.RESOURCE_TYPE_SETFIELDS

Reaction Action resource type.

RESOURCE_TYPE_PATCHRESOURCES = 'PatchResources'¶

RESOURCE_TYPE_SETFIELDS = 'SetFields'¶

property resource_type¶: Return the discriminator value

class com.vmware.nsx_policy.model_client.AggregateDNSForwarderStatistics(intent_path=None, statistics_per_enforcement_point=None)¶

Bases: vmware.vapi.bindings.struct.VapiStruct

Aggregate of DNS forwarder statistics across enforcement points.

Tip

The arguments are used to initialize data attributes with the same names.

Parameters

intent_path (str) – String path of the DNS forwarder intent.
statistics_per_enforcement_point (list of vmware.vapi.struct.VapiStruct or None) – List of DNS forwarder statistics per enforcement point. When clients pass a value of this class as a parameter, the attribute must contain all the attributes defined in DNSForwarderStatisticsPerEnforcementPoint. When methods return a value of this class as a return value, the attribute will contain all the attributes defined in DNSForwarderStatisticsPerEnforcementPoint. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.

class com.vmware.nsx_policy.model_client.AggregateDNSForwarderStatus(intent_path=None, status_per_enforcement_point=None)¶

Bases: vmware.vapi.bindings.struct.VapiStruct

Aggregate of DNS forwarder status across enforcement points.

Tip

The arguments are used to initialize data attributes with the same names.

Parameters

intent_path (str) – String path of the DNS forwarder intent.
status_per_enforcement_point (list of vmware.vapi.struct.VapiStruct or None) – List of DNS forwarder status per enforcement point. When clients pass a value of this class as a parameter, the attribute must contain all the attributes defined in DNSForwarderStatusPerEnforcementPoint. When methods return a value of this class as a return value, the attribute will contain all the attributes defined in DNSForwarderStatusPerEnforcementPoint. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.

class com.vmware.nsx_policy.model_client.AggregateIPSecVpnSessionStatistics(intent_path=None, results=None)¶

Bases: vmware.vapi.bindings.struct.VapiStruct

Aggregate of IPSec VPN Session Statistics across Enforcement Points.

Tip

The arguments are used to initialize data attributes with the same names.

Parameters

intent_path (str or None) – Intent path of object, forward slashes must be escaped using %2F. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
results (list of vmware.vapi.struct.VapiStruct or None) – List of IPSec VPN Session Statistics per Enforcement Point. When clients pass a value of this class as a parameter, the attribute must contain all the attributes defined in IPSecVpnSessionStatisticsPerEP. When methods return a value of this class as a return value, the attribute will contain all the attributes defined in IPSecVpnSessionStatisticsPerEP. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.

class com.vmware.nsx_policy.model_client.AggregateIPSecVpnSessionStatus(intent_path=None, results=None)¶

Bases: vmware.vapi.bindings.struct.VapiStruct

Aggregate of IPSec VPN Session Status across Enforcement Points.

Tip

The arguments are used to initialize data attributes with the same names.

Parameters

intent_path (str or None) – Intent path of object, forward slashes must be escaped using %2F. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
results (list of vmware.vapi.struct.VapiStruct or None) – List of IPSec VPN Session Status per Enforcement Point. When clients pass a value of this class as a parameter, the attribute must contain all the attributes defined in IPSecVpnSessionStatusPerEP. When methods return a value of this class as a return value, the attribute will contain all the attributes defined in IPSecVpnSessionStatusPerEP. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.

class com.vmware.nsx_policy.model_client.AggregateL2VPNSessionPeerConfig(intent_path=None, results=None)¶

Bases: vmware.vapi.bindings.struct.VapiStruct

Aggregate of L2VPN Session peer config across Enforcement Points.

Tip

The arguments are used to initialize data attributes with the same names.

Parameters

intent_path (str or None) – Intent path of object, forward slashes must be escaped using %2F. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
results (list of vmware.vapi.struct.VapiStruct or None) – List of L2VPN Session peer config per Enforcement Point. When clients pass a value of this class as a parameter, the attribute must contain all the attributes defined in L2VPNSessionPeerConfigPerEP. When methods return a value of this class as a return value, the attribute will contain all the attributes defined in L2VPNSessionPeerConfigPerEP. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.

class com.vmware.nsx_policy.model_client.AggregateL2VPNSessionStatistics(intent_path=None, results=None)¶

Bases: vmware.vapi.bindings.struct.VapiStruct

Aggregate of L2VPN Session Statistics across Enforcement Points.

Tip

The arguments are used to initialize data attributes with the same names.

Parameters

intent_path (str or None) – Intent path of object, forward slashes must be escaped using %2F. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
results (list of vmware.vapi.struct.VapiStruct or None) – List of L2VPN Session Statistics per Enforcement Point. When clients pass a value of this class as a parameter, the attribute must contain all the attributes defined in L2VPNSessionStatisticsPerEP. When methods return a value of this class as a return value, the attribute will contain all the attributes defined in L2VPNSessionStatisticsPerEP. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.

class com.vmware.nsx_policy.model_client.AggregateL2VPNSessionStatus(intent_path=None, results=None)¶

Bases: vmware.vapi.bindings.struct.VapiStruct

Aggregate of L2VPN Session Status across Enforcement Points.

Tip

The arguments are used to initialize data attributes with the same names.

Parameters

intent_path (str or None) – Intent path of object, forward slashes must be escaped using %2F. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
results (list of vmware.vapi.struct.VapiStruct or None) – List of L2VPN Session Status per Enforcement Point. When clients pass a value of this class as a parameter, the attribute must contain all the attributes defined in L2VPNSessionStatusPerEP. When methods return a value of this class as a return value, the attribute will contain all the attributes defined in L2VPNSessionStatusPerEP. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.

class com.vmware.nsx_policy.model_client.AggregateL2VpnPeerConfig(l2vpn_path=None, l2vpn_peer_config_per_enforcement_point=None)¶

Bases: vmware.vapi.bindings.struct.VapiStruct

Aggregate of L2Vpn peer config across Enforcement Points.

Tip

The arguments are used to initialize data attributes with the same names.

Parameters

l2vpn_path (str) – Policy path referencing the L2Vpn.
l2vpn_peer_config_per_enforcement_point (list of vmware.vapi.struct.VapiStruct or None) – List of L2Vpn peer config per Enforcement Point. When clients pass a value of this class as a parameter, the attribute must contain all the attributes defined in L2VpnPeerConfigPerEnforcementPoint. When methods return a value of this class as a return value, the attribute will contain all the attributes defined in L2VpnPeerConfigPerEnforcementPoint. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.

class com.vmware.nsx_policy.model_client.AggregateL2VpnStatistics(intent_path=None, l2vpn_statistics_per_enforcement_point=None)¶

Bases: vmware.vapi.bindings.struct.VapiStruct

Aggregate of L2Vpn Statistics across Enforcement Points.

Tip

The arguments are used to initialize data attributes with the same names.

Parameters

intent_path (str) – Intent path of object, forward slashes must be escaped using %2F.
l2vpn_statistics_per_enforcement_point (list of vmware.vapi.struct.VapiStruct or None) – List of L2Vpn Statistics per Enforcement Point. When clients pass a value of this class as a parameter, the attribute must contain all the attributes defined in L2VpnStatisticsPerEnforcementPoint. When methods return a value of this class as a return value, the attribute will contain all the attributes defined in L2VpnStatisticsPerEnforcementPoint. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.

class com.vmware.nsx_policy.model_client.AggregateL3VpnStatistics(intent_path=None, l3vpn_statistics_per_enforcement_point=None)¶

Bases: vmware.vapi.bindings.struct.VapiStruct

Aggregate of L3Vpn Statistics across Enforcement Points.

Tip

The arguments are used to initialize data attributes with the same names.

Parameters

intent_path (str) – Intent path of object, forward slashes must be escaped using %2F.
l3vpn_statistics_per_enforcement_point (list of vmware.vapi.struct.VapiStruct or None) – List of L3Vpn Statistics per Enforcement Point. When clients pass a value of this class as a parameter, the attribute must contain all the attributes defined in L3VpnStatisticsPerEnforcementPoint. When methods return a value of this class as a return value, the attribute will contain all the attributes defined in L3VpnStatisticsPerEnforcementPoint. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.

class com.vmware.nsx_policy.model_client.AggregatePolicyDnsAnswer(dns_answer_per_enforcement_point=None, intent_path=None)¶

Bases: vmware.vapi.bindings.struct.VapiStruct

Aggregate of DNS forwarder nslookup answer across enforcement points.

Tip

The arguments are used to initialize data attributes with the same names.

Parameters

dns_answer_per_enforcement_point (list of vmware.vapi.struct.VapiStruct or None) – List of DNS forwarder nslookup answer per enforcement point. When clients pass a value of this class as a parameter, the attribute must contain all the attributes defined in PolicyDnsAnswerPerEnforcementPoint. When methods return a value of this class as a return value, the attribute will contain all the attributes defined in PolicyDnsAnswerPerEnforcementPoint. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
intent_path (str) – String path of the DNS forwarder intent.

class com.vmware.nsx_policy.model_client.AggregatePolicyRuntimeInfo(intent_path=None)¶

Bases: vmware.vapi.bindings.struct.VapiStruct

Aggregate of PolicyRuntimeInfoPerEP across Enforcement Points.

Tip

The arguments are used to initialize data attributes with the same names.

Parameters: intent_path (str or None) – Intent path of object, forward slashes must be escaped using %2F. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.

class com.vmware.nsx_policy.model_client.AggregatedDataCounter(rx_bytes=None, rx_packets=None, tx_bytes=None, tx_packets=None)¶

Bases: vmware.vapi.bindings.struct.VapiStruct

Tip

The arguments are used to initialize data attributes with the same names.

Parameters

rx_bytes (DataCounter or None) –
rx_packets (DataCounter or None) –
tx_bytes (DataCounter or None) –
tx_packets (DataCounter or None) –

class com.vmware.nsx_policy.model_client.AggregatedDataCounterEx(rx_bytes=None, rx_packets=None, tx_bytes=None, tx_packets=None, dropped_by_security_packets=None, mac_learning=None)¶

Bases: vmware.vapi.bindings.struct.VapiStruct

Tip

The arguments are used to initialize data attributes with the same names.

Parameters

rx_bytes (DataCounter or None) –
rx_packets (DataCounter or None) –
tx_bytes (DataCounter or None) –
tx_packets (DataCounter or None) –
dropped_by_security_packets (PacketsDroppedBySecurity or None) –
mac_learning (MacLearningCounters or None) –

class com.vmware.nsx_policy.model_client.AggregatedLogicalRouterPortCounters(last_update_timestamp=None, rx=None, tx=None)¶

Bases: vmware.vapi.bindings.struct.VapiStruct

Tip

The arguments are used to initialize data attributes with the same names.

Parameters

last_update_timestamp (long or None) – Timestamp when the data was last updated; unset if data source has never updated the data. format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
rx (LogicalRouterPortCounters or None) –
tx (LogicalRouterPortCounters or None) –

class com.vmware.nsx_policy.model_client.ApiError(details=None, error_code=None, error_data=None, error_message=None, module_name=None, related_errors=None)¶

Bases: vmware.vapi.bindings.struct.VapiStruct

Detailed information about an API Error

Tip

The arguments are used to initialize data attributes with the same names.

Parameters

details (str or None) – Further details about the error
error_code (long or None) – A numeric error code format: int64
error_data (vmware.vapi.struct.VapiStruct or None) – Additional data about the error
error_message (str or None) – A description of the error
module_name (str or None) – The module name where the error occurred
related_errors (list of RelatedApiError or None) – Other errors related to this error

class com.vmware.nsx_policy.model_client.ApiRequestBody(resource_pointer=None, resource_type='ApiRequestBody')¶

Bases: vmware.vapi.bindings.struct.VapiStruct

API Request Body is an Event Source that represents an API request body that is being reveived as part of an API. Supported Request Bodies are those received as part of a PATCH/PUT/POST request.

Tip

The arguments are used to initialize data attributes with the same names.

Parameters

resource_pointer (str) – Regex path representing a regex expression on resources. This regex is used to identify the request body(ies) that is/are the source of the Event. For instance: specifying “Lb* | /infra/tier-0s/vmc/ipsec-vpn-services/default” as a source means that ANY resource starting with Lb or ANY resource with “/infra/tier-0s/vmc/ipsec-vpn-services/default” as path would be the source of the event in question.
resource_type (str) –
Possible values are:
- Source.RESOURCE_TYPE_RESOURCEOPERATION
- Source.RESOURCE_TYPE_APIREQUESTBODY
Event Source resource type.

property resource_type¶: Return the discriminator value

class com.vmware.nsx_policy.model_client.ArpSnoopingConfig(arp_binding_limit=None, arp_snooping_enabled=None)¶

Bases: vmware.vapi.bindings.struct.VapiStruct

Contains ARP snooping related configuration.

Tip

The arguments are used to initialize data attributes with the same names.

Parameters

arp_binding_limit (long or None) – Number of arp snooped IP addresses Indicates the number of arp snooped IP addresses to be remembered per LogicalPort. Decreasing this value, will retain the latest bindings from the existing list of address bindings. Increasing this value will retain existing bindings and also learn any new address bindings discovered on the port until the new limit is reached. format: int32
arp_snooping_enabled (bool or None) – Indicates whether ARP snooping is enabled

class com.vmware.nsx_policy.model_client.Attribute(attribute_type=None, display_name=None, key=None, read_only=None, value=None)¶

Bases: vmware.vapi.bindings.struct.VapiStruct

Attribute specific to a partner. There attributes are passed on to the partner appliance and is opaque to the NSX Manager. The Attributes used by the partner applicance.

Tip

The arguments are used to initialize data attributes with the same names.

Parameters

attribute_type (str or None) –
Possible values are:
Attribute Type can be of any of the allowed enum type.
display_name (str or None) – Attribute display name string value.
key (str) – Attribute key string value.
read_only (bool or None) – Read only Attribute cannot be overdidden by service instance/deployment.
value (str or None) – Attribute value string value.

ATTRIBUTE_TYPE_BOOLEAN = 'BOOLEAN'¶

ATTRIBUTE_TYPE_IP_ADDRESS = 'IP_ADDRESS'¶

ATTRIBUTE_TYPE_LONG = 'LONG'¶

ATTRIBUTE_TYPE_PASSWORD = 'PASSWORD'¶

ATTRIBUTE_TYPE_PORT = 'PORT'¶

ATTRIBUTE_TYPE_STRING = 'STRING'¶

class com.vmware.nsx_policy.model_client.AttributeVal(data_type=None, key=None, multivalue=None, values=None)¶

Bases: vmware.vapi.bindings.struct.VapiStruct

Contains type specific properties of generic realized entity

Tip

The arguments are used to initialize data attributes with the same names.

Parameters

data_type (str or None) –
Possible values are:
Datatype of the property

This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
key (str or None) – Attribute key
multivalue (bool or None) – If attribute has a single value or collection of values This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
values (list of str or None) – List of attribute values This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.

DATA_TYPE_BOOLEAN = 'BOOLEAN'¶

DATA_TYPE_DATE = 'DATE'¶

DATA_TYPE_INTEGER = 'INTEGER'¶

DATA_TYPE_STRING = 'STRING'¶

class com.vmware.nsx_policy.model_client.Axes(x_label=None, y_label=None)¶

Bases: vmware.vapi.bindings.struct.VapiStruct

Represents X and Y axes of a graph. For a multi-graph, the same axes are shared by all the graphs.

Tip

The arguments are used to initialize data attributes with the same names.

Parameters

x_label (Label or None) – Label for X axis of a graph
y_label (Label or None) – Label for Y axis of a graph

class com.vmware.nsx_policy.model_client.BaseEndpoint(links=None, schema=None, self_=None, revision=None, create_time=None, create_user=None, last_modified_time=None, last_modified_user=None, protection=None, system_owned=None, description=None, display_name=None, id=None, resource_type='BaseEndpoint', tags=None, parent_path=None, path=None, relative_path=None, children=None, marked_for_delete=None, target_ips=None)¶

Bases: vmware.vapi.bindings.struct.VapiStruct

Represents an endpoint which will be used as subject in rule. It is a polymorphic type object which can be either of the types - 1. Virtual 2. Logical We have 2 separate objects representing these 2 types. VirtualEndPoint for Virtual type and ServiceInstanceEndpoint for Logical.

Tip

The arguments are used to initialize data attributes with the same names.

Parameters

links (list of ResourceLink or None) – The server will populate this field when returing the resource. Ignored on PUT and POST. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
schema (str or None) – Schema for this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
self (SelfResourceLink or None) – Link to this resource
revision (long or None) – The _revision property describes the current revision of the resource. To prevent clients from overwriting each other’s changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected. format: int32
create_time (long or None) – Timestamp of resource creation format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
create_user (str or None) – ID of the user who created this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
last_modified_time (long or None) – Timestamp of last modification format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
last_modified_user (str or None) – ID of the user who last modified this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
protection (str or None) – Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super user and can modify it, but only when providing the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this entity. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
system_owned (bool or None) – Indicates system owned resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
description (str or None) – Description of this resource
display_name (str or None) – Defaults to ID if not set
id (str or None) – Unique identifier of this resource
resource_type (str) –
Possible values are:
- BaseEndpoint.RESOURCE_TYPE_VIRTUALENDPOINT
- BaseEndpoint.RESOURCE_TYPE_SERVICEINSTANCEENDPOINT
tags (list of Tag or None) – Opaque identifiers meaningful to the API user
parent_path (str or None) – Path of its parent This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
path (str or None) – Absolute path of this object This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
relative_path (str or None) – Path relative from its parent This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
children (list of vmware.vapi.struct.VapiStruct or None) – subtree for this type within policy tree containing nested elements. When clients pass a value of this class as a parameter, the attribute must contain all the attributes defined in ChildPolicyConfigResource. When methods return a value of this class as a return value, the attribute will contain all the attributes defined in ChildPolicyConfigResource.
marked_for_delete (bool or None) – Intent objects are not directly deleted from the system when a delete is invoked on them. They are marked for deletion and only when all the realized entities for that intent object gets deleted, the intent object is deleted. Objects that are marked for deletion are not returned in GET call. One can use the search API to get these objects. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
target_ips (list of IPInfo) – IPs where either inbound or outbound traffic is to be redirected.

RESOURCE_TYPE_SERVICEINSTANCEENDPOINT = 'ServiceInstanceEndpoint'¶

RESOURCE_TYPE_VIRTUALENDPOINT = 'VirtualEndpoint'¶

property resource_type¶: Return the discriminator value

class com.vmware.nsx_policy.model_client.BasePolicyServiceInstance(links=None, schema=None, self_=None, revision=None, create_time=None, create_user=None, last_modified_time=None, last_modified_user=None, protection=None, system_owned=None, description=None, display_name=None, id=None, resource_type=None, tags=None, parent_path=None, path=None, relative_path=None, children=None, marked_for_delete=None, deployment_mode=None, partner_service_name=None, transport_type=None)¶

Bases: vmware.vapi.bindings.struct.VapiStruct

Represents an instance of partner Service and its configuration.

Tip

The arguments are used to initialize data attributes with the same names.

Parameters

links (list of ResourceLink or None) – The server will populate this field when returing the resource. Ignored on PUT and POST. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
schema (str or None) – Schema for this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
self (SelfResourceLink or None) – Link to this resource
revision (long or None) – The _revision property describes the current revision of the resource. To prevent clients from overwriting each other’s changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected. format: int32
create_time (long or None) – Timestamp of resource creation format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
create_user (str or None) – ID of the user who created this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
last_modified_time (long or None) – Timestamp of last modification format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
last_modified_user (str or None) – ID of the user who last modified this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
protection (str or None) – Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super user and can modify it, but only when providing the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this entity. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
system_owned (bool or None) – Indicates system owned resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
description (str or None) – Description of this resource
display_name (str or None) – Defaults to ID if not set
id (str or None) – Unique identifier of this resource
resource_type (str or None) – The type of this resource.
tags (list of Tag or None) – Opaque identifiers meaningful to the API user
parent_path (str or None) – Path of its parent This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
path (str or None) – Absolute path of this object This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
relative_path (str or None) – Path relative from its parent This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
children (list of vmware.vapi.struct.VapiStruct or None) – subtree for this type within policy tree containing nested elements. When clients pass a value of this class as a parameter, the attribute must contain all the attributes defined in ChildPolicyConfigResource. When methods return a value of this class as a return value, the attribute will contain all the attributes defined in ChildPolicyConfigResource.
marked_for_delete (bool or None) – Intent objects are not directly deleted from the system when a delete is invoked on them. They are marked for deletion and only when all the realized entities for that intent object gets deleted, the intent object is deleted. Objects that are marked for deletion are not returned in GET call. One can use the search API to get these objects. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
deployment_mode (str or None) –
Possible values are:
- BasePolicyServiceInstance.DEPLOYMENT_MODE_STAND_ALONE
- BasePolicyServiceInstance.DEPLOYMENT_MODE_ACTIVE_STANDBY
Deployment mode specifies how the partner appliance will be deployed i.e. in HA or standalone mode.
partner_service_name (str) – Unique name of Partner Service in the Marketplace
transport_type (str or None) –
Possible values are:
- BasePolicyServiceInstance.TRANSPORT_TYPE_L2_BRIDGE
- BasePolicyServiceInstance.TRANSPORT_TYPE_L3_ROUTED
Transport to be used while deploying Service-VM.

DEPLOYMENT_MODE_ACTIVE_STANDBY = 'ACTIVE_STANDBY'¶

DEPLOYMENT_MODE_STAND_ALONE = 'STAND_ALONE'¶

TRANSPORT_TYPE_L2_BRIDGE = 'L2_BRIDGE'¶

TRANSPORT_TYPE_L3_ROUTED = 'L3_ROUTED'¶

class com.vmware.nsx_policy.model_client.BaseRule(links=None, schema=None, self_=None, revision=None, create_time=None, create_user=None, last_modified_time=None, last_modified_user=None, protection=None, system_owned=None, description=None, display_name=None, id=None, resource_type=None, tags=None, parent_path=None, path=None, relative_path=None, children=None, marked_for_delete=None, destination_groups=None, destinations_excluded=None, direction=None, disabled=None, ip_protocol=None, logged=None, notes=None, profiles=None, scope=None, sequence_number=None, services=None, source_groups=None, sources_excluded=None, tag=None)¶

Bases: vmware.vapi.bindings.struct.VapiStruct

A rule indicates the action to be performed for various types of traffic flowing between workload groups.

Tip

The arguments are used to initialize data attributes with the same names.

Parameters

links (list of ResourceLink or None) – The server will populate this field when returing the resource. Ignored on PUT and POST. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
schema (str or None) – Schema for this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
self (SelfResourceLink or None) – Link to this resource
revision (long or None) – The _revision property describes the current revision of the resource. To prevent clients from overwriting each other’s changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected. format: int32
create_time (long or None) – Timestamp of resource creation format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
create_user (str or None) – ID of the user who created this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
last_modified_time (long or None) – Timestamp of last modification format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
last_modified_user (str or None) – ID of the user who last modified this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
protection (str or None) – Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super user and can modify it, but only when providing the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this entity. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
system_owned (bool or None) – Indicates system owned resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
description (str or None) – Description of this resource
display_name (str or None) – Defaults to ID if not set
id (str or None) – Unique identifier of this resource
resource_type (str or None) – The type of this resource.
tags (list of Tag or None) – Opaque identifiers meaningful to the API user
parent_path (str or None) – Path of its parent This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
path (str or None) – Absolute path of this object This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
relative_path (str or None) – Path relative from its parent This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
children (list of vmware.vapi.struct.VapiStruct or None) – subtree for this type within policy tree containing nested elements. When clients pass a value of this class as a parameter, the attribute must contain all the attributes defined in ChildPolicyConfigResource. When methods return a value of this class as a return value, the attribute will contain all the attributes defined in ChildPolicyConfigResource.
marked_for_delete (bool or None) – Intent objects are not directly deleted from the system when a delete is invoked on them. They are marked for deletion and only when all the realized entities for that intent object gets deleted, the intent object is deleted. Objects that are marked for deletion are not returned in GET call. One can use the search API to get these objects. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
destination_groups (list of str or None) – We need paths as duplicate names may exist for groups under different domains.In order to specify all groups, use the constant “ANY”. This is case insensitive. If “ANY” is used, it should be the ONLY element in the group array. Error will be thrown if ANY is used in conjunction with other values.
destinations_excluded (bool or None) – If set to true, the rule gets applied on all the groups that are NOT part of the destination groups. If false, the rule applies to the destination groups
direction (str or None) –
Possible values are:
- BaseRule.DIRECTION_IN
- BaseRule.DIRECTION_OUT
- BaseRule.DIRECTION_IN_OUT
Define direction of traffic.
disabled (bool or None) – Flag to disable the rule. Default is enabled.
ip_protocol (str or None) –
Possible values are:
- BaseRule.IP_PROTOCOL_IPV4
- BaseRule.IP_PROTOCOL_IPV6
- BaseRule.IP_PROTOCOL_IPV4_IPV6
Type of IP packet that should be matched while enforcing the rule. The value is set to IPV4_IPV6 for Layer3 rule if not specified. For Layer2/Ether rule the value must be null.
logged (bool or None) – Flag to enable packet logging. Default is disabled.
notes (str or None) – Text for additional notes on changes.
profiles (list of str or None) – Holds the list of layer 7 service profile paths. These profiles accept attributes and sub-attributes of various network services (e.g. L4 AppId, encryption algorithm, domain name, etc) as key value pairs.
scope (list of str or None) – The list of policy paths where the rule is applied LR/Edge/T0/T1/LRP etc. Note that a given rule can be applied on multiple LRs/LRPs.
sequence_number (long or None) – This field is used to resolve conflicts between multiple Rules under Security or Gateway Policy for a Domain If no sequence number is specified in the payload, a value of 0 is assigned by default. If there are multiple rules with the same sequence number then their order is not deterministic. If a specific order of rules is desired, then one has to specify unique sequence numbers or use the POST request on the rule entity with a query parameter action=revise to let the framework assign a sequence number format: int32
services (list of str or None) – In order to specify all services, use the constant “ANY”. This is case insensitive. If “ANY” is used, it should be the ONLY element in the services array. Error will be thrown if ANY is used in conjunction with other values.
source_groups (list of str or None) – We need paths as duplicate names may exist for groups under different domains. In order to specify all groups, use the constant “ANY”. This is case insensitive. If “ANY” is used, it should be the ONLY element in the group array. Error will be thrown if ANY is used in conjunction with other values.
sources_excluded (bool or None) – If set to true, the rule gets applied on all the groups that are NOT part of the source groups. If false, the rule applies to the source groups
tag (str or None) – User level field which will be printed in CLI and packet logs.

DIRECTION_IN = 'IN'¶

DIRECTION_IN_OUT = 'IN_OUT'¶

DIRECTION_OUT = 'OUT'¶

IP_PROTOCOL_IPV4 = 'IPV4'¶

IP_PROTOCOL_IPV4_IPV6 = 'IPV4_IPV6'¶

IP_PROTOCOL_IPV6 = 'IPV6'¶

class com.vmware.nsx_policy.model_client.BaseRuleListResult(links=None, schema=None, self_=None, cursor=None, result_count=None, sort_ascending=None, sort_by=None)¶

Bases: vmware.vapi.bindings.struct.VapiStruct

Paged Collection of Rules

Tip

The arguments are used to initialize data attributes with the same names.

Parameters

links (list of ResourceLink or None) – The server will populate this field when returing the resource. Ignored on PUT and POST. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
schema (str or None) – Schema for this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
self (SelfResourceLink or None) – Link to this resource
cursor (str or None) – Opaque cursor to be used for getting next page of records (supplied by current result page) This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
result_count (long or None) – Count of results found (across all pages), set only on first page format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
sort_ascending (bool or None) – If true, results are sorted in ascending order This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
sort_by (str or None) – Field by which records are sorted This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.

class com.vmware.nsx_policy.model_client.BaseTier0Interface(links=None, schema=None, self_=None, revision=None, create_time=None, create_user=None, last_modified_time=None, last_modified_user=None, protection=None, system_owned=None, description=None, display_name=None, id=None, resource_type=None, tags=None, parent_path=None, path=None, relative_path=None, children=None, marked_for_delete=None, subnets=None)¶

Bases: vmware.vapi.bindings.struct.VapiStruct

Tier-0 interface configuration for external connectivity.

Tip

The arguments are used to initialize data attributes with the same names.

Parameters

links (list of ResourceLink or None) – The server will populate this field when returing the resource. Ignored on PUT and POST. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
schema (str or None) – Schema for this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
self (SelfResourceLink or None) – Link to this resource
revision (long or None) – The _revision property describes the current revision of the resource. To prevent clients from overwriting each other’s changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected. format: int32
create_time (long or None) – Timestamp of resource creation format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
create_user (str or None) – ID of the user who created this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
last_modified_time (long or None) – Timestamp of last modification format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
last_modified_user (str or None) – ID of the user who last modified this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
protection (str or None) – Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super user and can modify it, but only when providing the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this entity. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
system_owned (bool or None) – Indicates system owned resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
description (str or None) – Description of this resource
display_name (str or None) – Defaults to ID if not set
id (str or None) – Unique identifier of this resource
resource_type (str or None) – The type of this resource.
tags (list of Tag or None) – Opaque identifiers meaningful to the API user
parent_path (str or None) – Path of its parent This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
path (str or None) – Absolute path of this object This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
relative_path (str or None) – Path relative from its parent This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
children (list of vmware.vapi.struct.VapiStruct or None) – subtree for this type within policy tree containing nested elements. When clients pass a value of this class as a parameter, the attribute must contain all the attributes defined in ChildPolicyConfigResource. When methods return a value of this class as a return value, the attribute will contain all the attributes defined in ChildPolicyConfigResource.
marked_for_delete (bool or None) – Intent objects are not directly deleted from the system when a delete is invoked on them. They are marked for deletion and only when all the realized entities for that intent object gets deleted, the intent object is deleted. Objects that are marked for deletion are not returned in GET call. One can use the search API to get these objects. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
subnets (list of InterfaceSubnet) – Specify IP address and network prefix for interface.

class com.vmware.nsx_policy.model_client.BgpBfdConfig(enabled=None, interval=None, multiple=None)¶

Bases: vmware.vapi.bindings.struct.VapiStruct

BFD configuration for BGP peers

Tip

The arguments are used to initialize data attributes with the same names.

Parameters

enabled (bool or None) – Flag to enable BFD cofiguration.
interval (long or None) – Time interval between heartbeat packets in milliseconds. format: int32
multiple (long or None) – Declare dead multiple. Number of times heartbeat packet is missed before BFD declares the neighbor is down. format: int32

class com.vmware.nsx_policy.model_client.BgpGracefulRestartConfig(mode=None, timer=None)¶

Bases: vmware.vapi.bindings.struct.VapiStruct

Configuration field to hold BGP restart mode and timer.

Tip

The arguments are used to initialize data attributes with the same names.

Parameters

mode (str or None) –
Possible values are:
If mode is DISABLE, then graceful restart and helper modes are disabled. If mode is GR_AND_HELPER, then both graceful restart and helper modes are enabled. If mode is HELPER_ONLY, then helper mode is enabled. HELPER_ONLY mode is the ability for a BGP speaker to indicate its ability to preserve forwarding state during BGP restart. GRACEFUL_RESTART mode is the ability of a BGP speaker to advertise its restart to its peers.
timer (BgpGracefulRestartTimer or None) – Configuration field to hold BGP restart timers.

MODE_DISABLE = 'DISABLE'¶

MODE_GR_AND_HELPER = 'GR_AND_HELPER'¶

MODE_HELPER_ONLY = 'HELPER_ONLY'¶

class com.vmware.nsx_policy.model_client.BgpGracefulRestartTimer(restart_timer=None, stale_route_timer=None)¶

Bases: vmware.vapi.bindings.struct.VapiStruct

Configuration field to hold BGP restart timers

Tip

The arguments are used to initialize data attributes with the same names.

Parameters

restart_timer (long or None) – Maximum time taken (in seconds) for a BGP session to be established after a restart. This can be used to speed up routing convergence by its peer in case the BGP speaker does not come back up after a restart. If the session is not re-established within this timer, the receiving speaker will delete all the stale routes from that peer. format: int64
stale_route_timer (long or None) – Maximum time (in seconds) before stale routes are removed from the RIB (Routing Information Base) when BGP restarts. format: int64

class com.vmware.nsx_policy.model_client.BgpNeighborConfig(links=None, schema=None, self_=None, revision=None, create_time=None, create_user=None, last_modified_time=None, last_modified_user=None, protection=None, system_owned=None, description=None, display_name=None, id=None, resource_type=None, tags=None, parent_path=None, path=None, relative_path=None, children=None, marked_for_delete=None, allow_as_in=None, bfd=None, graceful_restart_mode=None, hold_down_time=None, in_route_filters=None, keep_alive_time=None, maximum_hop_limit=None, neighbor_address=None, out_route_filters=None, password=None, remote_as_num=None, route_filtering=None, source_addresses=None)¶

Bases: vmware.vapi.bindings.struct.VapiStruct

Contains information necessary to configure a BGP neighbor.

Tip

The arguments are used to initialize data attributes with the same names.

Parameters

links (list of ResourceLink or None) – The server will populate this field when returing the resource. Ignored on PUT and POST. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
schema (str or None) – Schema for this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
self (SelfResourceLink or None) – Link to this resource
revision (long or None) – The _revision property describes the current revision of the resource. To prevent clients from overwriting each other’s changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected. format: int32
create_time (long or None) – Timestamp of resource creation format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
create_user (str or None) – ID of the user who created this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
last_modified_time (long or None) – Timestamp of last modification format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
last_modified_user (str or None) – ID of the user who last modified this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
protection (str or None) – Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super user and can modify it, but only when providing the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this entity. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
system_owned (bool or None) – Indicates system owned resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
description (str or None) – Description of this resource
display_name (str or None) – Defaults to ID if not set
id (str or None) – Unique identifier of this resource
resource_type (str or None) – The type of this resource.
tags (list of Tag or None) – Opaque identifiers meaningful to the API user
parent_path (str or None) – Path of its parent This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
path (str or None) – Absolute path of this object This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
relative_path (str or None) – Path relative from its parent This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
children (list of vmware.vapi.struct.VapiStruct or None) – subtree for this type within policy tree containing nested elements. When clients pass a value of this class as a parameter, the attribute must contain all the attributes defined in ChildPolicyConfigResource. When methods return a value of this class as a return value, the attribute will contain all the attributes defined in ChildPolicyConfigResource.
marked_for_delete (bool or None) – Intent objects are not directly deleted from the system when a delete is invoked on them. They are marked for deletion and only when all the realized entities for that intent object gets deleted, the intent object is deleted. Objects that are marked for deletion are not returned in GET call. One can use the search API to get these objects. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
allow_as_in (bool or None) – Flag to enable allowas_in option for BGP neighbor
bfd (BgpBfdConfig or None) – BFD configuration for failure detection. BFD is enabled with default values when not configured.
graceful_restart_mode (str or None) –
Possible values are:
- BgpNeighborConfig.GRACEFUL_RESTART_MODE_DISABLE
- BgpNeighborConfig.GRACEFUL_RESTART_MODE_GR_AND_HELPER
- BgpNeighborConfig.GRACEFUL_RESTART_MODE_HELPER_ONLY
If mode is DISABLE, then graceful restart and helper modes are disabled. If mode is GR_AND_HELPER, then both graceful restart and helper modes are enabled. If mode is HELPER_ONLY, then helper mode is enabled. HELPER_ONLY mode is the ability for a BGP speaker to indicate its ability to preserve forwarding state during BGP restart. GRACEFUL_RESTART mode is the ability of a BGP speaker to advertise its restart to its peers.
hold_down_time (long or None) – Wait time in seconds before declaring peer dead. format: int32
in_route_filters (list of str or None) – Specify path of prefix-list or route map to filter routes for IN direction. This property is deprecated, use route_filtering instead. Specifying different values for both properties will result in error.
keep_alive_time (long or None) – Interval (in seconds) between keep alive messages sent to peer. format: int32
maximum_hop_limit (long or None) – Maximum number of hops allowed to reach BGP neighbor. format: int32
neighbor_address (str) – Neighbor IP Address format: ip
out_route_filters (list of str or None) – Specify path of prefix-list or route map to filter routes for OUT direction. When not specified, a built-in prefix-list named ‘prefixlist-out-default’ is automatically applied. This property is deprecated, use route_filtering instead. Specifying different values for both properties will result in error.
password (str or None) – Specify password for BGP neighbor authentication. Empty string (“”) clears existing password.
remote_as_num (str) – 4 Byte ASN of the neighbor in ASPLAIN Format
route_filtering (list of BgpRouteFiltering or None) – Enable address families and route filtering in each direction.
source_addresses (list of str or None) – Source addresses should belong to Tier0 external or loopback interface IP Addresses . BGP peering is formed from all these addresses. This property is mandatory when maximum_hop_limit is greater than 1. format: ip

GRACEFUL_RESTART_MODE_DISABLE = 'DISABLE'¶

GRACEFUL_RESTART_MODE_GR_AND_HELPER = 'GR_AND_HELPER'¶

GRACEFUL_RESTART_MODE_HELPER_ONLY = 'HELPER_ONLY'¶

class com.vmware.nsx_policy.model_client.BgpNeighborConfigListResult(links=None, schema=None, self_=None, cursor=None, result_count=None, sort_ascending=None, sort_by=None, results=None)¶

Bases: vmware.vapi.bindings.struct.VapiStruct

Paged collection of BGP Neighbor Configs

Tip

The arguments are used to initialize data attributes with the same names.

Parameters

links (list of ResourceLink or None) – The server will populate this field when returing the resource. Ignored on PUT and POST. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
schema (str or None) – Schema for this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
self (SelfResourceLink or None) – Link to this resource
cursor (str or None) – Opaque cursor to be used for getting next page of records (supplied by current result page) This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
result_count (long or None) – Count of results found (across all pages), set only on first page format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
sort_ascending (bool or None) – If true, results are sorted in ascending order This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
sort_by (str or None) – Field by which records are sorted This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
results (list of BgpNeighborConfig) – BGP neighbor configs list results

class com.vmware.nsx_policy.model_client.BgpNeighborRouteDetailsCsvRecord(as_path=None, local_pref=None, logical_router_id=None, med=None, neighbor_address=None, neighbor_id=None, network=None, next_hop=None, source_address=None, transport_node_id=None, weight=None)¶

Bases: vmware.vapi.bindings.struct.VapiStruct

BGP neighbor learned/advertised route details.

Tip

The arguments are used to initialize data attributes with the same names.

Parameters

as_path (str or None) – BGP AS path attribute. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
local_pref (long or None) – BGP Local Preference attribute. format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
logical_router_id (str or None) – Logical router id This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
med (long or None) – BGP Multi Exit Discriminator attribute. format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
neighbor_address (str or None) – BGP neighbor peer IP address. format: ip This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
neighbor_id (str or None) – BGP neighbor id This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
network (str or None) – CIDR network address. format: ip-cidr-block This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
next_hop (str or None) – Next hop IP address. format: ip This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
source_address (str or None) – BGP neighbor source address. format: ip This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
transport_node_id (str or None) – Transport node id This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
weight (long or None) – BGP Weight attribute. format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.

class com.vmware.nsx_policy.model_client.BgpNeighborRouteDetailsInCsvFormat(file_name=None, results=None)¶

Bases: vmware.vapi.bindings.struct.VapiStruct

Tip

The arguments are used to initialize data attributes with the same names.

Parameters

file_name (str or None) – File name set by HTTP server if API returns CSV result as a file.
results (list of BgpNeighborRouteDetailsCsvRecord or None) –

class com.vmware.nsx_policy.model_client.BgpNeighborRoutes(egde_node_routes=None, enforcement_point_path=None, neighbor_path=None)¶

Bases: vmware.vapi.bindings.struct.VapiStruct

BGP neighbor learned/advertised route details.

Tip

The arguments are used to initialize data attributes with the same names.

Parameters

egde_node_routes (list of RoutesPerTransportNode or None) – Array of BGP neighbor route details per edge node. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
enforcement_point_path (str or None) – Enforcement point policy path This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
neighbor_path (str or None) – BGP neighbor policy path This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.

class com.vmware.nsx_policy.model_client.BgpNeighborRoutesListResult(links=None, schema=None, self_=None, cursor=None, result_count=None, sort_ascending=None, sort_by=None, results=None)¶

Bases: vmware.vapi.bindings.struct.VapiStruct

Tip

The arguments are used to initialize data attributes with the same names.

Parameters

links (list of ResourceLink or None) – The server will populate this field when returing the resource. Ignored on PUT and POST. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
schema (str or None) – Schema for this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
self (SelfResourceLink or None) – Link to this resource
cursor (str or None) – Opaque cursor to be used for getting next page of records (supplied by current result page) This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
result_count (long or None) – Count of results found (across all pages), set only on first page format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
sort_ascending (bool or None) – If true, results are sorted in ascending order This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
sort_by (str or None) – Field by which records are sorted This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
results (list of BgpNeighborRoutes or None) – Paged Collection of Bgp neighbor routes.

class com.vmware.nsx_policy.model_client.BgpRouteFiltering(address_family=None, enabled=None, in_route_filters=None, out_route_filters=None)¶

Bases: vmware.vapi.bindings.struct.VapiStruct

Enable address_families and route filtering in each direction

Tip

The arguments are used to initialize data attributes with the same names.

Parameters

address_family (str or None) –
Possible values are:
- BgpRouteFiltering.ADDRESS_FAMILY_IPV4
- BgpRouteFiltering.ADDRESS_FAMILY_IPV6
Address family type. If not configured, this property automatically derived for IPv4 & IPv6 peer configuration.
enabled (bool or None) – Flag to enable address family.
in_route_filters (list of str or None) – Specify path of prefix-list or route map to filter routes for IN direction.
out_route_filters (list of str or None) – Specify path of prefix-list or route map to filter routes for OUT direction. When not specified, a built-in prefix-list named ‘prefixlist-out-default’ is automatically applied.

ADDRESS_FAMILY_IPV4 = 'IPV4'¶

ADDRESS_FAMILY_IPV6 = 'IPV6'¶

class com.vmware.nsx_policy.model_client.BgpRoutingConfig(links=None, schema=None, self_=None, revision=None, create_time=None, create_user=None, last_modified_time=None, last_modified_user=None, protection=None, system_owned=None, description=None, display_name=None, id=None, resource_type=None, tags=None, parent_path=None, path=None, relative_path=None, children=None, marked_for_delete=None, ecmp=None, enabled=None, graceful_restart=None, graceful_restart_config=None, inter_sr_ibgp=None, local_as_num=None, multipath_relax=None, route_aggregations=None)¶

Bases: vmware.vapi.bindings.struct.VapiStruct

Contains BGP routing configuration.

Tip

The arguments are used to initialize data attributes with the same names.

Parameters

links (list of ResourceLink or None) – The server will populate this field when returing the resource. Ignored on PUT and POST. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
schema (str or None) – Schema for this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
self (SelfResourceLink or None) – Link to this resource
revision (long or None) – The _revision property describes the current revision of the resource. To prevent clients from overwriting each other’s changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected. format: int32
create_time (long or None) – Timestamp of resource creation format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
create_user (str or None) – ID of the user who created this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
last_modified_time (long or None) – Timestamp of last modification format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
last_modified_user (str or None) – ID of the user who last modified this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
protection (str or None) – Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super user and can modify it, but only when providing the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this entity. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
system_owned (bool or None) – Indicates system owned resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
description (str or None) – Description of this resource
display_name (str or None) – Defaults to ID if not set
id (str or None) – Unique identifier of this resource
resource_type (str or None) – The type of this resource.
tags (list of Tag or None) – Opaque identifiers meaningful to the API user
parent_path (str or None) – Path of its parent This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
path (str or None) – Absolute path of this object This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
relative_path (str or None) – Path relative from its parent This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
children (list of vmware.vapi.struct.VapiStruct or None) – subtree for this type within policy tree containing nested elements. When clients pass a value of this class as a parameter, the attribute must contain all the attributes defined in ChildPolicyConfigResource. When methods return a value of this class as a return value, the attribute will contain all the attributes defined in ChildPolicyConfigResource.
marked_for_delete (bool or None) – Intent objects are not directly deleted from the system when a delete is invoked on them. They are marked for deletion and only when all the realized entities for that intent object gets deleted, the intent object is deleted. Objects that are marked for deletion are not returned in GET call. One can use the search API to get these objects. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
ecmp (bool or None) – Flag to enable ECMP.
enabled (bool or None) – Flag to enable BGP configuration. Disabling will stop feature and BGP peering.
graceful_restart (bool or None) – Flag to enable graceful restart. This field is deprecated, please use graceful_restart_config parameter for graceful restart configuration. If both parameters are set and consistent with each other (i.e. graceful_restart=false and graceful_restart_mode=HELPER_ONLY OR graceful_restart=true and graceful_restart_mode=GR_AND_HELPER) then this is allowed, but if inconsistent with each other then this is not allowed and validation error will be thrown.
graceful_restart_config (BgpGracefulRestartConfig or None) – Configuration field to hold BGP Restart mode and timer.
inter_sr_ibgp (bool or None) – Flag to enable inter SR IBGP configuration. When not specified, inter SR IBGP is automatically enabled if Tier-0 is created in ACTIVE_ACTIVE ha_mode.
local_as_num (str) – Specify BGP AS number for Tier-0 to advertize to BGP peers. AS number can be specified in ASPLAIN (e.g., “65546”) or ASDOT (e.g., “1.10”) format. Empty string disables BGP feature.
multipath_relax (bool or None) – Flag to enable BGP multipath relax option.
route_aggregations (list of RouteAggregationEntry or None) – List of routes to be aggregated.

class com.vmware.nsx_policy.model_client.ByodPolicyServiceInstance(links=None, schema=None, self_=None, revision=None, create_time=None, create_user=None, last_modified_time=None, last_modified_user=None, protection=None, system_owned=None, description=None, display_name=None, id=None, resource_type=None, tags=None, parent_path=None, path=None, relative_path=None, children=None, marked_for_delete=None, deployment_mode=None, partner_service_name=None, transport_type=None)¶

Bases: vmware.vapi.bindings.struct.VapiStruct

Represents an instance of partner’s service whose wiring will be done by partner itself. As partner does all the wiring, we call it as Byod - Bring your own device.

Tip

The arguments are used to initialize data attributes with the same names.

Parameters

links (list of ResourceLink or None) – The server will populate this field when returing the resource. Ignored on PUT and POST. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
schema (str or None) – Schema for this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
self (SelfResourceLink or None) – Link to this resource
revision (long or None) – The _revision property describes the current revision of the resource. To prevent clients from overwriting each other’s changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected. format: int32
create_time (long or None) – Timestamp of resource creation format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
create_user (str or None) – ID of the user who created this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
last_modified_time (long or None) – Timestamp of last modification format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
last_modified_user (str or None) – ID of the user who last modified this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
protection (str or None) – Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super user and can modify it, but only when providing the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this entity. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
system_owned (bool or None) – Indicates system owned resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
description (str or None) – Description of this resource
display_name (str or None) – Defaults to ID if not set
id (str or None) – Unique identifier of this resource
resource_type (str or None) – The type of this resource.
tags (list of Tag or None) – Opaque identifiers meaningful to the API user
parent_path (str or None) – Path of its parent This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
path (str or None) – Absolute path of this object This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
relative_path (str or None) – Path relative from its parent This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
children (list of vmware.vapi.struct.VapiStruct or None) – subtree for this type within policy tree containing nested elements. When clients pass a value of this class as a parameter, the attribute must contain all the attributes defined in ChildPolicyConfigResource. When methods return a value of this class as a return value, the attribute will contain all the attributes defined in ChildPolicyConfigResource.
marked_for_delete (bool or None) – Intent objects are not directly deleted from the system when a delete is invoked on them. They are marked for deletion and only when all the realized entities for that intent object gets deleted, the intent object is deleted. Objects that are marked for deletion are not returned in GET call. One can use the search API to get these objects. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
deployment_mode (str or None) –
Possible values are:
- ByodPolicyServiceInstance.DEPLOYMENT_MODE_STAND_ALONE
- ByodPolicyServiceInstance.DEPLOYMENT_MODE_ACTIVE_STANDBY
Deployment mode specifies how the partner appliance will be deployed i.e. in HA or standalone mode.
partner_service_name (str) – Unique name of Partner Service in the Marketplace
transport_type (str or None) –
Possible values are:
- ByodPolicyServiceInstance.TRANSPORT_TYPE_L2_BRIDGE
- ByodPolicyServiceInstance.TRANSPORT_TYPE_L3_ROUTED
Transport to be used while deploying Service-VM.

DEPLOYMENT_MODE_ACTIVE_STANDBY = 'ACTIVE_STANDBY'¶

DEPLOYMENT_MODE_STAND_ALONE = 'STAND_ALONE'¶

TRANSPORT_TYPE_L2_BRIDGE = 'L2_BRIDGE'¶

TRANSPORT_TYPE_L3_ROUTED = 'L3_ROUTED'¶

class com.vmware.nsx_policy.model_client.ByodPolicyServiceInstanceListResult(links=None, schema=None, self_=None, cursor=None, result_count=None, sort_ascending=None, sort_by=None, results=None)¶

Bases: vmware.vapi.bindings.struct.VapiStruct

Collection of only Byod SI objects

Tip

The arguments are used to initialize data attributes with the same names.

Parameters

links (list of ResourceLink or None) – The server will populate this field when returing the resource. Ignored on PUT and POST. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
schema (str or None) – Schema for this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
self (SelfResourceLink or None) – Link to this resource
cursor (str or None) – Opaque cursor to be used for getting next page of records (supplied by current result page) This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
result_count (long or None) – Count of results found (across all pages), set only on first page format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
sort_ascending (bool or None) – If true, results are sorted in ascending order This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
sort_by (str or None) – Field by which records are sorted This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
results (list of ByodPolicyServiceInstance) – Byod Service instance list results

class com.vmware.nsx_policy.model_client.ChildBgpNeighborConfig(bgp_neighbor_config=None, links=None, schema=None, self_=None, revision=None, create_time=None, create_user=None, last_modified_time=None, last_modified_user=None, protection=None, system_owned=None, description=None, display_name=None, id=None, resource_type=None, tags=None, marked_for_delete=None)¶

Bases: vmware.vapi.bindings.struct.VapiStruct

Child wrapper object for BgpNeighborConfig, used in hierarchical API.

Tip

The arguments are used to initialize data attributes with the same names.

Parameters

bgp_neighbor_config (BgpNeighborConfig) – Contains the actual BgpNeighborConfig object.
links (list of ResourceLink or None) – The server will populate this field when returing the resource. Ignored on PUT and POST. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
schema (str or None) – Schema for this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
self (SelfResourceLink or None) – Link to this resource
revision (long or None) – The _revision property describes the current revision of the resource. To prevent clients from overwriting each other’s changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected. format: int32
create_time (long or None) – Timestamp of resource creation format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
create_user (str or None) – ID of the user who created this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
last_modified_time (long or None) – Timestamp of last modification format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
last_modified_user (str or None) – ID of the user who last modified this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
protection (str or None) – Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super user and can modify it, but only when providing the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this entity. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
system_owned (bool or None) – Indicates system owned resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
description (str or None) – Description of this resource
display_name (str or None) – Defaults to ID if not set
id (str or None) – Unique identifier of this resource
resource_type (str) –
tags (list of Tag or None) – Opaque identifiers meaningful to the API user
marked_for_delete (bool or None) – If this field is set to true, delete operation is triggered on the intent tree. This resource along with its all children in intent tree will be deleted. This is a cascade delete and should only be used if intent object along with its all children are to be deleted. This does not support deletion of single non-leaf node within the tree and should be used carefully.

property resource_type¶: Return the discriminator value

class com.vmware.nsx_policy.model_client.ChildBgpRoutingConfig(bgp_routing_config=None, links=None, schema=None, self_=None, revision=None, create_time=None, create_user=None, last_modified_time=None, last_modified_user=None, protection=None, system_owned=None, description=None, display_name=None, id=None, resource_type=None, tags=None, marked_for_delete=None)¶

Bases: vmware.vapi.bindings.struct.VapiStruct

Child wrapper object for BgpRoutingConfig, used in hierarchical API.

Tip

The arguments are used to initialize data attributes with the same names.

Parameters

bgp_routing_config (BgpRoutingConfig) – Contains the actual BgpRoutingConfig object.
links (list of ResourceLink or None) – The server will populate this field when returing the resource. Ignored on PUT and POST. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
schema (str or None) – Schema for this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
self (SelfResourceLink or None) – Link to this resource
revision (long or None) – The _revision property describes the current revision of the resource. To prevent clients from overwriting each other’s changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected. format: int32
create_time (long or None) – Timestamp of resource creation format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
create_user (str or None) – ID of the user who created this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
last_modified_time (long or None) – Timestamp of last modification format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
last_modified_user (str or None) – ID of the user who last modified this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
protection (str or None) – Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super user and can modify it, but only when providing the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this entity. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
system_owned (bool or None) – Indicates system owned resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
description (str or None) – Description of this resource
display_name (str or None) – Defaults to ID if not set
id (str or None) – Unique identifier of this resource
resource_type (str) –
tags (list of Tag or None) – Opaque identifiers meaningful to the API user
marked_for_delete (bool or None) – If this field is set to true, delete operation is triggered on the intent tree. This resource along with its all children in intent tree will be deleted. This is a cascade delete and should only be used if intent object along with its all children are to be deleted. This does not support deletion of single non-leaf node within the tree and should be used carefully.

property resource_type¶: Return the discriminator value

class com.vmware.nsx_policy.model_client.ChildByodPolicyServiceInstance(byod_policy_service_instance=None, links=None, schema=None, self_=None, revision=None, create_time=None, create_user=None, last_modified_time=None, last_modified_user=None, protection=None, system_owned=None, description=None, display_name=None, id=None, resource_type=None, tags=None, marked_for_delete=None)¶

Bases: vmware.vapi.bindings.struct.VapiStruct

Child wrapper object for ByodPolicyServiceInstance used in hierarchical API.

Tip

The arguments are used to initialize data attributes with the same names.

Parameters

byod_policy_service_instance (ByodPolicyServiceInstance) – Contains actual ByodPolicyServiceInstance.
links (list of ResourceLink or None) – The server will populate this field when returing the resource. Ignored on PUT and POST. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
schema (str or None) – Schema for this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
self (SelfResourceLink or None) – Link to this resource
revision (long or None) – The _revision property describes the current revision of the resource. To prevent clients from overwriting each other’s changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected. format: int32
create_time (long or None) – Timestamp of resource creation format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
create_user (str or None) – ID of the user who created this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
last_modified_time (long or None) – Timestamp of last modification format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
last_modified_user (str or None) – ID of the user who last modified this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
protection (str or None) – Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super user and can modify it, but only when providing the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this entity. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
system_owned (bool or None) – Indicates system owned resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
description (str or None) – Description of this resource
display_name (str or None) – Defaults to ID if not set
id (str or None) – Unique identifier of this resource
resource_type (str) –
tags (list of Tag or None) – Opaque identifiers meaningful to the API user
marked_for_delete (bool or None) – If this field is set to true, delete operation is triggered on the intent tree. This resource along with its all children in intent tree will be deleted. This is a cascade delete and should only be used if intent object along with its all children are to be deleted. This does not support deletion of single non-leaf node within the tree and should be used carefully.

property resource_type¶: Return the discriminator value

class com.vmware.nsx_policy.model_client.ChildCommunicationEntry(communication_entry=None, links=None, schema=None, self_=None, revision=None, create_time=None, create_user=None, last_modified_time=None, last_modified_user=None, protection=None, system_owned=None, description=None, display_name=None, id=None, resource_type=None, tags=None, marked_for_delete=None)¶

Bases: vmware.vapi.bindings.struct.VapiStruct

Child wrapper object for CommunicationEntry, used in hierarchical API This type is deprecated. Use the type ChildRule instead.

Tip

The arguments are used to initialize data attributes with the same names.

Parameters

communication_entry (CommunicationEntry) – Contains the actual CommunicationEntry object.
links (list of ResourceLink or None) – The server will populate this field when returing the resource. Ignored on PUT and POST. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
schema (str or None) – Schema for this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
self (SelfResourceLink or None) – Link to this resource
revision (long or None) – The _revision property describes the current revision of the resource. To prevent clients from overwriting each other’s changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected. format: int32
create_time (long or None) – Timestamp of resource creation format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
create_user (str or None) – ID of the user who created this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
last_modified_time (long or None) – Timestamp of last modification format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
last_modified_user (str or None) – ID of the user who last modified this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
protection (str or None) – Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super user and can modify it, but only when providing the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this entity. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
system_owned (bool or None) – Indicates system owned resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
description (str or None) – Description of this resource
display_name (str or None) – Defaults to ID if not set
id (str or None) – Unique identifier of this resource
resource_type (str) –
tags (list of Tag or None) – Opaque identifiers meaningful to the API user
marked_for_delete (bool or None) – If this field is set to true, delete operation is triggered on the intent tree. This resource along with its all children in intent tree will be deleted. This is a cascade delete and should only be used if intent object along with its all children are to be deleted. This does not support deletion of single non-leaf node within the tree and should be used carefully.

property resource_type¶: Return the discriminator value

class com.vmware.nsx_policy.model_client.ChildCommunicationMap(communication_map=None, links=None, schema=None, self_=None, revision=None, create_time=None, create_user=None, last_modified_time=None, last_modified_user=None, protection=None, system_owned=None, description=None, display_name=None, id=None, resource_type=None, tags=None, marked_for_delete=None)¶

Bases: vmware.vapi.bindings.struct.VapiStruct

Child wrapper object for CommunicationMap, used in hierarchical API This type is deprecated. Use the type ChildSecurityPolicy instead.

Tip

The arguments are used to initialize data attributes with the same names.

Parameters

communication_map (CommunicationMap) – Contains the actual CommunicationMap object.
links (list of ResourceLink or None) – The server will populate this field when returing the resource. Ignored on PUT and POST. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
schema (str or None) – Schema for this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
self (SelfResourceLink or None) – Link to this resource
revision (long or None) – The _revision property describes the current revision of the resource. To prevent clients from overwriting each other’s changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected. format: int32
create_time (long or None) – Timestamp of resource creation format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
create_user (str or None) – ID of the user who created this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
last_modified_time (long or None) – Timestamp of last modification format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
last_modified_user (str or None) – ID of the user who last modified this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
protection (str or None) – Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super user and can modify it, but only when providing the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this entity. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
system_owned (bool or None) – Indicates system owned resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
description (str or None) – Description of this resource
display_name (str or None) – Defaults to ID if not set
id (str or None) – Unique identifier of this resource
resource_type (str) –
tags (list of Tag or None) – Opaque identifiers meaningful to the API user
marked_for_delete (bool or None) – If this field is set to true, delete operation is triggered on the intent tree. This resource along with its all children in intent tree will be deleted. This is a cascade delete and should only be used if intent object along with its all children are to be deleted. This does not support deletion of single non-leaf node within the tree and should be used carefully.

property resource_type¶: Return the discriminator value

class com.vmware.nsx_policy.model_client.ChildCommunityList(community_list=None, links=None, schema=None, self_=None, revision=None, create_time=None, create_user=None, last_modified_time=None, last_modified_user=None, protection=None, system_owned=None, description=None, display_name=None, id=None, resource_type=None, tags=None, marked_for_delete=None)¶

Bases: vmware.vapi.bindings.struct.VapiStruct

Child wrapper object for CommunityList, used in hierarchical API

Tip

The arguments are used to initialize data attributes with the same names.

Parameters

community_list (CommunityList) – Contains the actual CommunityList object
links (list of ResourceLink or None) – The server will populate this field when returing the resource. Ignored on PUT and POST. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
schema (str or None) – Schema for this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
self (SelfResourceLink or None) – Link to this resource
revision (long or None) – The _revision property describes the current revision of the resource. To prevent clients from overwriting each other’s changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected. format: int32
create_time (long or None) – Timestamp of resource creation format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
create_user (str or None) – ID of the user who created this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
last_modified_time (long or None) – Timestamp of last modification format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
last_modified_user (str or None) – ID of the user who last modified this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
protection (str or None) – Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super user and can modify it, but only when providing the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this entity. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
system_owned (bool or None) – Indicates system owned resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
description (str or None) – Description of this resource
display_name (str or None) – Defaults to ID if not set
id (str or None) – Unique identifier of this resource
resource_type (str) –
tags (list of Tag or None) – Opaque identifiers meaningful to the API user
marked_for_delete (bool or None) – If this field is set to true, delete operation is triggered on the intent tree. This resource along with its all children in intent tree will be deleted. This is a cascade delete and should only be used if intent object along with its all children are to be deleted. This does not support deletion of single non-leaf node within the tree and should be used carefully.

property resource_type¶: Return the discriminator value

class com.vmware.nsx_policy.model_client.ChildComputeClusterIdfwConfiguration(compute_cluster_idfw_configuration=None, links=None, schema=None, self_=None, revision=None, create_time=None, create_user=None, last_modified_time=None, last_modified_user=None, protection=None, system_owned=None, description=None, display_name=None, id=None, resource_type=None, tags=None, marked_for_delete=None)¶

Bases: vmware.vapi.bindings.struct.VapiStruct

Wrapper object for ComputeClusterIdfwConfiguration

Tip

The arguments are used to initialize data attributes with the same names.

Parameters

compute_cluster_idfw_configuration (ComputeClusterIdfwConfiguration) – Contains the actual compute cluster idfw configuration object.
links (list of ResourceLink or None) – The server will populate this field when returing the resource. Ignored on PUT and POST. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
schema (str or None) – Schema for this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
self (SelfResourceLink or None) – Link to this resource
revision (long or None) – The _revision property describes the current revision of the resource. To prevent clients from overwriting each other’s changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected. format: int32
create_time (long or None) – Timestamp of resource creation format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
create_user (str or None) – ID of the user who created this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
last_modified_time (long or None) – Timestamp of last modification format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
last_modified_user (str or None) – ID of the user who last modified this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
protection (str or None) – Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super user and can modify it, but only when providing the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this entity. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
system_owned (bool or None) – Indicates system owned resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
description (str or None) – Description of this resource
display_name (str or None) – Defaults to ID if not set
id (str or None) – Unique identifier of this resource
resource_type (str) –
tags (list of Tag or None) – Opaque identifiers meaningful to the API user
marked_for_delete (bool or None) – If this field is set to true, delete operation is triggered on the intent tree. This resource along with its all children in intent tree will be deleted. This is a cascade delete and should only be used if intent object along with its all children are to be deleted. This does not support deletion of single non-leaf node within the tree and should be used carefully.

property resource_type¶: Return the discriminator value

class com.vmware.nsx_policy.model_client.ChildConstraint(constraint=None, links=None, schema=None, self_=None, revision=None, create_time=None, create_user=None, last_modified_time=None, last_modified_user=None, protection=None, system_owned=None, description=None, display_name=None, id=None, resource_type=None, tags=None, marked_for_delete=None)¶

Bases: vmware.vapi.bindings.struct.VapiStruct

Child wrapper object for Constraint, used in hierarchical API

Tip

The arguments are used to initialize data attributes with the same names.

Parameters

constraint (Constraint) – Contains the actual Constraint object
links (list of ResourceLink or None) – The server will populate this field when returing the resource. Ignored on PUT and POST. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
schema (str or None) – Schema for this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
self (SelfResourceLink or None) – Link to this resource
revision (long or None) – The _revision property describes the current revision of the resource. To prevent clients from overwriting each other’s changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected. format: int32
create_time (long or None) – Timestamp of resource creation format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
create_user (str or None) – ID of the user who created this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
last_modified_time (long or None) – Timestamp of last modification format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
last_modified_user (str or None) – ID of the user who last modified this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
protection (str or None) – Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super user and can modify it, but only when providing the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this entity. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
system_owned (bool or None) – Indicates system owned resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
description (str or None) – Description of this resource
display_name (str or None) – Defaults to ID if not set
id (str or None) – Unique identifier of this resource
resource_type (str) –
tags (list of Tag or None) – Opaque identifiers meaningful to the API user
marked_for_delete (bool or None) – If this field is set to true, delete operation is triggered on the intent tree. This resource along with its all children in intent tree will be deleted. This is a cascade delete and should only be used if intent object along with its all children are to be deleted. This does not support deletion of single non-leaf node within the tree and should be used carefully.

property resource_type¶: Return the discriminator value

class com.vmware.nsx_policy.model_client.ChildDeploymentZone(deployment_zone=None, links=None, schema=None, self_=None, revision=None, create_time=None, create_user=None, last_modified_time=None, last_modified_user=None, protection=None, system_owned=None, description=None, display_name=None, id=None, resource_type=None, tags=None, marked_for_delete=None)¶

Bases: vmware.vapi.bindings.struct.VapiStruct

Child wrapper object for DeploymentZone, used in hierarchical API

Tip

The arguments are used to initialize data attributes with the same names.

Parameters

deployment_zone (DeploymentZone) – Contains the actual DeploymentZone object
links (list of ResourceLink or None) – The server will populate this field when returing the resource. Ignored on PUT and POST. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
schema (str or None) – Schema for this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
self (SelfResourceLink or None) – Link to this resource
revision (long or None) – The _revision property describes the current revision of the resource. To prevent clients from overwriting each other’s changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected. format: int32
create_time (long or None) – Timestamp of resource creation format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
create_user (str or None) – ID of the user who created this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
last_modified_time (long or None) – Timestamp of last modification format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
last_modified_user (str or None) – ID of the user who last modified this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
protection (str or None) – Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super user and can modify it, but only when providing the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this entity. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
system_owned (bool or None) – Indicates system owned resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
description (str or None) – Description of this resource
display_name (str or None) – Defaults to ID if not set
id (str or None) – Unique identifier of this resource
resource_type (str) –
tags (list of Tag or None) – Opaque identifiers meaningful to the API user
marked_for_delete (bool or None) – If this field is set to true, delete operation is triggered on the intent tree. This resource along with its all children in intent tree will be deleted. This is a cascade delete and should only be used if intent object along with its all children are to be deleted. This does not support deletion of single non-leaf node within the tree and should be used carefully.

property resource_type¶: Return the discriminator value

class com.vmware.nsx_policy.model_client.ChildDfwFirewallConfiguration(dfw_firewall_configuration=None, links=None, schema=None, self_=None, revision=None, create_time=None, create_user=None, last_modified_time=None, last_modified_user=None, protection=None, system_owned=None, description=None, display_name=None, id=None, resource_type=None, tags=None, marked_for_delete=None)¶

Bases: vmware.vapi.bindings.struct.VapiStruct

Wrapper object for FirewallConfiguration

Tip

The arguments are used to initialize data attributes with the same names.

Parameters

dfw_firewall_configuration (DfwFirewallConfiguration) – Contains the actual dfw firewall configuration list object.
links (list of ResourceLink or None) – The server will populate this field when returing the resource. Ignored on PUT and POST. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
schema (str or None) – Schema for this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
self (SelfResourceLink or None) – Link to this resource
revision (long or None) – The _revision property describes the current revision of the resource. To prevent clients from overwriting each other’s changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected. format: int32
create_time (long or None) – Timestamp of resource creation format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
create_user (str or None) – ID of the user who created this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
last_modified_time (long or None) – Timestamp of last modification format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
last_modified_user (str or None) – ID of the user who last modified this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
protection (str or None) – Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super user and can modify it, but only when providing the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this entity. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
system_owned (bool or None) – Indicates system owned resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
description (str or None) – Description of this resource
display_name (str or None) – Defaults to ID if not set
id (str or None) – Unique identifier of this resource
resource_type (str) –
tags (list of Tag or None) – Opaque identifiers meaningful to the API user
marked_for_delete (bool or None) – If this field is set to true, delete operation is triggered on the intent tree. This resource along with its all children in intent tree will be deleted. This is a cascade delete and should only be used if intent object along with its all children are to be deleted. This does not support deletion of single non-leaf node within the tree and should be used carefully.

property resource_type¶: Return the discriminator value

class com.vmware.nsx_policy.model_client.ChildDhcpRelayConfig(dhcp_relay_config=None, links=None, schema=None, self_=None, revision=None, create_time=None, create_user=None, last_modified_time=None, last_modified_user=None, protection=None, system_owned=None, description=None, display_name=None, id=None, resource_type=None, tags=None, marked_for_delete=None)¶

Bases: vmware.vapi.bindings.struct.VapiStruct

Child wrapper object for DhcpRelayConfig, used in hierarchical API

Tip

The arguments are used to initialize data attributes with the same names.

Parameters

dhcp_relay_config (DhcpRelayConfig) – Contains the actual DhcpRelayConfig object
links (list of ResourceLink or None) – The server will populate this field when returing the resource. Ignored on PUT and POST. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
schema (str or None) – Schema for this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
self (SelfResourceLink or None) – Link to this resource
revision (long or None) – The _revision property describes the current revision of the resource. To prevent clients from overwriting each other’s changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected. format: int32
create_time (long or None) – Timestamp of resource creation format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
create_user (str or None) – ID of the user who created this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
last_modified_time (long or None) – Timestamp of last modification format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
last_modified_user (str or None) – ID of the user who last modified this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
protection (str or None) – Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super user and can modify it, but only when providing the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this entity. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
system_owned (bool or None) – Indicates system owned resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
description (str or None) – Description of this resource
display_name (str or None) – Defaults to ID if not set
id (str or None) – Unique identifier of this resource
resource_type (str) –
tags (list of Tag or None) – Opaque identifiers meaningful to the API user
marked_for_delete (bool or None) – If this field is set to true, delete operation is triggered on the intent tree. This resource along with its all children in intent tree will be deleted. This is a cascade delete and should only be used if intent object along with its all children are to be deleted. This does not support deletion of single non-leaf node within the tree and should be used carefully.

property resource_type¶: Return the discriminator value

class com.vmware.nsx_policy.model_client.ChildDhcpServerConfig(dhcp_server_config=None, links=None, schema=None, self_=None, revision=None, create_time=None, create_user=None, last_modified_time=None, last_modified_user=None, protection=None, system_owned=None, description=None, display_name=None, id=None, resource_type=None, tags=None, marked_for_delete=None)¶

Bases: vmware.vapi.bindings.struct.VapiStruct

Child wrapper object for DhcpServerConfig, used in hierarchical API

Tip

The arguments are used to initialize data attributes with the same names.

Parameters

dhcp_server_config (DhcpServerConfig) – Contains the actual DhcpServerConfig object
links (list of ResourceLink or None) – The server will populate this field when returing the resource. Ignored on PUT and POST. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
schema (str or None) – Schema for this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
self (SelfResourceLink or None) – Link to this resource
revision (long or None) – The _revision property describes the current revision of the resource. To prevent clients from overwriting each other’s changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected. format: int32
create_time (long or None) – Timestamp of resource creation format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
create_user (str or None) – ID of the user who created this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
last_modified_time (long or None) – Timestamp of last modification format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
last_modified_user (str or None) – ID of the user who last modified this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
protection (str or None) – Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super user and can modify it, but only when providing the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this entity. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
system_owned (bool or None) – Indicates system owned resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
description (str or None) – Description of this resource
display_name (str or None) – Defaults to ID if not set
id (str or None) – Unique identifier of this resource
resource_type (str) –
tags (list of Tag or None) – Opaque identifiers meaningful to the API user
marked_for_delete (bool or None) – If this field is set to true, delete operation is triggered on the intent tree. This resource along with its all children in intent tree will be deleted. This is a cascade delete and should only be used if intent object along with its all children are to be deleted. This does not support deletion of single non-leaf node within the tree and should be used carefully.

property resource_type¶: Return the discriminator value

class com.vmware.nsx_policy.model_client.ChildDnsSecurityProfile(dns_security_profile=None, links=None, schema=None, self_=None, revision=None, create_time=None, create_user=None, last_modified_time=None, last_modified_user=None, protection=None, system_owned=None, description=None, display_name=None, id=None, resource_type=None, tags=None, marked_for_delete=None)¶

Bases: vmware.vapi.bindings.struct.VapiStruct

Child wrapper object for DnsSecurityProfile, used in hierarchical API

Tip

The arguments are used to initialize data attributes with the same names.

Parameters

dns_security_profile (DnsSecurityProfile) – Contains the actual DnsSecurityProfile object
links (list of ResourceLink or None) – The server will populate this field when returing the resource. Ignored on PUT and POST. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
schema (str or None) – Schema for this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
self (SelfResourceLink or None) – Link to this resource
revision (long or None) – The _revision property describes the current revision of the resource. To prevent clients from overwriting each other’s changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected. format: int32
create_time (long or None) – Timestamp of resource creation format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
create_user (str or None) – ID of the user who created this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
last_modified_time (long or None) – Timestamp of last modification format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
last_modified_user (str or None) – ID of the user who last modified this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
protection (str or None) – Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super user and can modify it, but only when providing the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this entity. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
system_owned (bool or None) – Indicates system owned resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
description (str or None) – Description of this resource
display_name (str or None) – Defaults to ID if not set
id (str or None) – Unique identifier of this resource
resource_type (str) –
tags (list of Tag or None) – Opaque identifiers meaningful to the API user
marked_for_delete (bool or None) – If this field is set to true, delete operation is triggered on the intent tree. This resource along with its all children in intent tree will be deleted. This is a cascade delete and should only be used if intent object along with its all children are to be deleted. This does not support deletion of single non-leaf node within the tree and should be used carefully.

property resource_type¶: Return the discriminator value

class com.vmware.nsx_policy.model_client.ChildDnsSecurityProfileBindingMap(dns_security_profile_binding_map=None, links=None, schema=None, self_=None, revision=None, create_time=None, create_user=None, last_modified_time=None, last_modified_user=None, protection=None, system_owned=None, description=None, display_name=None, id=None, resource_type=None, tags=None, marked_for_delete=None)¶

Bases: vmware.vapi.bindings.struct.VapiStruct

Child wrapper obejct for DnsSecurityProfileBindingMap used in hierarchical API

Tip

The arguments are used to initialize data attributes with the same names.

Parameters

dns_security_profile_binding_map (DnsSecurityProfileBindingMap) – Contains the actual DnsSecurityProfileBindingMap object
links (list of ResourceLink or None) – The server will populate this field when returing the resource. Ignored on PUT and POST. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
schema (str or None) – Schema for this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
self (SelfResourceLink or None) – Link to this resource
revision (long or None) – The _revision property describes the current revision of the resource. To prevent clients from overwriting each other’s changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected. format: int32
create_time (long or None) – Timestamp of resource creation format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
create_user (str or None) – ID of the user who created this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
last_modified_time (long or None) – Timestamp of last modification format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
last_modified_user (str or None) – ID of the user who last modified this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
protection (str or None) – Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super user and can modify it, but only when providing the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this entity. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
system_owned (bool or None) – Indicates system owned resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
description (str or None) – Description of this resource
display_name (str or None) – Defaults to ID if not set
id (str or None) – Unique identifier of this resource
resource_type (str) –
tags (list of Tag or None) – Opaque identifiers meaningful to the API user
marked_for_delete (bool or None) – If this field is set to true, delete operation is triggered on the intent tree. This resource along with its all children in intent tree will be deleted. This is a cascade delete and should only be used if intent object along with its all children are to be deleted. This does not support deletion of single non-leaf node within the tree and should be used carefully.

property resource_type¶: Return the discriminator value

class com.vmware.nsx_policy.model_client.ChildDomain(domain=None, links=None, schema=None, self_=None, revision=None, create_time=None, create_user=None, last_modified_time=None, last_modified_user=None, protection=None, system_owned=None, description=None, display_name=None, id=None, resource_type=None, tags=None, marked_for_delete=None)¶

Bases: vmware.vapi.bindings.struct.VapiStruct

Child wrapper object for domain, used in hierarchical API.

Tip

The arguments are used to initialize data attributes with the same names.

Parameters

domain (Domain) – Contains the actual domain object.
links (list of ResourceLink or None) – The server will populate this field when returing the resource. Ignored on PUT and POST. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
schema (str or None) – Schema for this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
self (SelfResourceLink or None) – Link to this resource
revision (long or None) – The _revision property describes the current revision of the resource. To prevent clients from overwriting each other’s changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected. format: int32
create_time (long or None) – Timestamp of resource creation format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
create_user (str or None) – ID of the user who created this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
last_modified_time (long or None) – Timestamp of last modification format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
last_modified_user (str or None) – ID of the user who last modified this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
protection (str or None) – Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super user and can modify it, but only when providing the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this entity. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
system_owned (bool or None) – Indicates system owned resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
description (str or None) – Description of this resource
display_name (str or None) – Defaults to ID if not set
id (str or None) – Unique identifier of this resource
resource_type (str) –
tags (list of Tag or None) – Opaque identifiers meaningful to the API user
marked_for_delete (bool or None) – If this field is set to true, delete operation is triggered on the intent tree. This resource along with its all children in intent tree will be deleted. This is a cascade delete and should only be used if intent object along with its all children are to be deleted. This does not support deletion of single non-leaf node within the tree and should be used carefully.

property resource_type¶: Return the discriminator value

class com.vmware.nsx_policy.model_client.ChildDomainDeploymentMap(domain_deployment_map=None, links=None, schema=None, self_=None, revision=None, create_time=None, create_user=None, last_modified_time=None, last_modified_user=None, protection=None, system_owned=None, description=None, display_name=None, id=None, resource_type=None, tags=None, marked_for_delete=None)¶

Bases: vmware.vapi.bindings.struct.VapiStruct

Child wrapper object for DomainDeploymentMap, used in hierarchical API

Tip

The arguments are used to initialize data attributes with the same names.

Parameters

domain_deployment_map (DomainDeploymentMap) – Contains the actual DomainDeploymentMap object
links (list of ResourceLink or None) – The server will populate this field when returing the resource. Ignored on PUT and POST. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
schema (str or None) – Schema for this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
self (SelfResourceLink or None) – Link to this resource
revision (long or None) – The _revision property describes the current revision of the resource. To prevent clients from overwriting each other’s changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected. format: int32
create_time (long or None) – Timestamp of resource creation format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
create_user (str or None) – ID of the user who created this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
last_modified_time (long or None) – Timestamp of last modification format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
last_modified_user (str or None) – ID of the user who last modified this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
protection (str or None) – Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super user and can modify it, but only when providing the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this entity. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
system_owned (bool or None) – Indicates system owned resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
description (str or None) – Description of this resource
display_name (str or None) – Defaults to ID if not set
id (str or None) – Unique identifier of this resource
resource_type (str) –
tags (list of Tag or None) – Opaque identifiers meaningful to the API user
marked_for_delete (bool or None) – If this field is set to true, delete operation is triggered on the intent tree. This resource along with its all children in intent tree will be deleted. This is a cascade delete and should only be used if intent object along with its all children are to be deleted. This does not support deletion of single non-leaf node within the tree and should be used carefully.

property resource_type¶: Return the discriminator value

class com.vmware.nsx_policy.model_client.ChildEndpointPolicy(endpoint_policy=None, links=None, schema=None, self_=None, revision=None, create_time=None, create_user=None, last_modified_time=None, last_modified_user=None, protection=None, system_owned=None, description=None, display_name=None, id=None, resource_type=None, tags=None, marked_for_delete=None)¶

Bases: vmware.vapi.bindings.struct.VapiStruct

Child wrapper object for EndpointPolicy used in hierarchical API.

Tip

The arguments are used to initialize data attributes with the same names.

Parameters

endpoint_policy (EndpointPolicy) – Contains actual EndpointPolicy.
links (list of ResourceLink or None) – The server will populate this field when returing the resource. Ignored on PUT and POST. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
schema (str or None) – Schema for this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
self (SelfResourceLink or None) – Link to this resource
revision (long or None) – The _revision property describes the current revision of the resource. To prevent clients from overwriting each other’s changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected. format: int32
create_time (long or None) – Timestamp of resource creation format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
create_user (str or None) – ID of the user who created this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
last_modified_time (long or None) – Timestamp of last modification format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
last_modified_user (str or None) – ID of the user who last modified this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
protection (str or None) – Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super user and can modify it, but only when providing the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this entity. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
system_owned (bool or None) – Indicates system owned resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
description (str or None) – Description of this resource
display_name (str or None) – Defaults to ID if not set
id (str or None) – Unique identifier of this resource
resource_type (str) –
tags (list of Tag or None) – Opaque identifiers meaningful to the API user
marked_for_delete (bool or None) – If this field is set to true, delete operation is triggered on the intent tree. This resource along with its all children in intent tree will be deleted. This is a cascade delete and should only be used if intent object along with its all children are to be deleted. This does not support deletion of single non-leaf node within the tree and should be used carefully.

property resource_type¶: Return the discriminator value

class com.vmware.nsx_policy.model_client.ChildEndpointRule(endpoint_rule=None, links=None, schema=None, self_=None, revision=None, create_time=None, create_user=None, last_modified_time=None, last_modified_user=None, protection=None, system_owned=None, description=None, display_name=None, id=None, resource_type=None, tags=None, marked_for_delete=None)¶

Bases: vmware.vapi.bindings.struct.VapiStruct

Child wrapper object for EndpointRule used in hierarchical API.

Tip

The arguments are used to initialize data attributes with the same names.

Parameters

endpoint_rule (EndpointRule) – Contains actual EndpointRule.
links (list of ResourceLink or None) – The server will populate this field when returing the resource. Ignored on PUT and POST. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
schema (str or None) – Schema for this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
self (SelfResourceLink or None) – Link to this resource
revision (long or None) – The _revision property describes the current revision of the resource. To prevent clients from overwriting each other’s changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected. format: int32
create_time (long or None) – Timestamp of resource creation format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
create_user (str or None) – ID of the user who created this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
last_modified_time (long or None) – Timestamp of last modification format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
last_modified_user (str or None) – ID of the user who last modified this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
protection (str or None) – Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super user and can modify it, but only when providing the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this entity. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
system_owned (bool or None) – Indicates system owned resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
description (str or None) – Description of this resource
display_name (str or None) – Defaults to ID if not set
id (str or None) – Unique identifier of this resource
resource_type (str) –
tags (list of Tag or None) – Opaque identifiers meaningful to the API user
marked_for_delete (bool or None) – If this field is set to true, delete operation is triggered on the intent tree. This resource along with its all children in intent tree will be deleted. This is a cascade delete and should only be used if intent object along with its all children are to be deleted. This does not support deletion of single non-leaf node within the tree and should be used carefully.

property resource_type¶: Return the discriminator value

class com.vmware.nsx_policy.model_client.ChildEnforcementPoint(enforcement_point=None, links=None, schema=None, self_=None, revision=None, create_time=None, create_user=None, last_modified_time=None, last_modified_user=None, protection=None, system_owned=None, description=None, display_name=None, id=None, resource_type=None, tags=None, marked_for_delete=None)¶

Bases: vmware.vapi.bindings.struct.VapiStruct

Child wrapper object for EnforcementPoint, used in hierarchical API

Tip

The arguments are used to initialize data attributes with the same names.

Parameters

enforcement_point (EnforcementPoint) – Contains the actual Enforcement point object
links (list of ResourceLink or None) – The server will populate this field when returing the resource. Ignored on PUT and POST. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
schema (str or None) – Schema for this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
self (SelfResourceLink or None) – Link to this resource
revision (long or None) – The _revision property describes the current revision of the resource. To prevent clients from overwriting each other’s changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected. format: int32
create_time (long or None) – Timestamp of resource creation format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
create_user (str or None) – ID of the user who created this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
last_modified_time (long or None) – Timestamp of last modification format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
last_modified_user (str or None) – ID of the user who last modified this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
protection (str or None) – Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super user and can modify it, but only when providing the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this entity. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
system_owned (bool or None) – Indicates system owned resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
description (str or None) – Description of this resource
display_name (str or None) – Defaults to ID if not set
id (str or None) – Unique identifier of this resource
resource_type (str) –
tags (list of Tag or None) – Opaque identifiers meaningful to the API user
marked_for_delete (bool or None) – If this field is set to true, delete operation is triggered on the intent tree. This resource along with its all children in intent tree will be deleted. This is a cascade delete and should only be used if intent object along with its all children are to be deleted. This does not support deletion of single non-leaf node within the tree and should be used carefully.

property resource_type¶: Return the discriminator value

class com.vmware.nsx_policy.model_client.ChildFloodProtectionProfile(flood_protection_profile=None, links=None, schema=None, self_=None, revision=None, create_time=None, create_user=None, last_modified_time=None, last_modified_user=None, protection=None, system_owned=None, description=None, display_name=None, id=None, resource_type=None, tags=None, marked_for_delete=None)¶

Bases: vmware.vapi.bindings.struct.VapiStruct

Child wrapper object for FloodProtectionProfile, used in hierarchical API

Tip

The arguments are used to initialize data attributes with the same names.

Parameters

flood_protection_profile (vmware.vapi.struct.VapiStruct) – Contains the actual FloodProtectionProfile object When clients pass a value of this class as a parameter, the attribute must contain all the attributes defined in FloodProtectionProfile. When methods return a value of this class as a return value, the attribute will contain all the attributes defined in FloodProtectionProfile.
links (list of ResourceLink or None) – The server will populate this field when returing the resource. Ignored on PUT and POST. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
schema (str or None) – Schema for this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
self (SelfResourceLink or None) – Link to this resource
revision (long or None) – The _revision property describes the current revision of the resource. To prevent clients from overwriting each other’s changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected. format: int32
create_time (long or None) – Timestamp of resource creation format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
create_user (str or None) – ID of the user who created this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
last_modified_time (long or None) – Timestamp of last modification format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
last_modified_user (str or None) – ID of the user who last modified this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
protection (str or None) – Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super user and can modify it, but only when providing the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this entity. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
system_owned (bool or None) – Indicates system owned resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
description (str or None) – Description of this resource
display_name (str or None) – Defaults to ID if not set
id (str or None) – Unique identifier of this resource
resource_type (str) –
tags (list of Tag or None) – Opaque identifiers meaningful to the API user
marked_for_delete (bool or None) – If this field is set to true, delete operation is triggered on the intent tree. This resource along with its all children in intent tree will be deleted. This is a cascade delete and should only be used if intent object along with its all children are to be deleted. This does not support deletion of single non-leaf node within the tree and should be used carefully.

property resource_type¶: Return the discriminator value

class com.vmware.nsx_policy.model_client.ChildFloodProtectionProfileBindingMap(flood_protection_profile_binding_map=None, links=None, schema=None, self_=None, revision=None, create_time=None, create_user=None, last_modified_time=None, last_modified_user=None, protection=None, system_owned=None, description=None, display_name=None, id=None, resource_type=None, tags=None, marked_for_delete=None)¶

Bases: vmware.vapi.bindings.struct.VapiStruct

Child wrapper object for FloodProtectionProfileBindingMap, used in hierarchical API

Tip

The arguments are used to initialize data attributes with the same names.

Parameters

flood_protection_profile_binding_map (FloodProtectionProfileBindingMap) – Contains the actual FloodProtectionProfileBindingMap object
links (list of ResourceLink or None) – The server will populate this field when returing the resource. Ignored on PUT and POST. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
schema (str or None) – Schema for this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
self (SelfResourceLink or None) – Link to this resource
revision (long or None) – The _revision property describes the current revision of the resource. To prevent clients from overwriting each other’s changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected. format: int32
create_time (long or None) – Timestamp of resource creation format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
create_user (str or None) – ID of the user who created this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
last_modified_time (long or None) – Timestamp of last modification format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
last_modified_user (str or None) – ID of the user who last modified this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
protection (str or None) – Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super user and can modify it, but only when providing the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this entity. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
system_owned (bool or None) – Indicates system owned resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
description (str or None) – Description of this resource
display_name (str or None) – Defaults to ID if not set
id (str or None) – Unique identifier of this resource
resource_type (str) –
tags (list of Tag or None) – Opaque identifiers meaningful to the API user
marked_for_delete (bool or None) – If this field is set to true, delete operation is triggered on the intent tree. This resource along with its all children in intent tree will be deleted. This is a cascade delete and should only be used if intent object along with its all children are to be deleted. This does not support deletion of single non-leaf node within the tree and should be used carefully.

property resource_type¶: Return the discriminator value

class com.vmware.nsx_policy.model_client.ChildForwardingPolicy(forwarding_policy=None, links=None, schema=None, self_=None, revision=None, create_time=None, create_user=None, last_modified_time=None, last_modified_user=None, protection=None, system_owned=None, description=None, display_name=None, id=None, resource_type=None, tags=None, marked_for_delete=None)¶

Bases: vmware.vapi.bindings.struct.VapiStruct

Child wrapper object for ForwardingPolicy used in Hierarchical API.

Tip

The arguments are used to initialize data attributes with the same names.

Parameters

forwarding_policy (ForwardingPolicy) – Contains actual ForwardingPolicy.
links (list of ResourceLink or None) – The server will populate this field when returing the resource. Ignored on PUT and POST. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
schema (str or None) – Schema for this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
self (SelfResourceLink or None) – Link to this resource
revision (long or None) – The _revision property describes the current revision of the resource. To prevent clients from overwriting each other’s changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected. format: int32
create_time (long or None) – Timestamp of resource creation format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
create_user (str or None) – ID of the user who created this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
last_modified_time (long or None) – Timestamp of last modification format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
last_modified_user (str or None) – ID of the user who last modified this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
protection (str or None) – Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super user and can modify it, but only when providing the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this entity. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
system_owned (bool or None) – Indicates system owned resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
description (str or None) – Description of this resource
display_name (str or None) – Defaults to ID if not set
id (str or None) – Unique identifier of this resource
resource_type (str) –
tags (list of Tag or None) – Opaque identifiers meaningful to the API user
marked_for_delete (bool or None) – If this field is set to true, delete operation is triggered on the intent tree. This resource along with its all children in intent tree will be deleted. This is a cascade delete and should only be used if intent object along with its all children are to be deleted. This does not support deletion of single non-leaf node within the tree and should be used carefully.

property resource_type¶: Return the discriminator value

class com.vmware.nsx_policy.model_client.ChildForwardingRule(forwarding_rule=None, links=None, schema=None, self_=None, revision=None, create_time=None, create_user=None, last_modified_time=None, last_modified_user=None, protection=None, system_owned=None, description=None, display_name=None, id=None, resource_type=None, tags=None, marked_for_delete=None)¶

Bases: vmware.vapi.bindings.struct.VapiStruct

Child wrapper object for ForwardingRule used in Hierarchical API.

Tip

The arguments are used to initialize data attributes with the same names.

Parameters

forwarding_rule (ForwardingRule) – Contains actual ForwardingRule.
links (list of ResourceLink or None) – The server will populate this field when returing the resource. Ignored on PUT and POST. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
schema (str or None) – Schema for this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
self (SelfResourceLink or None) – Link to this resource
revision (long or None) – The _revision property describes the current revision of the resource. To prevent clients from overwriting each other’s changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected. format: int32
create_time (long or None) – Timestamp of resource creation format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
create_user (str or None) – ID of the user who created this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
last_modified_time (long or None) – Timestamp of last modification format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
last_modified_user (str or None) – ID of the user who last modified this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
protection (str or None) – Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super user and can modify it, but only when providing the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this entity. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
system_owned (bool or None) – Indicates system owned resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
description (str or None) – Description of this resource
display_name (str or None) – Defaults to ID if not set
id (str or None) – Unique identifier of this resource
resource_type (str) –
tags (list of Tag or None) – Opaque identifiers meaningful to the API user
marked_for_delete (bool or None) – If this field is set to true, delete operation is triggered on the intent tree. This resource along with its all children in intent tree will be deleted. This is a cascade delete and should only be used if intent object along with its all children are to be deleted. This does not support deletion of single non-leaf node within the tree and should be used carefully.

property resource_type¶: Return the discriminator value

class com.vmware.nsx_policy.model_client.ChildGatewayPolicy(gateway_policy=None, links=None, schema=None, self_=None, revision=None, create_time=None, create_user=None, last_modified_time=None, last_modified_user=None, protection=None, system_owned=None, description=None, display_name=None, id=None, resource_type=None, tags=None, marked_for_delete=None)¶

Bases: vmware.vapi.bindings.struct.VapiStruct

Child wrapper object for GatewayPolicy, used in hierarchical API

Tip

The arguments are used to initialize data attributes with the same names.

Parameters

gateway_policy (GatewayPolicy) – Contains the actual GatewayPolicy object
links (list of ResourceLink or None) – The server will populate this field when returing the resource. Ignored on PUT and POST. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
schema (str or None) – Schema for this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
self (SelfResourceLink or None) – Link to this resource
revision (long or None) – The _revision property describes the current revision of the resource. To prevent clients from overwriting each other’s changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected. format: int32
create_time (long or None) – Timestamp of resource creation format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
create_user (str or None) – ID of the user who created this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
last_modified_time (long or None) – Timestamp of last modification format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
last_modified_user (str or None) – ID of the user who last modified this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
protection (str or None) – Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super user and can modify it, but only when providing the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this entity. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
system_owned (bool or None) – Indicates system owned resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
description (str or None) – Description of this resource
display_name (str or None) – Defaults to ID if not set
id (str or None) – Unique identifier of this resource
resource_type (str) –
tags (list of Tag or None) – Opaque identifiers meaningful to the API user
marked_for_delete (bool or None) – If this field is set to true, delete operation is triggered on the intent tree. This resource along with its all children in intent tree will be deleted. This is a cascade delete and should only be used if intent object along with its all children are to be deleted. This does not support deletion of single non-leaf node within the tree and should be used carefully.

property resource_type¶: Return the discriminator value

class com.vmware.nsx_policy.model_client.ChildGlobalConfig(global_config=None, links=None, schema=None, self_=None, revision=None, create_time=None, create_user=None, last_modified_time=None, last_modified_user=None, protection=None, system_owned=None, description=None, display_name=None, id=None, resource_type=None, tags=None, marked_for_delete=None)¶

Bases: vmware.vapi.bindings.struct.VapiStruct

Child wrapper object for GlobalConfig, used in hierarchical API

Tip

The arguments are used to initialize data attributes with the same names.

Parameters

global_config (GlobalConfig) – Contains the actual GlobalConfig object.
links (list of ResourceLink or None) – The server will populate this field when returing the resource. Ignored on PUT and POST. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
schema (str or None) – Schema for this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
self (SelfResourceLink or None) – Link to this resource
revision (long or None) – The _revision property describes the current revision of the resource. To prevent clients from overwriting each other’s changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected. format: int32
create_time (long or None) – Timestamp of resource creation format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
create_user (str or None) – ID of the user who created this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
last_modified_time (long or None) – Timestamp of last modification format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
last_modified_user (str or None) – ID of the user who last modified this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
protection (str or None) – Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super user and can modify it, but only when providing the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this entity. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
system_owned (bool or None) – Indicates system owned resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
description (str or None) – Description of this resource
display_name (str or None) – Defaults to ID if not set
id (str or None) – Unique identifier of this resource
resource_type (str) –
tags (list of Tag or None) – Opaque identifiers meaningful to the API user
marked_for_delete (bool or None) – If this field is set to true, delete operation is triggered on the intent tree. This resource along with its all children in intent tree will be deleted. This is a cascade delete and should only be used if intent object along with its all children are to be deleted. This does not support deletion of single non-leaf node within the tree and should be used carefully.

property resource_type¶: Return the discriminator value

class com.vmware.nsx_policy.model_client.ChildGroup(group=None, links=None, schema=None, self_=None, revision=None, create_time=None, create_user=None, last_modified_time=None, last_modified_user=None, protection=None, system_owned=None, description=None, display_name=None, id=None, resource_type=None, tags=None, marked_for_delete=None)¶

Bases: vmware.vapi.bindings.struct.VapiStruct

Child wrapper object for group, used in hierarchical API.

Tip

The arguments are used to initialize data attributes with the same names.

Parameters

group (Group) – Contains the actual group objects.
links (list of ResourceLink or None) – The server will populate this field when returing the resource. Ignored on PUT and POST. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
schema (str or None) – Schema for this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
self (SelfResourceLink or None) – Link to this resource
revision (long or None) – The _revision property describes the current revision of the resource. To prevent clients from overwriting each other’s changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected. format: int32
create_time (long or None) – Timestamp of resource creation format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
create_user (str or None) – ID of the user who created this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
last_modified_time (long or None) – Timestamp of last modification format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
last_modified_user (str or None) – ID of the user who last modified this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
protection (str or None) – Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super user and can modify it, but only when providing the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this entity. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
system_owned (bool or None) – Indicates system owned resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
description (str or None) – Description of this resource
display_name (str or None) – Defaults to ID if not set
id (str or None) – Unique identifier of this resource
resource_type (str) –
tags (list of Tag or None) – Opaque identifiers meaningful to the API user
marked_for_delete (bool or None) – If this field is set to true, delete operation is triggered on the intent tree. This resource along with its all children in intent tree will be deleted. This is a cascade delete and should only be used if intent object along with its all children are to be deleted. This does not support deletion of single non-leaf node within the tree and should be used carefully.

property resource_type¶: Return the discriminator value

class com.vmware.nsx_policy.model_client.ChildGroupMonitoringProfileBindingMap(group_monitoring_profile_binding_map=None, links=None, schema=None, self_=None, revision=None, create_time=None, create_user=None, last_modified_time=None, last_modified_user=None, protection=None, system_owned=None, description=None, display_name=None, id=None, resource_type=None, tags=None, marked_for_delete=None)¶

Bases: vmware.vapi.bindings.struct.VapiStruct

Child wrapper object for GroupMonitoringProfileBindingMap, used in hierarchical API

Tip

The arguments are used to initialize data attributes with the same names.

Parameters

group_monitoring_profile_binding_map (GroupMonitoringProfileBindingMap) – Contains the actual GroupMonitoringProfileBindingMap object
links (list of ResourceLink or None) – The server will populate this field when returing the resource. Ignored on PUT and POST. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
schema (str or None) – Schema for this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
self (SelfResourceLink or None) – Link to this resource
revision (long or None) – The _revision property describes the current revision of the resource. To prevent clients from overwriting each other’s changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected. format: int32
create_time (long or None) – Timestamp of resource creation format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
create_user (str or None) – ID of the user who created this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
last_modified_time (long or None) – Timestamp of last modification format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
last_modified_user (str or None) – ID of the user who last modified this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
protection (str or None) – Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super user and can modify it, but only when providing the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this entity. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
system_owned (bool or None) – Indicates system owned resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
description (str or None) – Description of this resource
display_name (str or None) – Defaults to ID if not set
id (str or None) – Unique identifier of this resource
resource_type (str) –
tags (list of Tag or None) – Opaque identifiers meaningful to the API user
marked_for_delete (bool or None) – If this field is set to true, delete operation is triggered on the intent tree. This resource along with its all children in intent tree will be deleted. This is a cascade delete and should only be used if intent object along with its all children are to be deleted. This does not support deletion of single non-leaf node within the tree and should be used carefully.

property resource_type¶: Return the discriminator value

class com.vmware.nsx_policy.model_client.ChildIPDiscoveryProfile(ip_discovery_profile=None, links=None, schema=None, self_=None, revision=None, create_time=None, create_user=None, last_modified_time=None, last_modified_user=None, protection=None, system_owned=None, description=None, display_name=None, id=None, resource_type=None, tags=None, marked_for_delete=None)¶

Bases: vmware.vapi.bindings.struct.VapiStruct

Child wrapper object for IPDiscoveryProfile, used in hierarchical API

Tip

The arguments are used to initialize data attributes with the same names.

Parameters

ip_discovery_profile (IPDiscoveryProfile) – Contains the actual IPDiscoveryProfile object
links (list of ResourceLink or None) – The server will populate this field when returing the resource. Ignored on PUT and POST. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
schema (str or None) – Schema for this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
self (SelfResourceLink or None) – Link to this resource
revision (long or None) – The _revision property describes the current revision of the resource. To prevent clients from overwriting each other’s changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected. format: int32
create_time (long or None) – Timestamp of resource creation format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
create_user (str or None) – ID of the user who created this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
last_modified_time (long or None) – Timestamp of last modification format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
last_modified_user (str or None) – ID of the user who last modified this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
protection (str or None) – Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super user and can modify it, but only when providing the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this entity. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
system_owned (bool or None) – Indicates system owned resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
description (str or None) – Description of this resource
display_name (str or None) – Defaults to ID if not set
id (str or None) – Unique identifier of this resource
resource_type (str) –
tags (list of Tag or None) – Opaque identifiers meaningful to the API user
marked_for_delete (bool or None) – If this field is set to true, delete operation is triggered on the intent tree. This resource along with its all children in intent tree will be deleted. This is a cascade delete and should only be used if intent object along with its all children are to be deleted. This does not support deletion of single non-leaf node within the tree and should be used carefully.

property resource_type¶: Return the discriminator value

class com.vmware.nsx_policy.model_client.ChildIPFIXDFWCollectorProfile(i_pfixdfw_collector_profile=None, links=None, schema=None, self_=None, revision=None, create_time=None, create_user=None, last_modified_time=None, last_modified_user=None, protection=None, system_owned=None, description=None, display_name=None, id=None, resource_type=None, tags=None, marked_for_delete=None)¶

Bases: vmware.vapi.bindings.struct.VapiStruct

Child wrapper object for IPFIXDFWCollectorProfile, used in hierarchical API

Tip

The arguments are used to initialize data attributes with the same names.

Parameters

i_pfixdfw_collector_profile (IPFIXDFWCollectorProfile) – Contains the actual IPFIXDFWCollectorProfile object
links (list of ResourceLink or None) – The server will populate this field when returing the resource. Ignored on PUT and POST. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
schema (str or None) – Schema for this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
self (SelfResourceLink or None) – Link to this resource
revision (long or None) – The _revision property describes the current revision of the resource. To prevent clients from overwriting each other’s changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected. format: int32
create_time (long or None) – Timestamp of resource creation format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
create_user (str or None) – ID of the user who created this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
last_modified_time (long or None) – Timestamp of last modification format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
last_modified_user (str or None) – ID of the user who last modified this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
protection (str or None) – Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super user and can modify it, but only when providing the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this entity. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
system_owned (bool or None) – Indicates system owned resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
description (str or None) – Description of this resource
display_name (str or None) – Defaults to ID if not set
id (str or None) – Unique identifier of this resource
resource_type (str) –
tags (list of Tag or None) – Opaque identifiers meaningful to the API user
marked_for_delete (bool or None) – If this field is set to true, delete operation is triggered on the intent tree. This resource along with its all children in intent tree will be deleted. This is a cascade delete and should only be used if intent object along with its all children are to be deleted. This does not support deletion of single non-leaf node within the tree and should be used carefully.

property resource_type¶: Return the discriminator value

class com.vmware.nsx_policy.model_client.ChildIPFIXDFWProfile(i_pfixdfw_profile=None, links=None, schema=None, self_=None, revision=None, create_time=None, create_user=None, last_modified_time=None, last_modified_user=None, protection=None, system_owned=None, description=None, display_name=None, id=None, resource_type=None, tags=None, marked_for_delete=None)¶

Bases: vmware.vapi.bindings.struct.VapiStruct

Child wrapper object for IPFIXDFWProfile, used in hierarchical API

Tip

The arguments are used to initialize data attributes with the same names.

Parameters

i_pfixdfw_profile (IPFIXDFWProfile) – Contains the actual IPFIXDFWProfile object
links (list of ResourceLink or None) – The server will populate this field when returing the resource. Ignored on PUT and POST. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
schema (str or None) – Schema for this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
self (SelfResourceLink or None) – Link to this resource
revision (long or None) – The _revision property describes the current revision of the resource. To prevent clients from overwriting each other’s changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected. format: int32
create_time (long or None) – Timestamp of resource creation format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
create_user (str or None) – ID of the user who created this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
last_modified_time (long or None) – Timestamp of last modification format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
last_modified_user (str or None) – ID of the user who last modified this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
protection (str or None) – Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super user and can modify it, but only when providing the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this entity. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
system_owned (bool or None) – Indicates system owned resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
description (str or None) – Description of this resource
display_name (str or None) – Defaults to ID if not set
id (str or None) – Unique identifier of this resource
resource_type (str) –
tags (list of Tag or None) – Opaque identifiers meaningful to the API user
marked_for_delete (bool or None) – If this field is set to true, delete operation is triggered on the intent tree. This resource along with its all children in intent tree will be deleted. This is a cascade delete and should only be used if intent object along with its all children are to be deleted. This does not support deletion of single non-leaf node within the tree and should be used carefully.

property resource_type¶: Return the discriminator value

class com.vmware.nsx_policy.model_client.ChildIPFIXL2CollectorProfile(i_pfix_l2_collector_profile=None, links=None, schema=None, self_=None, revision=None, create_time=None, create_user=None, last_modified_time=None, last_modified_user=None, protection=None, system_owned=None, description=None, display_name=None, id=None, resource_type=None, tags=None, marked_for_delete=None)¶

Bases: vmware.vapi.bindings.struct.VapiStruct

Child wrapper object for IPFIXL2CollectorProfile, used in hierarchical API

Tip

The arguments are used to initialize data attributes with the same names.

Parameters

i_pfix_l2_collector_profile (IPFIXL2CollectorProfile) – Contains the actual IPFIXL2CollectorProfile object
links (list of ResourceLink or None) – The server will populate this field when returing the resource. Ignored on PUT and POST. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
schema (str or None) – Schema for this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
self (SelfResourceLink or None) – Link to this resource
revision (long or None) – The _revision property describes the current revision of the resource. To prevent clients from overwriting each other’s changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected. format: int32
create_time (long or None) – Timestamp of resource creation format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
create_user (str or None) – ID of the user who created this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
last_modified_time (long or None) – Timestamp of last modification format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
last_modified_user (str or None) – ID of the user who last modified this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
protection (str or None) – Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super user and can modify it, but only when providing the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this entity. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
system_owned (bool or None) – Indicates system owned resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
description (str or None) – Description of this resource
display_name (str or None) – Defaults to ID if not set
id (str or None) – Unique identifier of this resource
resource_type (str) –
tags (list of Tag or None) – Opaque identifiers meaningful to the API user
marked_for_delete (bool or None) – If this field is set to true, delete operation is triggered on the intent tree. This resource along with its all children in intent tree will be deleted. This is a cascade delete and should only be used if intent object along with its all children are to be deleted. This does not support deletion of single non-leaf node within the tree and should be used carefully.

property resource_type¶: Return the discriminator value

class com.vmware.nsx_policy.model_client.ChildIPFIXL2Profile(i_pfix_l2_profile=None, links=None, schema=None, self_=None, revision=None, create_time=None, create_user=None, last_modified_time=None, last_modified_user=None, protection=None, system_owned=None, description=None, display_name=None, id=None, resource_type=None, tags=None, marked_for_delete=None)¶

Bases: vmware.vapi.bindings.struct.VapiStruct

Child wrapper object for IPFIXL2Profile, used in hierarchical API

Tip

The arguments are used to initialize data attributes with the same names.

Parameters

i_pfix_l2_profile (IPFIXL2Profile) – Contains the actual IPFIXL2Profile object
links (list of ResourceLink or None) – The server will populate this field when returing the resource. Ignored on PUT and POST. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
schema (str or None) – Schema for this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
self (SelfResourceLink or None) – Link to this resource
revision (long or None) – The _revision property describes the current revision of the resource. To prevent clients from overwriting each other’s changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected. format: int32
create_time (long or None) – Timestamp of resource creation format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
create_user (str or None) – ID of the user who created this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
last_modified_time (long or None) – Timestamp of last modification format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
last_modified_user (str or None) – ID of the user who last modified this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
protection (str or None) – Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super user and can modify it, but only when providing the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this entity. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
system_owned (bool or None) – Indicates system owned resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
description (str or None) – Description of this resource
display_name (str or None) – Defaults to ID if not set
id (str or None) – Unique identifier of this resource
resource_type (str) –
tags (list of Tag or None) – Opaque identifiers meaningful to the API user
marked_for_delete (bool or None) – If this field is set to true, delete operation is triggered on the intent tree. This resource along with its all children in intent tree will be deleted. This is a cascade delete and should only be used if intent object along with its all children are to be deleted. This does not support deletion of single non-leaf node within the tree and should be used carefully.

property resource_type¶: Return the discriminator value

class com.vmware.nsx_policy.model_client.ChildIPSecVpnDpdProfile(ip_sec_vpn_dpd_profile=None, links=None, schema=None, self_=None, revision=None, create_time=None, create_user=None, last_modified_time=None, last_modified_user=None, protection=None, system_owned=None, description=None, display_name=None, id=None, resource_type=None, tags=None, marked_for_delete=None)¶

Bases: vmware.vapi.bindings.struct.VapiStruct

Child wrapper object for IPSecVpnDpdProfile, used in hierarchical API.

Tip

The arguments are used to initialize data attributes with the same names.

Parameters

ip_sec_vpn_dpd_profile (IPSecVpnDpdProfile) – Contains the actual IPSecVpnDpdProfile object.
links (list of ResourceLink or None) – The server will populate this field when returing the resource. Ignored on PUT and POST. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
schema (str or None) – Schema for this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
self (SelfResourceLink or None) – Link to this resource
revision (long or None) – The _revision property describes the current revision of the resource. To prevent clients from overwriting each other’s changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected. format: int32
create_time (long or None) – Timestamp of resource creation format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
create_user (str or None) – ID of the user who created this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
last_modified_time (long or None) – Timestamp of last modification format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
last_modified_user (str or None) – ID of the user who last modified this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
protection (str or None) – Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super user and can modify it, but only when providing the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this entity. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
system_owned (bool or None) – Indicates system owned resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
description (str or None) – Description of this resource
display_name (str or None) – Defaults to ID if not set
id (str or None) – Unique identifier of this resource
resource_type (str) –
tags (list of Tag or None) – Opaque identifiers meaningful to the API user
marked_for_delete (bool or None) – If this field is set to true, delete operation is triggered on the intent tree. This resource along with its all children in intent tree will be deleted. This is a cascade delete and should only be used if intent object along with its all children are to be deleted. This does not support deletion of single non-leaf node within the tree and should be used carefully.

property resource_type¶: Return the discriminator value

class com.vmware.nsx_policy.model_client.ChildIPSecVpnIkeProfile(ip_sec_vpn_ike_profile=None, links=None, schema=None, self_=None, revision=None, create_time=None, create_user=None, last_modified_time=None, last_modified_user=None, protection=None, system_owned=None, description=None, display_name=None, id=None, resource_type=None, tags=None, marked_for_delete=None)¶

Bases: vmware.vapi.bindings.struct.VapiStruct

Child wrapper object for IPSecVpnIkeProfile, used in hierarchical API.

Tip

The arguments are used to initialize data attributes with the same names.

Parameters

ip_sec_vpn_ike_profile (IPSecVpnIkeProfile) – Contains the actual IPSecVpnIkeProfile object.
links (list of ResourceLink or None) – The server will populate this field when returing the resource. Ignored on PUT and POST. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
schema (str or None) – Schema for this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
self (SelfResourceLink or None) – Link to this resource
revision (long or None) – The _revision property describes the current revision of the resource. To prevent clients from overwriting each other’s changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected. format: int32
create_time (long or None) – Timestamp of resource creation format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
create_user (str or None) – ID of the user who created this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
last_modified_time (long or None) – Timestamp of last modification format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
last_modified_user (str or None) – ID of the user who last modified this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
protection (str or None) – Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super user and can modify it, but only when providing the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this entity. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
system_owned (bool or None) – Indicates system owned resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
description (str or None) – Description of this resource
display_name (str or None) – Defaults to ID if not set
id (str or None) – Unique identifier of this resource
resource_type (str) –
tags (list of Tag or None) – Opaque identifiers meaningful to the API user
marked_for_delete (bool or None) – If this field is set to true, delete operation is triggered on the intent tree. This resource along with its all children in intent tree will be deleted. This is a cascade delete and should only be used if intent object along with its all children are to be deleted. This does not support deletion of single non-leaf node within the tree and should be used carefully.

property resource_type¶: Return the discriminator value

class com.vmware.nsx_policy.model_client.ChildIPSecVpnLocalEndpoint(ip_sec_vpn_local_endpoint=None, links=None, schema=None, self_=None, revision=None, create_time=None, create_user=None, last_modified_time=None, last_modified_user=None, protection=None, system_owned=None, description=None, display_name=None, id=None, resource_type=None, tags=None, marked_for_delete=None)¶

Bases: vmware.vapi.bindings.struct.VapiStruct

Child wrapper object for IPSecVpnLocalEndpoint, used in hierarchical API.

Tip

The arguments are used to initialize data attributes with the same names.

Parameters

ip_sec_vpn_local_endpoint (IPSecVpnLocalEndpoint) – Contains the actual IPSecVpnLocalEndpoint object.
links (list of ResourceLink or None) – The server will populate this field when returing the resource. Ignored on PUT and POST. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
schema (str or None) – Schema for this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
self (SelfResourceLink or None) – Link to this resource
revision (long or None) – The _revision property describes the current revision of the resource. To prevent clients from overwriting each other’s changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected. format: int32
create_time (long or None) – Timestamp of resource creation format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
create_user (str or None) – ID of the user who created this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
last_modified_time (long or None) – Timestamp of last modification format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
last_modified_user (str or None) – ID of the user who last modified this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
protection (str or None) – Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super user and can modify it, but only when providing the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this entity. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
system_owned (bool or None) – Indicates system owned resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
description (str or None) – Description of this resource
display_name (str or None) – Defaults to ID if not set
id (str or None) – Unique identifier of this resource
resource_type (str) –
tags (list of Tag or None) – Opaque identifiers meaningful to the API user
marked_for_delete (bool or None) – If this field is set to true, delete operation is triggered on the intent tree. This resource along with its all children in intent tree will be deleted. This is a cascade delete and should only be used if intent object along with its all children are to be deleted. This does not support deletion of single non-leaf node within the tree and should be used carefully.

property resource_type¶: Return the discriminator value

class com.vmware.nsx_policy.model_client.ChildIPSecVpnService(ip_sec_vpn_service=None, links=None, schema=None, self_=None, revision=None, create_time=None, create_user=None, last_modified_time=None, last_modified_user=None, protection=None, system_owned=None, description=None, display_name=None, id=None, resource_type=None, tags=None, marked_for_delete=None)¶

Bases: vmware.vapi.bindings.struct.VapiStruct

Child wrapper object for IPSecVpnService, used in hierarchical API.

Tip

The arguments are used to initialize data attributes with the same names.

Parameters

ip_sec_vpn_service (IPSecVpnService) – Contains the actual IPSecVpnService object.
links (list of ResourceLink or None) – The server will populate this field when returing the resource. Ignored on PUT and POST. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
schema (str or None) – Schema for this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
self (SelfResourceLink or None) – Link to this resource
revision (long or None) – The _revision property describes the current revision of the resource. To prevent clients from overwriting each other’s changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected. format: int32
create_time (long or None) – Timestamp of resource creation format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
create_user (str or None) – ID of the user who created this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
last_modified_time (long or None) – Timestamp of last modification format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
last_modified_user (str or None) – ID of the user who last modified this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
protection (str or None) – Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super user and can modify it, but only when providing the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this entity. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
system_owned (bool or None) – Indicates system owned resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
description (str or None) – Description of this resource
display_name (str or None) – Defaults to ID if not set
id (str or None) – Unique identifier of this resource
resource_type (str) –
tags (list of Tag or None) – Opaque identifiers meaningful to the API user
marked_for_delete (bool or None) – If this field is set to true, delete operation is triggered on the intent tree. This resource along with its all children in intent tree will be deleted. This is a cascade delete and should only be used if intent object along with its all children are to be deleted. This does not support deletion of single non-leaf node within the tree and should be used carefully.

property resource_type¶: Return the discriminator value

class com.vmware.nsx_policy.model_client.ChildIPSecVpnSession(ip_sec_vpn_session=None, links=None, schema=None, self_=None, revision=None, create_time=None, create_user=None, last_modified_time=None, last_modified_user=None, protection=None, system_owned=None, description=None, display_name=None, id=None, resource_type=None, tags=None, marked_for_delete=None)¶

Bases: vmware.vapi.bindings.struct.VapiStruct

Child wrapper object for IPSecVpnSession, used in hierarchical API.

Tip

The arguments are used to initialize data attributes with the same names.

Parameters

ip_sec_vpn_session (vmware.vapi.struct.VapiStruct) – Contains the actual IPSecVpnSession object. When clients pass a value of this class as a parameter, the attribute must contain all the attributes defined in IPSecVpnSession. When methods return a value of this class as a return value, the attribute will contain all the attributes defined in IPSecVpnSession.
links (list of ResourceLink or None) – The server will populate this field when returing the resource. Ignored on PUT and POST. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
schema (str or None) – Schema for this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
self (SelfResourceLink or None) – Link to this resource
revision (long or None) – The _revision property describes the current revision of the resource. To prevent clients from overwriting each other’s changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected. format: int32
create_time (long or None) – Timestamp of resource creation format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
create_user (str or None) – ID of the user who created this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
last_modified_time (long or None) – Timestamp of last modification format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
last_modified_user (str or None) – ID of the user who last modified this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
protection (str or None) – Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super user and can modify it, but only when providing the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this entity. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
system_owned (bool or None) – Indicates system owned resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
description (str or None) – Description of this resource
display_name (str or None) – Defaults to ID if not set
id (str or None) – Unique identifier of this resource
resource_type (str) –
tags (list of Tag or None) – Opaque identifiers meaningful to the API user
marked_for_delete (bool or None) – If this field is set to true, delete operation is triggered on the intent tree. This resource along with its all children in intent tree will be deleted. This is a cascade delete and should only be used if intent object along with its all children are to be deleted. This does not support deletion of single non-leaf node within the tree and should be used carefully.

property resource_type¶: Return the discriminator value

class com.vmware.nsx_policy.model_client.ChildIPSecVpnTunnelProfile(ip_sec_vpn_tunnel_profile=None, links=None, schema=None, self_=None, revision=None, create_time=None, create_user=None, last_modified_time=None, last_modified_user=None, protection=None, system_owned=None, description=None, display_name=None, id=None, resource_type=None, tags=None, marked_for_delete=None)¶

Bases: vmware.vapi.bindings.struct.VapiStruct

Child wrapper object for IPSecVpnTunnelProfile, used in hierarchical API.

Tip

The arguments are used to initialize data attributes with the same names.

Parameters

ip_sec_vpn_tunnel_profile (IPSecVpnTunnelProfile) – Contains the actual IPSecVpnTunnelProfile object
links (list of ResourceLink or None) – The server will populate this field when returing the resource. Ignored on PUT and POST. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
schema (str or None) – Schema for this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
self (SelfResourceLink or None) – Link to this resource
revision (long or None) – The _revision property describes the current revision of the resource. To prevent clients from overwriting each other’s changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected. format: int32
create_time (long or None) – Timestamp of resource creation format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
create_user (str or None) – ID of the user who created this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
last_modified_time (long or None) – Timestamp of last modification format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
last_modified_user (str or None) – ID of the user who last modified this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
protection (str or None) – Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super user and can modify it, but only when providing the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this entity. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
system_owned (bool or None) – Indicates system owned resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
description (str or None) – Description of this resource
display_name (str or None) – Defaults to ID if not set
id (str or None) – Unique identifier of this resource
resource_type (str) –
tags (list of Tag or None) – Opaque identifiers meaningful to the API user
marked_for_delete (bool or None) – If this field is set to true, delete operation is triggered on the intent tree. This resource along with its all children in intent tree will be deleted. This is a cascade delete and should only be used if intent object along with its all children are to be deleted. This does not support deletion of single non-leaf node within the tree and should be used carefully.

property resource_type¶: Return the discriminator value

class com.vmware.nsx_policy.model_client.ChildIpAddressAllocation(ip_address_allocation=None, links=None, schema=None, self_=None, revision=None, create_time=None, create_user=None, last_modified_time=None, last_modified_user=None, protection=None, system_owned=None, description=None, display_name=None, id=None, resource_type=None, tags=None, marked_for_delete=None)¶

Bases: vmware.vapi.bindings.struct.VapiStruct

Child wrapper object for IpAddressAllocation, used in hierarchical API

Tip

The arguments are used to initialize data attributes with the same names.

Parameters

ip_address_allocation (IpAddressAllocation) – Contains the actual IpAddressAllocation object
links (list of ResourceLink or None) – The server will populate this field when returing the resource. Ignored on PUT and POST. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
schema (str or None) – Schema for this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
self (SelfResourceLink or None) – Link to this resource
revision (long or None) – The _revision property describes the current revision of the resource. To prevent clients from overwriting each other’s changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected. format: int32
create_time (long or None) – Timestamp of resource creation format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
create_user (str or None) – ID of the user who created this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
last_modified_time (long or None) – Timestamp of last modification format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
last_modified_user (str or None) – ID of the user who last modified this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
protection (str or None) – Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super user and can modify it, but only when providing the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this entity. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
system_owned (bool or None) – Indicates system owned resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
description (str or None) – Description of this resource
display_name (str or None) – Defaults to ID if not set
id (str or None) – Unique identifier of this resource
resource_type (str) –
tags (list of Tag or None) – Opaque identifiers meaningful to the API user
marked_for_delete (bool or None) – If this field is set to true, delete operation is triggered on the intent tree. This resource along with its all children in intent tree will be deleted. This is a cascade delete and should only be used if intent object along with its all children are to be deleted. This does not support deletion of single non-leaf node within the tree and should be used carefully.

property resource_type¶: Return the discriminator value

class com.vmware.nsx_policy.model_client.ChildIpAddressBlock(ip_address_block=None, links=None, schema=None, self_=None, revision=None, create_time=None, create_user=None, last_modified_time=None, last_modified_user=None, protection=None, system_owned=None, description=None, display_name=None, id=None, resource_type=None, tags=None, marked_for_delete=None)¶

Bases: vmware.vapi.bindings.struct.VapiStruct

Child wrapper object for IpAddressBlock, used in hierarchical API

Tip

The arguments are used to initialize data attributes with the same names.

Parameters

ip_address_block (IpAddressBlock) – Contains the actual IpAddressBlock object
links (list of ResourceLink or None) – The server will populate this field when returing the resource. Ignored on PUT and POST. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
schema (str or None) – Schema for this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
self (SelfResourceLink or None) – Link to this resource
revision (long or None) – The _revision property describes the current revision of the resource. To prevent clients from overwriting each other’s changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected. format: int32
create_time (long or None) – Timestamp of resource creation format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
create_user (str or None) – ID of the user who created this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
last_modified_time (long or None) – Timestamp of last modification format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
last_modified_user (str or None) – ID of the user who last modified this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
protection (str or None) – Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super user and can modify it, but only when providing the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this entity. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
system_owned (bool or None) – Indicates system owned resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
description (str or None) – Description of this resource
display_name (str or None) – Defaults to ID if not set
id (str or None) – Unique identifier of this resource
resource_type (str) –
tags (list of Tag or None) – Opaque identifiers meaningful to the API user
marked_for_delete (bool or None) – If this field is set to true, delete operation is triggered on the intent tree. This resource along with its all children in intent tree will be deleted. This is a cascade delete and should only be used if intent object along with its all children are to be deleted. This does not support deletion of single non-leaf node within the tree and should be used carefully.

property resource_type¶: Return the discriminator value

class com.vmware.nsx_policy.model_client.ChildIpAddressPool(ip_address_pool=None, links=None, schema=None, self_=None, revision=None, create_time=None, create_user=None, last_modified_time=None, last_modified_user=None, protection=None, system_owned=None, description=None, display_name=None, id=None, resource_type=None, tags=None, marked_for_delete=None)¶

Bases: vmware.vapi.bindings.struct.VapiStruct

Child wrapper object for IpAddressPool, used in hierarchical API

Tip

The arguments are used to initialize data attributes with the same names.

Parameters

ip_address_pool (IpAddressPool) – Contains the actual IpAddressPool object
links (list of ResourceLink or None) – The server will populate this field when returing the resource. Ignored on PUT and POST. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
schema (str or None) – Schema for this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
self (SelfResourceLink or None) – Link to this resource
revision (long or None) – The _revision property describes the current revision of the resource. To prevent clients from overwriting each other’s changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected. format: int32
create_time (long or None) – Timestamp of resource creation format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
create_user (str or None) – ID of the user who created this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
last_modified_time (long or None) – Timestamp of last modification format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
last_modified_user (str or None) – ID of the user who last modified this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
protection (str or None) – Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super user and can modify it, but only when providing the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this entity. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
system_owned (bool or None) – Indicates system owned resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
description (str or None) – Description of this resource
display_name (str or None) – Defaults to ID if not set
id (str or None) – Unique identifier of this resource
resource_type (str) –
tags (list of Tag or None) – Opaque identifiers meaningful to the API user
marked_for_delete (bool or None) – If this field is set to true, delete operation is triggered on the intent tree. This resource along with its all children in intent tree will be deleted. This is a cascade delete and should only be used if intent object along with its all children are to be deleted. This does not support deletion of single non-leaf node within the tree and should be used carefully.

property resource_type¶: Return the discriminator value

class com.vmware.nsx_policy.model_client.ChildIpAddressPoolSubnet(ip_address_pool_subnet=None, links=None, schema=None, self_=None, revision=None, create_time=None, create_user=None, last_modified_time=None, last_modified_user=None, protection=None, system_owned=None, description=None, display_name=None, id=None, resource_type=None, tags=None, marked_for_delete=None)¶

Bases: vmware.vapi.bindings.struct.VapiStruct

Child wrapper object for IpAddressPoolSubnet, used in hierarchical API

Tip

The arguments are used to initialize data attributes with the same names.

Parameters

ip_address_pool_subnet (vmware.vapi.struct.VapiStruct) – Contains the actual IpAddressPoolSubnet object When clients pass a value of this class as a parameter, the attribute must contain all the attributes defined in IpAddressPoolSubnet. When methods return a value of this class as a return value, the attribute will contain all the attributes defined in IpAddressPoolSubnet.
links (list of ResourceLink or None) – The server will populate this field when returing the resource. Ignored on PUT and POST. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
schema (str or None) – Schema for this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
self (SelfResourceLink or None) – Link to this resource
revision (long or None) – The _revision property describes the current revision of the resource. To prevent clients from overwriting each other’s changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected. format: int32
create_time (long or None) – Timestamp of resource creation format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
create_user (str or None) – ID of the user who created this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
last_modified_time (long or None) – Timestamp of last modification format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
last_modified_user (str or None) – ID of the user who last modified this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
protection (str or None) – Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super user and can modify it, but only when providing the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this entity. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
system_owned (bool or None) – Indicates system owned resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
description (str or None) – Description of this resource
display_name (str or None) – Defaults to ID if not set
id (str or None) – Unique identifier of this resource
resource_type (str) –
tags (list of Tag or None) – Opaque identifiers meaningful to the API user
marked_for_delete (bool or None) – If this field is set to true, delete operation is triggered on the intent tree. This resource along with its all children in intent tree will be deleted. This is a cascade delete and should only be used if intent object along with its all children are to be deleted. This does not support deletion of single non-leaf node within the tree and should be used carefully.

property resource_type¶: Return the discriminator value

class com.vmware.nsx_policy.model_client.ChildIpv6DadProfile(ipv6_dad_profile=None, links=None, schema=None, self_=None, revision=None, create_time=None, create_user=None, last_modified_time=None, last_modified_user=None, protection=None, system_owned=None, description=None, display_name=None, id=None, resource_type=None, tags=None, marked_for_delete=None)¶

Bases: vmware.vapi.bindings.struct.VapiStruct

Child wrapper object for Ipv6DadProfile, used in hierarchical API

Tip

The arguments are used to initialize data attributes with the same names.

Parameters

ipv6_dad_profile (Ipv6DadProfile) – Contains the actual Ipv6DadProfile objects
links (list of ResourceLink or None) – The server will populate this field when returing the resource. Ignored on PUT and POST. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
schema (str or None) – Schema for this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
self (SelfResourceLink or None) – Link to this resource
revision (long or None) – The _revision property describes the current revision of the resource. To prevent clients from overwriting each other’s changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected. format: int32
create_time (long or None) – Timestamp of resource creation format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
create_user (str or None) – ID of the user who created this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
last_modified_time (long or None) – Timestamp of last modification format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
last_modified_user (str or None) – ID of the user who last modified this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
protection (str or None) – Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super user and can modify it, but only when providing the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this entity. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
system_owned (bool or None) – Indicates system owned resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
description (str or None) – Description of this resource
display_name (str or None) – Defaults to ID if not set
id (str or None) – Unique identifier of this resource
resource_type (str) –
tags (list of Tag or None) – Opaque identifiers meaningful to the API user
marked_for_delete (bool or None) – If this field is set to true, delete operation is triggered on the intent tree. This resource along with its all children in intent tree will be deleted. This is a cascade delete and should only be used if intent object along with its all children are to be deleted. This does not support deletion of single non-leaf node within the tree and should be used carefully.

property resource_type¶: Return the discriminator value

class com.vmware.nsx_policy.model_client.ChildIpv6NdraProfile(ipv6_ndra_profile=None, links=None, schema=None, self_=None, revision=None, create_time=None, create_user=None, last_modified_time=None, last_modified_user=None, protection=None, system_owned=None, description=None, display_name=None, id=None, resource_type=None, tags=None, marked_for_delete=None)¶

Bases: vmware.vapi.bindings.struct.VapiStruct

Child wrapper object for Ipv6NdraProfile, used in hierarchical API

Tip

The arguments are used to initialize data attributes with the same names.

Parameters

ipv6_ndra_profile (Ipv6NdraProfile) – Contains the actual Ipv6NdraProfile objects
links (list of ResourceLink or None) – The server will populate this field when returing the resource. Ignored on PUT and POST. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
schema (str or None) – Schema for this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
self (SelfResourceLink or None) – Link to this resource
revision (long or None) – The _revision property describes the current revision of the resource. To prevent clients from overwriting each other’s changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected. format: int32
create_time (long or None) – Timestamp of resource creation format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
create_user (str or None) – ID of the user who created this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
last_modified_time (long or None) – Timestamp of last modification format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
last_modified_user (str or None) – ID of the user who last modified this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
protection (str or None) – Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super user and can modify it, but only when providing the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this entity. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
system_owned (bool or None) – Indicates system owned resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
description (str or None) – Description of this resource
display_name (str or None) – Defaults to ID if not set
id (str or None) – Unique identifier of this resource
resource_type (str) –
tags (list of Tag or None) – Opaque identifiers meaningful to the API user
marked_for_delete (bool or None) – If this field is set to true, delete operation is triggered on the intent tree. This resource along with its all children in intent tree will be deleted. This is a cascade delete and should only be used if intent object along with its all children are to be deleted. This does not support deletion of single non-leaf node within the tree and should be used carefully.

property resource_type¶: Return the discriminator value

class com.vmware.nsx_policy.model_client.ChildL2VPNService(l2_vpn_service=None, links=None, schema=None, self_=None, revision=None, create_time=None, create_user=None, last_modified_time=None, last_modified_user=None, protection=None, system_owned=None, description=None, display_name=None, id=None, resource_type=None, tags=None, marked_for_delete=None)¶

Bases: vmware.vapi.bindings.struct.VapiStruct

Child wrapper object for L2VPNService, used in hierarchical API.

Tip

The arguments are used to initialize data attributes with the same names.

Parameters

l2_vpn_service (L2VPNService) – Contains the actual L2VPNService object.
links (list of ResourceLink or None) – The server will populate this field when returing the resource. Ignored on PUT and POST. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
schema (str or None) – Schema for this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
self (SelfResourceLink or None) – Link to this resource
revision (long or None) – The _revision property describes the current revision of the resource. To prevent clients from overwriting each other’s changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected. format: int32
create_time (long or None) – Timestamp of resource creation format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
create_user (str or None) – ID of the user who created this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
last_modified_time (long or None) – Timestamp of last modification format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
last_modified_user (str or None) – ID of the user who last modified this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
protection (str or None) – Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super user and can modify it, but only when providing the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this entity. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
system_owned (bool or None) – Indicates system owned resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
description (str or None) – Description of this resource
display_name (str or None) – Defaults to ID if not set
id (str or None) – Unique identifier of this resource
resource_type (str) –
tags (list of Tag or None) – Opaque identifiers meaningful to the API user
marked_for_delete (bool or None) – If this field is set to true, delete operation is triggered on the intent tree. This resource along with its all children in intent tree will be deleted. This is a cascade delete and should only be used if intent object along with its all children are to be deleted. This does not support deletion of single non-leaf node within the tree and should be used carefully.

property resource_type¶: Return the discriminator value

class com.vmware.nsx_policy.model_client.ChildL2VPNSession(l2_vpn_session=None, links=None, schema=None, self_=None, revision=None, create_time=None, create_user=None, last_modified_time=None, last_modified_user=None, protection=None, system_owned=None, description=None, display_name=None, id=None, resource_type=None, tags=None, marked_for_delete=None)¶

Bases: vmware.vapi.bindings.struct.VapiStruct

Child wrapper object for L2VPNSession, used in hierarchical API.

Tip

The arguments are used to initialize data attributes with the same names.

Parameters

l2_vpn_session (L2VPNSession) – Contains the actual L2VPNSession object.
links (list of ResourceLink or None) – The server will populate this field when returing the resource. Ignored on PUT and POST. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
schema (str or None) – Schema for this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
self (SelfResourceLink or None) – Link to this resource
revision (long or None) – The _revision property describes the current revision of the resource. To prevent clients from overwriting each other’s changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected. format: int32
create_time (long or None) – Timestamp of resource creation format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
create_user (str or None) – ID of the user who created this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
last_modified_time (long or None) – Timestamp of last modification format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
last_modified_user (str or None) – ID of the user who last modified this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
protection (str or None) – Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super user and can modify it, but only when providing the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this entity. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
system_owned (bool or None) – Indicates system owned resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
description (str or None) – Description of this resource
display_name (str or None) – Defaults to ID if not set
id (str or None) – Unique identifier of this resource
resource_type (str) –
tags (list of Tag or None) – Opaque identifiers meaningful to the API user
marked_for_delete (bool or None) – If this field is set to true, delete operation is triggered on the intent tree. This resource along with its all children in intent tree will be deleted. This is a cascade delete and should only be used if intent object along with its all children are to be deleted. This does not support deletion of single non-leaf node within the tree and should be used carefully.

property resource_type¶: Return the discriminator value

class com.vmware.nsx_policy.model_client.ChildL2Vpn(l2_vpn=None, links=None, schema=None, self_=None, revision=None, create_time=None, create_user=None, last_modified_time=None, last_modified_user=None, protection=None, system_owned=None, description=None, display_name=None, id=None, resource_type=None, tags=None, marked_for_delete=None)¶

Bases: vmware.vapi.bindings.struct.VapiStruct

Child wrapper object for L2Vpn, used in hierarchical API.

Tip

The arguments are used to initialize data attributes with the same names.

Parameters

l2_vpn (L2Vpn) – Contains the actual L2Vpn object.
links (list of ResourceLink or None) – The server will populate this field when returing the resource. Ignored on PUT and POST. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
schema (str or None) – Schema for this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
self (SelfResourceLink or None) – Link to this resource
revision (long or None) – The _revision property describes the current revision of the resource. To prevent clients from overwriting each other’s changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected. format: int32
create_time (long or None) – Timestamp of resource creation format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
create_user (str or None) – ID of the user who created this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
last_modified_time (long or None) – Timestamp of last modification format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
last_modified_user (str or None) – ID of the user who last modified this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
protection (str or None) – Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super user and can modify it, but only when providing the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this entity. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
system_owned (bool or None) – Indicates system owned resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
description (str or None) – Description of this resource
display_name (str or None) – Defaults to ID if not set
id (str or None) – Unique identifier of this resource
resource_type (str) –
tags (list of Tag or None) – Opaque identifiers meaningful to the API user
marked_for_delete (bool or None) – If this field is set to true, delete operation is triggered on the intent tree. This resource along with its all children in intent tree will be deleted. This is a cascade delete and should only be used if intent object along with its all children are to be deleted. This does not support deletion of single non-leaf node within the tree and should be used carefully.

property resource_type¶: Return the discriminator value

class com.vmware.nsx_policy.model_client.ChildL2VpnContext(l2_vpn_context=None, links=None, schema=None, self_=None, revision=None, create_time=None, create_user=None, last_modified_time=None, last_modified_user=None, protection=None, system_owned=None, description=None, display_name=None, id=None, resource_type=None, tags=None, marked_for_delete=None)¶

Bases: vmware.vapi.bindings.struct.VapiStruct

Child wrapper object for L2VpnContext, used in hierarchical API.

Tip

The arguments are used to initialize data attributes with the same names.

Parameters

l2_vpn_context (L2VpnContext) – Contains the actual L2VpnContext object.
links (list of ResourceLink or None) – The server will populate this field when returing the resource. Ignored on PUT and POST. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
schema (str or None) – Schema for this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
self (SelfResourceLink or None) – Link to this resource
revision (long or None) – The _revision property describes the current revision of the resource. To prevent clients from overwriting each other’s changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected. format: int32
create_time (long or None) – Timestamp of resource creation format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
create_user (str or None) – ID of the user who created this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
last_modified_time (long or None) – Timestamp of last modification format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
last_modified_user (str or None) – ID of the user who last modified this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
protection (str or None) – Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super user and can modify it, but only when providing the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this entity. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
system_owned (bool or None) – Indicates system owned resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
description (str or None) – Description of this resource
display_name (str or None) – Defaults to ID if not set
id (str or None) – Unique identifier of this resource
resource_type (str) –
tags (list of Tag or None) – Opaque identifiers meaningful to the API user
marked_for_delete (bool or None) – If this field is set to true, delete operation is triggered on the intent tree. This resource along with its all children in intent tree will be deleted. This is a cascade delete and should only be used if intent object along with its all children are to be deleted. This does not support deletion of single non-leaf node within the tree and should be used carefully.

property resource_type¶: Return the discriminator value

class com.vmware.nsx_policy.model_client.ChildL3Vpn(l3_vpn=None, links=None, schema=None, self_=None, revision=None, create_time=None, create_user=None, last_modified_time=None, last_modified_user=None, protection=None, system_owned=None, description=None, display_name=None, id=None, resource_type=None, tags=None, marked_for_delete=None)¶

Bases: vmware.vapi.bindings.struct.VapiStruct

Child wrapper object for L3Vpn, used in hierarchical API.

Tip

The arguments are used to initialize data attributes with the same names.

Parameters

l3_vpn (L3Vpn) – Contains the actual L3Vpn object.
links (list of ResourceLink or None) – The server will populate this field when returing the resource. Ignored on PUT and POST. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
schema (str or None) – Schema for this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
self (SelfResourceLink or None) – Link to this resource
revision (long or None) – The _revision property describes the current revision of the resource. To prevent clients from overwriting each other’s changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected. format: int32
create_time (long or None) – Timestamp of resource creation format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
create_user (str or None) – ID of the user who created this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
last_modified_time (long or None) – Timestamp of last modification format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
last_modified_user (str or None) – ID of the user who last modified this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
protection (str or None) – Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super user and can modify it, but only when providing the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this entity. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
system_owned (bool or None) – Indicates system owned resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
description (str or None) – Description of this resource
display_name (str or None) – Defaults to ID if not set
id (str or None) – Unique identifier of this resource
resource_type (str) –
tags (list of Tag or None) – Opaque identifiers meaningful to the API user
marked_for_delete (bool or None) – If this field is set to true, delete operation is triggered on the intent tree. This resource along with its all children in intent tree will be deleted. This is a cascade delete and should only be used if intent object along with its all children are to be deleted. This does not support deletion of single non-leaf node within the tree and should be used carefully.

property resource_type¶: Return the discriminator value

class com.vmware.nsx_policy.model_client.ChildL3VpnContext(l3_vpn_context=None, links=None, schema=None, self_=None, revision=None, create_time=None, create_user=None, last_modified_time=None, last_modified_user=None, protection=None, system_owned=None, description=None, display_name=None, id=None, resource_type=None, tags=None, marked_for_delete=None)¶

Bases: vmware.vapi.bindings.struct.VapiStruct

Child wrapper object for L3VpnContext, used in hierarchical API.

Tip

The arguments are used to initialize data attributes with the same names.

Parameters

l3_vpn_context (L3VpnContext) – Contains the actual L3VpnContext object.
links (list of ResourceLink or None) – The server will populate this field when returing the resource. Ignored on PUT and POST. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
schema (str or None) – Schema for this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
self (SelfResourceLink or None) – Link to this resource
revision (long or None) – The _revision property describes the current revision of the resource. To prevent clients from overwriting each other’s changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected. format: int32
create_time (long or None) – Timestamp of resource creation format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
create_user (str or None) – ID of the user who created this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
last_modified_time (long or None) – Timestamp of last modification format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
last_modified_user (str or None) – ID of the user who last modified this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
protection (str or None) – Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super user and can modify it, but only when providing the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this entity. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
system_owned (bool or None) – Indicates system owned resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
description (str or None) – Description of this resource
display_name (str or None) – Defaults to ID if not set
id (str or None) – Unique identifier of this resource
resource_type (str) –
tags (list of Tag or None) – Opaque identifiers meaningful to the API user
marked_for_delete (bool or None) – If this field is set to true, delete operation is triggered on the intent tree. This resource along with its all children in intent tree will be deleted. This is a cascade delete and should only be used if intent object along with its all children are to be deleted. This does not support deletion of single non-leaf node within the tree and should be used carefully.

property resource_type¶: Return the discriminator value

class com.vmware.nsx_policy.model_client.ChildLBAppProfile(lb_app_profile=None, links=None, schema=None, self_=None, revision=None, create_time=None, create_user=None, last_modified_time=None, last_modified_user=None, protection=None, system_owned=None, description=None, display_name=None, id=None, resource_type=None, tags=None, marked_for_delete=None)¶

Bases: vmware.vapi.bindings.struct.VapiStruct

Child wrapper for LBAppProfile, used in hierarchical API.

Tip

The arguments are used to initialize data attributes with the same names.

Parameters

lb_app_profile (vmware.vapi.struct.VapiStruct) – Contains the actual LBAppProfile object. When clients pass a value of this class as a parameter, the attribute must contain all the attributes defined in LBAppProfile. When methods return a value of this class as a return value, the attribute will contain all the attributes defined in LBAppProfile.
links (list of ResourceLink or None) – The server will populate this field when returing the resource. Ignored on PUT and POST. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
schema (str or None) – Schema for this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
self (SelfResourceLink or None) – Link to this resource
revision (long or None) – The _revision property describes the current revision of the resource. To prevent clients from overwriting each other’s changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected. format: int32
create_time (long or None) – Timestamp of resource creation format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
create_user (str or None) – ID of the user who created this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
last_modified_time (long or None) – Timestamp of last modification format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
last_modified_user (str or None) – ID of the user who last modified this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
protection (str or None) – Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super user and can modify it, but only when providing the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this entity. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
system_owned (bool or None) – Indicates system owned resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
description (str or None) – Description of this resource
display_name (str or None) – Defaults to ID if not set
id (str or None) – Unique identifier of this resource
resource_type (str) –
tags (list of Tag or None) – Opaque identifiers meaningful to the API user
marked_for_delete (bool or None) – If this field is set to true, delete operation is triggered on the intent tree. This resource along with its all children in intent tree will be deleted. This is a cascade delete and should only be used if intent object along with its all children are to be deleted. This does not support deletion of single non-leaf node within the tree and should be used carefully.

property resource_type¶: Return the discriminator value

class com.vmware.nsx_policy.model_client.ChildLBClientSslProfile(lb_client_ssl_profile=None, links=None, schema=None, self_=None, revision=None, create_time=None, create_user=None, last_modified_time=None, last_modified_user=None, protection=None, system_owned=None, description=None, display_name=None, id=None, resource_type=None, tags=None, marked_for_delete=None)¶

Bases: vmware.vapi.bindings.struct.VapiStruct

Child wrapper for LBClientSslProfile, used in hierarchical API.

Tip

The arguments are used to initialize data attributes with the same names.

Parameters

lb_client_ssl_profile (LBClientSslProfile) – Contains the actual LBClientSslProfile object.
links (list of ResourceLink or None) – The server will populate this field when returing the resource. Ignored on PUT and POST. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
schema (str or None) – Schema for this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
self (SelfResourceLink or None) – Link to this resource
revision (long or None) – The _revision property describes the current revision of the resource. To prevent clients from overwriting each other’s changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected. format: int32
create_time (long or None) – Timestamp of resource creation format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
create_user (str or None) – ID of the user who created this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
last_modified_time (long or None) – Timestamp of last modification format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
last_modified_user (str or None) – ID of the user who last modified this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
protection (str or None) – Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super user and can modify it, but only when providing the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this entity. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
system_owned (bool or None) – Indicates system owned resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
description (str or None) – Description of this resource
display_name (str or None) – Defaults to ID if not set
id (str or None) – Unique identifier of this resource
resource_type (str) –
tags (list of Tag or None) – Opaque identifiers meaningful to the API user
marked_for_delete (bool or None) – If this field is set to true, delete operation is triggered on the intent tree. This resource along with its all children in intent tree will be deleted. This is a cascade delete and should only be used if intent object along with its all children are to be deleted. This does not support deletion of single non-leaf node within the tree and should be used carefully.

property resource_type¶: Return the discriminator value

class com.vmware.nsx_policy.model_client.ChildLBMonitorProfile(lb_monitor_profile=None, links=None, schema=None, self_=None, revision=None, create_time=None, create_user=None, last_modified_time=None, last_modified_user=None, protection=None, system_owned=None, description=None, display_name=None, id=None, resource_type=None, tags=None, marked_for_delete=None)¶

Bases: vmware.vapi.bindings.struct.VapiStruct

Child wrapper for LBMonitorProfile, used in hierarchical API.

Tip

The arguments are used to initialize data attributes with the same names.

Parameters

lb_monitor_profile (vmware.vapi.struct.VapiStruct) – Contains the actual LBMonitorProfile object. When clients pass a value of this class as a parameter, the attribute must contain all the attributes defined in LBMonitorProfile. When methods return a value of this class as a return value, the attribute will contain all the attributes defined in LBMonitorProfile.
links (list of ResourceLink or None) – The server will populate this field when returing the resource. Ignored on PUT and POST. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
schema (str or None) – Schema for this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
self (SelfResourceLink or None) – Link to this resource
revision (long or None) – The _revision property describes the current revision of the resource. To prevent clients from overwriting each other’s changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected. format: int32
create_time (long or None) – Timestamp of resource creation format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
create_user (str or None) – ID of the user who created this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
last_modified_time (long or None) – Timestamp of last modification format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
last_modified_user (str or None) – ID of the user who last modified this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
protection (str or None) – Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super user and can modify it, but only when providing the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this entity. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
system_owned (bool or None) – Indicates system owned resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
description (str or None) – Description of this resource
display_name (str or None) – Defaults to ID if not set
id (str or None) – Unique identifier of this resource
resource_type (str) –
tags (list of Tag or None) – Opaque identifiers meaningful to the API user
marked_for_delete (bool or None) – If this field is set to true, delete operation is triggered on the intent tree. This resource along with its all children in intent tree will be deleted. This is a cascade delete and should only be used if intent object along with its all children are to be deleted. This does not support deletion of single non-leaf node within the tree and should be used carefully.

property resource_type¶: Return the discriminator value

class com.vmware.nsx_policy.model_client.ChildLBPersistenceProfile(lb_persistence_profile=None, links=None, schema=None, self_=None, revision=None, create_time=None, create_user=None, last_modified_time=None, last_modified_user=None, protection=None, system_owned=None, description=None, display_name=None, id=None, resource_type=None, tags=None, marked_for_delete=None)¶

Bases: vmware.vapi.bindings.struct.VapiStruct

Child wrapper for LBPersistenceProfile, used in hierarchical API.

Tip

The arguments are used to initialize data attributes with the same names.

Parameters

lb_persistence_profile (vmware.vapi.struct.VapiStruct) – Contains the actual LBPersistenceProfile object. When clients pass a value of this class as a parameter, the attribute must contain all the attributes defined in LBPersistenceProfile. When methods return a value of this class as a return value, the attribute will contain all the attributes defined in LBPersistenceProfile.
links (list of ResourceLink or None) – The server will populate this field when returing the resource. Ignored on PUT and POST. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
schema (str or None) – Schema for this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
self (SelfResourceLink or None) – Link to this resource
revision (long or None) – The _revision property describes the current revision of the resource. To prevent clients from overwriting each other’s changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected. format: int32
create_time (long or None) – Timestamp of resource creation format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
create_user (str or None) – ID of the user who created this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
last_modified_time (long or None) – Timestamp of last modification format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
last_modified_user (str or None) – ID of the user who last modified this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
protection (str or None) – Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super user and can modify it, but only when providing the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this entity. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
system_owned (bool or None) – Indicates system owned resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
description (str or None) – Description of this resource
display_name (str or None) – Defaults to ID if not set
id (str or None) – Unique identifier of this resource
resource_type (str) –
tags (list of Tag or None) – Opaque identifiers meaningful to the API user
marked_for_delete (bool or None) – If this field is set to true, delete operation is triggered on the intent tree. This resource along with its all children in intent tree will be deleted. This is a cascade delete and should only be used if intent object along with its all children are to be deleted. This does not support deletion of single non-leaf node within the tree and should be used carefully.

property resource_type¶: Return the discriminator value

class com.vmware.nsx_policy.model_client.ChildLBPool(lb_pool=None, links=None, schema=None, self_=None, revision=None, create_time=None, create_user=None, last_modified_time=None, last_modified_user=None, protection=None, system_owned=None, description=None, display_name=None, id=None, resource_type=None, tags=None, marked_for_delete=None)¶

Bases: vmware.vapi.bindings.struct.VapiStruct

Child wrapper for LBPool, used in hierarchical API.

Tip

The arguments are used to initialize data attributes with the same names.

Parameters

lb_pool (LBPool) – Contains the actual LBPool object.
links (list of ResourceLink or None) – The server will populate this field when returing the resource. Ignored on PUT and POST. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
schema (str or None) – Schema for this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
self (SelfResourceLink or None) – Link to this resource
revision (long or None) – The _revision property describes the current revision of the resource. To prevent clients from overwriting each other’s changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected. format: int32
create_time (long or None) – Timestamp of resource creation format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
create_user (str or None) – ID of the user who created this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
last_modified_time (long or None) – Timestamp of last modification format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
last_modified_user (str or None) – ID of the user who last modified this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
protection (str or None) – Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super user and can modify it, but only when providing the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this entity. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
system_owned (bool or None) – Indicates system owned resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
description (str or None) – Description of this resource
display_name (str or None) – Defaults to ID if not set
id (str or None) – Unique identifier of this resource
resource_type (str) –
tags (list of Tag or None) – Opaque identifiers meaningful to the API user
marked_for_delete (bool or None) – If this field is set to true, delete operation is triggered on the intent tree. This resource along with its all children in intent tree will be deleted. This is a cascade delete and should only be used if intent object along with its all children are to be deleted. This does not support deletion of single non-leaf node within the tree and should be used carefully.

property resource_type¶: Return the discriminator value

class com.vmware.nsx_policy.model_client.ChildLBServerSslProfile(lb_server_ssl_profile=None, links=None, schema=None, self_=None, revision=None, create_time=None, create_user=None, last_modified_time=None, last_modified_user=None, protection=None, system_owned=None, description=None, display_name=None, id=None, resource_type=None, tags=None, marked_for_delete=None)¶

Bases: vmware.vapi.bindings.struct.VapiStruct

Child wrapper for LBServerSslProfile, used in hierarchical API.

Tip

The arguments are used to initialize data attributes with the same names.

Parameters

lb_server_ssl_profile (LBServerSslProfile) – Contains the actual LBServerSslProfile object.
links (list of ResourceLink or None) – The server will populate this field when returing the resource. Ignored on PUT and POST. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
schema (str or None) – Schema for this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
self (SelfResourceLink or None) – Link to this resource
revision (long or None) – The _revision property describes the current revision of the resource. To prevent clients from overwriting each other’s changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected. format: int32
create_time (long or None) – Timestamp of resource creation format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
create_user (str or None) – ID of the user who created this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
last_modified_time (long or None) – Timestamp of last modification format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
last_modified_user (str or None) – ID of the user who last modified this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
protection (str or None) – Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super user and can modify it, but only when providing the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this entity. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
system_owned (bool or None) – Indicates system owned resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
description (str or None) – Description of this resource
display_name (str or None) – Defaults to ID if not set
id (str or None) – Unique identifier of this resource
resource_type (str) –
tags (list of Tag or None) – Opaque identifiers meaningful to the API user
marked_for_delete (bool or None) – If this field is set to true, delete operation is triggered on the intent tree. This resource along with its all children in intent tree will be deleted. This is a cascade delete and should only be used if intent object along with its all children are to be deleted. This does not support deletion of single non-leaf node within the tree and should be used carefully.

property resource_type¶: Return the discriminator value

class com.vmware.nsx_policy.model_client.ChildLBService(lb_service=None, links=None, schema=None, self_=None, revision=None, create_time=None, create_user=None, last_modified_time=None, last_modified_user=None, protection=None, system_owned=None, description=None, display_name=None, id=None, resource_type=None, tags=None, marked_for_delete=None)¶

Bases: vmware.vapi.bindings.struct.VapiStruct

Child wrapper for LBService, used in hierarchical API.

Tip

The arguments are used to initialize data attributes with the same names.

Parameters

lb_service (LBService) – Contains the actual LBService object.
links (list of ResourceLink or None) – The server will populate this field when returing the resource. Ignored on PUT and POST. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
schema (str or None) – Schema for this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
self (SelfResourceLink or None) – Link to this resource
revision (long or None) – The _revision property describes the current revision of the resource. To prevent clients from overwriting each other’s changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected. format: int32
create_time (long or None) – Timestamp of resource creation format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
create_user (str or None) – ID of the user who created this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
last_modified_time (long or None) – Timestamp of last modification format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
last_modified_user (str or None) – ID of the user who last modified this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
protection (str or None) – Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super user and can modify it, but only when providing the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this entity. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
system_owned (bool or None) – Indicates system owned resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
description (str or None) – Description of this resource
display_name (str or None) – Defaults to ID if not set
id (str or None) – Unique identifier of this resource
resource_type (str) –
tags (list of Tag or None) – Opaque identifiers meaningful to the API user
marked_for_delete (bool or None) – If this field is set to true, delete operation is triggered on the intent tree. This resource along with its all children in intent tree will be deleted. This is a cascade delete and should only be used if intent object along with its all children are to be deleted. This does not support deletion of single non-leaf node within the tree and should be used carefully.

property resource_type¶: Return the discriminator value

class com.vmware.nsx_policy.model_client.ChildLBVirtualServer(lb_virtual_server=None, links=None, schema=None, self_=None, revision=None, create_time=None, create_user=None, last_modified_time=None, last_modified_user=None, protection=None, system_owned=None, description=None, display_name=None, id=None, resource_type=None, tags=None, marked_for_delete=None)¶

Bases: vmware.vapi.bindings.struct.VapiStruct

Child wrapper for LBVirtualServer, used in hierarchical API.

Tip

The arguments are used to initialize data attributes with the same names.

Parameters

lb_virtual_server (LBVirtualServer) – Contains the actual LBVirtualServer object.
links (list of ResourceLink or None) – The server will populate this field when returing the resource. Ignored on PUT and POST. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
schema (str or None) – Schema for this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
self (SelfResourceLink or None) – Link to this resource
revision (long or None) – The _revision property describes the current revision of the resource. To prevent clients from overwriting each other’s changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected. format: int32
create_time (long or None) – Timestamp of resource creation format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
create_user (str or None) – ID of the user who created this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
last_modified_time (long or None) – Timestamp of last modification format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
last_modified_user (str or None) – ID of the user who last modified this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
protection (str or None) – Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super user and can modify it, but only when providing the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this entity. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
system_owned (bool or None) – Indicates system owned resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
description (str or None) – Description of this resource
display_name (str or None) – Defaults to ID if not set
id (str or None) – Unique identifier of this resource
resource_type (str) –
tags (list of Tag or None) – Opaque identifiers meaningful to the API user
marked_for_delete (bool or None) – If this field is set to true, delete operation is triggered on the intent tree. This resource along with its all children in intent tree will be deleted. This is a cascade delete and should only be used if intent object along with its all children are to be deleted. This does not support deletion of single non-leaf node within the tree and should be used carefully.

property resource_type¶: Return the discriminator value

class com.vmware.nsx_policy.model_client.ChildLocaleServices(locale_services=None, links=None, schema=None, self_=None, revision=None, create_time=None, create_user=None, last_modified_time=None, last_modified_user=None, protection=None, system_owned=None, description=None, display_name=None, id=None, resource_type=None, tags=None, marked_for_delete=None)¶

Bases: vmware.vapi.bindings.struct.VapiStruct

Child wrapper object for LocaleServices, used in hierarchical API

Tip

The arguments are used to initialize data attributes with the same names.

Parameters

locale_services (LocaleServices) – Contains the actual LocaleServices object
links (list of ResourceLink or None) – The server will populate this field when returing the resource. Ignored on PUT and POST. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
schema (str or None) – Schema for this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
self (SelfResourceLink or None) – Link to this resource
revision (long or None) – The _revision property describes the current revision of the resource. To prevent clients from overwriting each other’s changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected. format: int32
create_time (long or None) – Timestamp of resource creation format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
create_user (str or None) – ID of the user who created this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
last_modified_time (long or None) – Timestamp of last modification format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
last_modified_user (str or None) – ID of the user who last modified this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
protection (str or None) – Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super user and can modify it, but only when providing the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this entity. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
system_owned (bool or None) – Indicates system owned resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
description (str or None) – Description of this resource
display_name (str or None) – Defaults to ID if not set
id (str or None) – Unique identifier of this resource
resource_type (str) –
tags (list of Tag or None) – Opaque identifiers meaningful to the API user
marked_for_delete (bool or None) – If this field is set to true, delete operation is triggered on the intent tree. This resource along with its all children in intent tree will be deleted. This is a cascade delete and should only be used if intent object along with its all children are to be deleted. This does not support deletion of single non-leaf node within the tree and should be used carefully.

property resource_type¶: Return the discriminator value

class com.vmware.nsx_policy.model_client.ChildMacDiscoveryProfile(mac_discovery_profile=None, links=None, schema=None, self_=None, revision=None, create_time=None, create_user=None, last_modified_time=None, last_modified_user=None, protection=None, system_owned=None, description=None, display_name=None, id=None, resource_type=None, tags=None, marked_for_delete=None)¶

Bases: vmware.vapi.bindings.struct.VapiStruct

Child wrapper object for MacDiscoveryProfile, used in hierarchical API

Tip

The arguments are used to initialize data attributes with the same names.

Parameters

mac_discovery_profile (MacDiscoveryProfile) – Contains the actual MacDiscoveryProfile object
links (list of ResourceLink or None) – The server will populate this field when returing the resource. Ignored on PUT and POST. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
schema (str or None) – Schema for this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
self (SelfResourceLink or None) – Link to this resource
revision (long or None) – The _revision property describes the current revision of the resource. To prevent clients from overwriting each other’s changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected. format: int32
create_time (long or None) – Timestamp of resource creation format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
create_user (str or None) – ID of the user who created this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
last_modified_time (long or None) – Timestamp of last modification format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
last_modified_user (str or None) – ID of the user who last modified this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
protection (str or None) – Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super user and can modify it, but only when providing the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this entity. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
system_owned (bool or None) – Indicates system owned resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
description (str or None) – Description of this resource
display_name (str or None) – Defaults to ID if not set
id (str or None) – Unique identifier of this resource
resource_type (str) –
tags (list of Tag or None) – Opaque identifiers meaningful to the API user
marked_for_delete (bool or None) – If this field is set to true, delete operation is triggered on the intent tree. This resource along with its all children in intent tree will be deleted. This is a cascade delete and should only be used if intent object along with its all children are to be deleted. This does not support deletion of single non-leaf node within the tree and should be used carefully.

property resource_type¶: Return the discriminator value

class com.vmware.nsx_policy.model_client.ChildPolicyConfigResource(links=None, schema=None, self_=None, revision=None, create_time=None, create_user=None, last_modified_time=None, last_modified_user=None, protection=None, system_owned=None, description=None, display_name=None, id=None, resource_type='ChildPolicyConfigResource', tags=None, marked_for_delete=None)¶

Bases: vmware.vapi.bindings.struct.VapiStruct

Represents an object on the desired state

Tip

The arguments are used to initialize data attributes with the same names.

Parameters

links (list of ResourceLink or None) – The server will populate this field when returing the resource. Ignored on PUT and POST. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
schema (str or None) – Schema for this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
self (SelfResourceLink or None) – Link to this resource
revision (long or None) – The _revision property describes the current revision of the resource. To prevent clients from overwriting each other’s changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected. format: int32
create_time (long or None) – Timestamp of resource creation format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
create_user (str or None) – ID of the user who created this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
last_modified_time (long or None) – Timestamp of last modification format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
last_modified_user (str or None) – ID of the user who last modified this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
protection (str or None) – Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super user and can modify it, but only when providing the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this entity. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
system_owned (bool or None) – Indicates system owned resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
description (str or None) – Description of this resource
display_name (str or None) – Defaults to ID if not set
id (str or None) – Unique identifier of this resource
resource_type (str) –
tags (list of Tag or None) – Opaque identifiers meaningful to the API user
marked_for_delete (bool or None) – If this field is set to true, delete operation is triggered on the intent tree. This resource along with its all children in intent tree will be deleted. This is a cascade delete and should only be used if intent object along with its all children are to be deleted. This does not support deletion of single non-leaf node within the tree and should be used carefully.

property resource_type¶: Return the discriminator value

class com.vmware.nsx_policy.model_client.ChildPolicyContextProfile(policy_context_profile=None, links=None, schema=None, self_=None, revision=None, create_time=None, create_user=None, last_modified_time=None, last_modified_user=None, protection=None, system_owned=None, description=None, display_name=None, id=None, resource_type='ChildPolicyContextProfile', tags=None, marked_for_delete=None)¶

Bases: vmware.vapi.bindings.struct.VapiStruct

Child wrapper object for PolicyContextProfile, used in hierarchical API

Tip

The arguments are used to initialize data attributes with the same names.

Parameters

policy_context_profile (PolicyContextProfile) – Contains the actual PolicyContextProfile objects
links (list of ResourceLink or None) – The server will populate this field when returing the resource. Ignored on PUT and POST. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
schema (str or None) – Schema for this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
self (SelfResourceLink or None) – Link to this resource
revision (long or None) – The _revision property describes the current revision of the resource. To prevent clients from overwriting each other’s changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected. format: int32
create_time (long or None) – Timestamp of resource creation format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
create_user (str or None) – ID of the user who created this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
last_modified_time (long or None) – Timestamp of last modification format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
last_modified_user (str or None) – ID of the user who last modified this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
protection (str or None) – Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super user and can modify it, but only when providing the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this entity. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
system_owned (bool or None) – Indicates system owned resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
description (str or None) – Description of this resource
display_name (str or None) – Defaults to ID if not set
id (str or None) – Unique identifier of this resource
resource_type (str) –
tags (list of Tag or None) – Opaque identifiers meaningful to the API user
marked_for_delete (bool or None) – If this field is set to true, delete operation is triggered on the intent tree. This resource along with its all children in intent tree will be deleted. This is a cascade delete and should only be used if intent object along with its all children are to be deleted. This does not support deletion of single non-leaf node within the tree and should be used carefully.

property resource_type¶: Return the discriminator value

class com.vmware.nsx_policy.model_client.ChildPolicyDnsForwarder(policy_dns_forwarder=None, links=None, schema=None, self_=None, revision=None, create_time=None, create_user=None, last_modified_time=None, last_modified_user=None, protection=None, system_owned=None, description=None, display_name=None, id=None, resource_type='ChildPolicyDnsForwarder', tags=None, marked_for_delete=None)¶

Bases: vmware.vapi.bindings.struct.VapiStruct

Child wrapper object for PolicyDnsForwarder, used in hierarchical API

Tip

The arguments are used to initialize data attributes with the same names.

Parameters

policy_dns_forwarder (PolicyDnsForwarder) – Contains the actual PolicyDnsForwarder object
links (list of ResourceLink or None) – The server will populate this field when returing the resource. Ignored on PUT and POST. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
schema (str or None) – Schema for this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
self (SelfResourceLink or None) – Link to this resource
revision (long or None) – The _revision property describes the current revision of the resource. To prevent clients from overwriting each other’s changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected. format: int32
create_time (long or None) – Timestamp of resource creation format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
create_user (str or None) – ID of the user who created this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
last_modified_time (long or None) – Timestamp of last modification format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
last_modified_user (str or None) – ID of the user who last modified this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
protection (str or None) – Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super user and can modify it, but only when providing the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this entity. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
system_owned (bool or None) – Indicates system owned resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
description (str or None) – Description of this resource
display_name (str or None) – Defaults to ID if not set
id (str or None) – Unique identifier of this resource
resource_type (str) –
tags (list of Tag or None) – Opaque identifiers meaningful to the API user
marked_for_delete (bool or None) – If this field is set to true, delete operation is triggered on the intent tree. This resource along with its all children in intent tree will be deleted. This is a cascade delete and should only be used if intent object along with its all children are to be deleted. This does not support deletion of single non-leaf node within the tree and should be used carefully.

property resource_type¶: Return the discriminator value

class com.vmware.nsx_policy.model_client.ChildPolicyDnsForwarderZone(policy_dns_forwarder_zone=None, links=None, schema=None, self_=None, revision=None, create_time=None, create_user=None, last_modified_time=None, last_modified_user=None, protection=None, system_owned=None, description=None, display_name=None, id=None, resource_type='ChildPolicyDnsForwarderZone', tags=None, marked_for_delete=None)¶

Bases: vmware.vapi.bindings.struct.VapiStruct

Child wrapper object for PolicyDnsForwarderZone, used in hierarchical API

Tip

The arguments are used to initialize data attributes with the same names.

Parameters

policy_dns_forwarder_zone (PolicyDnsForwarderZone) – Contains the actual PolicyDnsForwarderZone object
links (list of ResourceLink or None) – The server will populate this field when returing the resource. Ignored on PUT and POST. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
schema (str or None) – Schema for this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
self (SelfResourceLink or None) – Link to this resource
revision (long or None) – The _revision property describes the current revision of the resource. To prevent clients from overwriting each other’s changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected. format: int32
create_time (long or None) – Timestamp of resource creation format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
create_user (str or None) – ID of the user who created this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
last_modified_time (long or None) – Timestamp of last modification format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
last_modified_user (str or None) – ID of the user who last modified this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
protection (str or None) – Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super user and can modify it, but only when providing the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this entity. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
system_owned (bool or None) – Indicates system owned resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
description (str or None) – Description of this resource
display_name (str or None) – Defaults to ID if not set
id (str or None) – Unique identifier of this resource
resource_type (str) –
tags (list of Tag or None) – Opaque identifiers meaningful to the API user
marked_for_delete (bool or None) – If this field is set to true, delete operation is triggered on the intent tree. This resource along with its all children in intent tree will be deleted. This is a cascade delete and should only be used if intent object along with its all children are to be deleted. This does not support deletion of single non-leaf node within the tree and should be used carefully.

property resource_type¶: Return the discriminator value

class com.vmware.nsx_policy.model_client.ChildPolicyEdgeCluster(policy_edge_cluster=None, links=None, schema=None, self_=None, revision=None, create_time=None, create_user=None, last_modified_time=None, last_modified_user=None, protection=None, system_owned=None, description=None, display_name=None, id=None, resource_type='ChildPolicyEdgeCluster', tags=None, marked_for_delete=None)¶

Bases: vmware.vapi.bindings.struct.VapiStruct

Child wrapper object for PolicyEdgeCluster, used in hierarchical API

Tip

The arguments are used to initialize data attributes with the same names.

Parameters

policy_edge_cluster (PolicyEdgeCluster) – Contains the actual PolicyEdgeCluster object
links (list of ResourceLink or None) – The server will populate this field when returing the resource. Ignored on PUT and POST. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
schema (str or None) – Schema for this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
self (SelfResourceLink or None) – Link to this resource
revision (long or None) – The _revision property describes the current revision of the resource. To prevent clients from overwriting each other’s changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected. format: int32
create_time (long or None) – Timestamp of resource creation format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
create_user (str or None) – ID of the user who created this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
last_modified_time (long or None) – Timestamp of last modification format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
last_modified_user (str or None) – ID of the user who last modified this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
protection (str or None) – Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super user and can modify it, but only when providing the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this entity. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
system_owned (bool or None) – Indicates system owned resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
description (str or None) – Description of this resource
display_name (str or None) – Defaults to ID if not set
id (str or None) – Unique identifier of this resource
resource_type (str) –
tags (list of Tag or None) – Opaque identifiers meaningful to the API user
marked_for_delete (bool or None) – If this field is set to true, delete operation is triggered on the intent tree. This resource along with its all children in intent tree will be deleted. This is a cascade delete and should only be used if intent object along with its all children are to be deleted. This does not support deletion of single non-leaf node within the tree and should be used carefully.

property resource_type¶: Return the discriminator value

class com.vmware.nsx_policy.model_client.ChildPolicyEdgeNode(policy_edge_node=None, links=None, schema=None, self_=None, revision=None, create_time=None, create_user=None, last_modified_time=None, last_modified_user=None, protection=None, system_owned=None, description=None, display_name=None, id=None, resource_type='ChildPolicyEdgeNode', tags=None, marked_for_delete=None)¶

Bases: vmware.vapi.bindings.struct.VapiStruct

Child wrapper object for PolicyEdgeNode, used in hierarchical API

Tip

The arguments are used to initialize data attributes with the same names.

Parameters

policy_edge_node (PolicyEdgeNode) – Contains the actual PolicyEdgeNode object
links (list of ResourceLink or None) – The server will populate this field when returing the resource. Ignored on PUT and POST. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
schema (str or None) – Schema for this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
self (SelfResourceLink or None) – Link to this resource
revision (long or None) – The _revision property describes the current revision of the resource. To prevent clients from overwriting each other’s changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected. format: int32
create_time (long or None) – Timestamp of resource creation format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
create_user (str or None) – ID of the user who created this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
last_modified_time (long or None) – Timestamp of last modification format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
last_modified_user (str or None) – ID of the user who last modified this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
protection (str or None) – Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super user and can modify it, but only when providing the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this entity. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
system_owned (bool or None) – Indicates system owned resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
description (str or None) – Description of this resource
display_name (str or None) – Defaults to ID if not set
id (str or None) – Unique identifier of this resource
resource_type (str) –
tags (list of Tag or None) – Opaque identifiers meaningful to the API user
marked_for_delete (bool or None) – If this field is set to true, delete operation is triggered on the intent tree. This resource along with its all children in intent tree will be deleted. This is a cascade delete and should only be used if intent object along with its all children are to be deleted. This does not support deletion of single non-leaf node within the tree and should be used carefully.

property resource_type¶: Return the discriminator value

class com.vmware.nsx_policy.model_client.ChildPolicyExcludeList(policy_exclude_list=None, links=None, schema=None, self_=None, revision=None, create_time=None, create_user=None, last_modified_time=None, last_modified_user=None, protection=None, system_owned=None, description=None, display_name=None, id=None, resource_type='ChildPolicyExcludeList', tags=None, marked_for_delete=None)¶

Bases: vmware.vapi.bindings.struct.VapiStruct

Wrapper object for PolicyExcludeList

Tip

The arguments are used to initialize data attributes with the same names.

Parameters

policy_exclude_list (PolicyExcludeList) – Contains the actual policy exclude list object.
links (list of ResourceLink or None) – The server will populate this field when returing the resource. Ignored on PUT and POST. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
schema (str or None) – Schema for this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
self (SelfResourceLink or None) – Link to this resource
revision (long or None) – The _revision property describes the current revision of the resource. To prevent clients from overwriting each other’s changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected. format: int32
create_time (long or None) – Timestamp of resource creation format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
create_user (str or None) – ID of the user who created this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
last_modified_time (long or None) – Timestamp of last modification format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
last_modified_user (str or None) – ID of the user who last modified this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
protection (str or None) – Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super user and can modify it, but only when providing the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this entity. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
system_owned (bool or None) – Indicates system owned resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
description (str or None) – Description of this resource
display_name (str or None) – Defaults to ID if not set
id (str or None) – Unique identifier of this resource
resource_type (str) –
tags (list of Tag or None) – Opaque identifiers meaningful to the API user
marked_for_delete (bool or None) – If this field is set to true, delete operation is triggered on the intent tree. This resource along with its all children in intent tree will be deleted. This is a cascade delete and should only be used if intent object along with its all children are to be deleted. This does not support deletion of single non-leaf node within the tree and should be used carefully.

property resource_type¶: Return the discriminator value

class com.vmware.nsx_policy.model_client.ChildPolicyFirewallFloodProtectionProfileBindingMap(policy_firewall_flood_protection_profile_binding_map=None, links=None, schema=None, self_=None, revision=None, create_time=None, create_user=None, last_modified_time=None, last_modified_user=None, protection=None, system_owned=None, description=None, display_name=None, id=None, resource_type='ChildPolicyFirewallFloodProtectionProfileBindingMap', tags=None, marked_for_delete=None)¶

Bases: vmware.vapi.bindings.struct.VapiStruct

Child wrapper object for PolicyFirewallFloodProtectionProfileBindingMap, used in hierarchical API

Tip

The arguments are used to initialize data attributes with the same names.

Parameters

policy_firewall_flood_protection_profile_binding_map (PolicyFirewallFloodProtectionProfileBindingMap) – Contains the actual PolicyFirewallFloodProtectionProfileBindingMap object
links (list of ResourceLink or None) – The server will populate this field when returing the resource. Ignored on PUT and POST. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
schema (str or None) – Schema for this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
self (SelfResourceLink or None) – Link to this resource
revision (long or None) – The _revision property describes the current revision of the resource. To prevent clients from overwriting each other’s changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected. format: int32
create_time (long or None) – Timestamp of resource creation format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
create_user (str or None) – ID of the user who created this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
last_modified_time (long or None) – Timestamp of last modification format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
last_modified_user (str or None) – ID of the user who last modified this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
protection (str or None) – Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super user and can modify it, but only when providing the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this entity. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
system_owned (bool or None) – Indicates system owned resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
description (str or None) – Description of this resource
display_name (str or None) – Defaults to ID if not set
id (str or None) – Unique identifier of this resource
resource_type (str) –
tags (list of Tag or None) – Opaque identifiers meaningful to the API user
marked_for_delete (bool or None) – If this field is set to true, delete operation is triggered on the intent tree. This resource along with its all children in intent tree will be deleted. This is a cascade delete and should only be used if intent object along with its all children are to be deleted. This does not support deletion of single non-leaf node within the tree and should be used carefully.

property resource_type¶: Return the discriminator value

class com.vmware.nsx_policy.model_client.ChildPolicyFirewallSessionTimerProfile(policy_firewall_session_timer_profile=None, links=None, schema=None, self_=None, revision=None, create_time=None, create_user=None, last_modified_time=None, last_modified_user=None, protection=None, system_owned=None, description=None, display_name=None, id=None, resource_type='ChildPolicyFirewallSessionTimerProfile', tags=None, marked_for_delete=None)¶

Bases: vmware.vapi.bindings.struct.VapiStruct

Child wrapper object for PolicyFirewallSessionTimerProfile, used in hierarchical API

Tip

The arguments are used to initialize data attributes with the same names.

Parameters

policy_firewall_session_timer_profile (PolicyFirewallSessionTimerProfile) – Contains the actual PolicyFirewallSessionTimerProfile object
links (list of ResourceLink or None) – The server will populate this field when returing the resource. Ignored on PUT and POST. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
schema (str or None) – Schema for this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
self (SelfResourceLink or None) – Link to this resource
revision (long or None) – The _revision property describes the current revision of the resource. To prevent clients from overwriting each other’s changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected. format: int32
create_time (long or None) – Timestamp of resource creation format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
create_user (str or None) – ID of the user who created this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
last_modified_time (long or None) – Timestamp of last modification format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
last_modified_user (str or None) – ID of the user who last modified this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
protection (str or None) – Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super user and can modify it, but only when providing the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this entity. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
system_owned (bool or None) – Indicates system owned resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
description (str or None) – Description of this resource
display_name (str or None) – Defaults to ID if not set
id (str or None) – Unique identifier of this resource
resource_type (str) –
tags (list of Tag or None) – Opaque identifiers meaningful to the API user
marked_for_delete (bool or None) – If this field is set to true, delete operation is triggered on the intent tree. This resource along with its all children in intent tree will be deleted. This is a cascade delete and should only be used if intent object along with its all children are to be deleted. This does not support deletion of single non-leaf node within the tree and should be used carefully.

property resource_type¶: Return the discriminator value

class com.vmware.nsx_policy.model_client.ChildPolicyFirewallSessionTimerProfileBindingMap(policy_firewall_session_timer_profile_binding_map=None, links=None, schema=None, self_=None, revision=None, create_time=None, create_user=None, last_modified_time=None, last_modified_user=None, protection=None, system_owned=None, description=None, display_name=None, id=None, resource_type='ChildPolicyFirewallSessionTimerProfileBindingMap', tags=None, marked_for_delete=None)¶

Bases: vmware.vapi.bindings.struct.VapiStruct

Child wrapper object for PolicyFirewallSessionTimerProfileBindingMap, used in hierarchical API

Tip

The arguments are used to initialize data attributes with the same names.

Parameters

policy_firewall_session_timer_profile_binding_map (PolicyFirewallSessionTimerProfileBindingMap) – Contains the actual PolicyFirewallSessionTimerProfileBindingMap object
links (list of ResourceLink or None) – The server will populate this field when returing the resource. Ignored on PUT and POST. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
schema (str or None) – Schema for this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
self (SelfResourceLink or None) – Link to this resource
revision (long or None) – The _revision property describes the current revision of the resource. To prevent clients from overwriting each other’s changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected. format: int32
create_time (long or None) – Timestamp of resource creation format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
create_user (str or None) – ID of the user who created this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
last_modified_time (long or None) – Timestamp of last modification format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
last_modified_user (str or None) – ID of the user who last modified this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
protection (str or None) – Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super user and can modify it, but only when providing the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this entity. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
system_owned (bool or None) – Indicates system owned resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
description (str or None) – Description of this resource
display_name (str or None) – Defaults to ID if not set
id (str or None) – Unique identifier of this resource
resource_type (str) –
tags (list of Tag or None) – Opaque identifiers meaningful to the API user
marked_for_delete (bool or None) – If this field is set to true, delete operation is triggered on the intent tree. This resource along with its all children in intent tree will be deleted. This is a cascade delete and should only be used if intent object along with its all children are to be deleted. This does not support deletion of single non-leaf node within the tree and should be used carefully.

property resource_type¶: Return the discriminator value

class com.vmware.nsx_policy.model_client.ChildPolicyLabel(policy_label=None, links=None, schema=None, self_=None, revision=None, create_time=None, create_user=None, last_modified_time=None, last_modified_user=None, protection=None, system_owned=None, description=None, display_name=None, id=None, resource_type='ChildPolicyLabel', tags=None, marked_for_delete=None)¶

Bases: vmware.vapi.bindings.struct.VapiStruct

Child wrapper object for PolicyLabel, used in hierarchical API

Tip

The arguments are used to initialize data attributes with the same names.

Parameters

policy_label (PolicyLabel) – Contains the actual PolicyLabel object
links (list of ResourceLink or None) – The server will populate this field when returing the resource. Ignored on PUT and POST. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
schema (str or None) – Schema for this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
self (SelfResourceLink or None) – Link to this resource
revision (long or None) – The _revision property describes the current revision of the resource. To prevent clients from overwriting each other’s changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected. format: int32
create_time (long or None) – Timestamp of resource creation format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
create_user (str or None) – ID of the user who created this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
last_modified_time (long or None) – Timestamp of last modification format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
last_modified_user (str or None) – ID of the user who last modified this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
protection (str or None) – Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super user and can modify it, but only when providing the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this entity. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
system_owned (bool or None) – Indicates system owned resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
description (str or None) – Description of this resource
display_name (str or None) – Defaults to ID if not set
id (str or None) – Unique identifier of this resource
resource_type (str) –
tags (list of Tag or None) – Opaque identifiers meaningful to the API user
marked_for_delete (bool or None) – If this field is set to true, delete operation is triggered on the intent tree. This resource along with its all children in intent tree will be deleted. This is a cascade delete and should only be used if intent object along with its all children are to be deleted. This does not support deletion of single non-leaf node within the tree and should be used carefully.

property resource_type¶: Return the discriminator value

class com.vmware.nsx_policy.model_client.ChildPolicyLbMonitorProfile(policy_lb_monitor_profile=None, links=None, schema=None, self_=None, revision=None, create_time=None, create_user=None, last_modified_time=None, last_modified_user=None, protection=None, system_owned=None, description=None, display_name=None, id=None, resource_type='ChildPolicyLbMonitorProfile', tags=None, marked_for_delete=None)¶

Bases: vmware.vapi.bindings.struct.VapiStruct

Child wrapper for PolicyLbMonitorProfile, used in hierarchical API

Tip

The arguments are used to initialize data attributes with the same names.

Parameters

policy_lb_monitor_profile (vmware.vapi.struct.VapiStruct) – Contains the actual PolicyLbMonitorProfile object When clients pass a value of this class as a parameter, the attribute must contain all the attributes defined in PolicyLbMonitorProfile. When methods return a value of this class as a return value, the attribute will contain all the attributes defined in PolicyLbMonitorProfile.
links (list of ResourceLink or None) – The server will populate this field when returing the resource. Ignored on PUT and POST. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
schema (str or None) – Schema for this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
self (SelfResourceLink or None) – Link to this resource
revision (long or None) – The _revision property describes the current revision of the resource. To prevent clients from overwriting each other’s changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected. format: int32
create_time (long or None) – Timestamp of resource creation format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
create_user (str or None) – ID of the user who created this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
last_modified_time (long or None) – Timestamp of last modification format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
last_modified_user (str or None) – ID of the user who last modified this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
protection (str or None) – Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super user and can modify it, but only when providing the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this entity. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
system_owned (bool or None) – Indicates system owned resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
description (str or None) – Description of this resource
display_name (str or None) – Defaults to ID if not set
id (str or None) – Unique identifier of this resource
resource_type (str) –
tags (list of Tag or None) – Opaque identifiers meaningful to the API user
marked_for_delete (bool or None) – If this field is set to true, delete operation is triggered on the intent tree. This resource along with its all children in intent tree will be deleted. This is a cascade delete and should only be used if intent object along with its all children are to be deleted. This does not support deletion of single non-leaf node within the tree and should be used carefully.

property resource_type¶: Return the discriminator value

class com.vmware.nsx_policy.model_client.ChildPolicyLbPersistenceProfile(policy_lb_persistence_profile=None, links=None, schema=None, self_=None, revision=None, create_time=None, create_user=None, last_modified_time=None, last_modified_user=None, protection=None, system_owned=None, description=None, display_name=None, id=None, resource_type='ChildPolicyLbPersistenceProfile', tags=None, marked_for_delete=None)¶

Bases: vmware.vapi.bindings.struct.VapiStruct

Child wrapper for PolicyLbPersistenceProfile, used in hierarchical API

Tip

The arguments are used to initialize data attributes with the same names.

Parameters

policy_lb_persistence_profile (vmware.vapi.struct.VapiStruct) – Contains the actual PolicyLbPersistenceProfile object When clients pass a value of this class as a parameter, the attribute must contain all the attributes defined in PolicyLbPersistenceProfile. When methods return a value of this class as a return value, the attribute will contain all the attributes defined in PolicyLbPersistenceProfile.
links (list of ResourceLink or None) – The server will populate this field when returing the resource. Ignored on PUT and POST. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
schema (str or None) – Schema for this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
self (SelfResourceLink or None) – Link to this resource
revision (long or None) – The _revision property describes the current revision of the resource. To prevent clients from overwriting each other’s changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected. format: int32
create_time (long or None) – Timestamp of resource creation format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
create_user (str or None) – ID of the user who created this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
last_modified_time (long or None) – Timestamp of last modification format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
last_modified_user (str or None) – ID of the user who last modified this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
protection (str or None) – Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super user and can modify it, but only when providing the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this entity. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
system_owned (bool or None) – Indicates system owned resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
description (str or None) – Description of this resource
display_name (str or None) – Defaults to ID if not set
id (str or None) – Unique identifier of this resource
resource_type (str) –
tags (list of Tag or None) – Opaque identifiers meaningful to the API user
marked_for_delete (bool or None) – If this field is set to true, delete operation is triggered on the intent tree. This resource along with its all children in intent tree will be deleted. This is a cascade delete and should only be used if intent object along with its all children are to be deleted. This does not support deletion of single non-leaf node within the tree and should be used carefully.

property resource_type¶: Return the discriminator value

class com.vmware.nsx_policy.model_client.ChildPolicyLbPoolAccess(policy_lb_pool_access=None, links=None, schema=None, self_=None, revision=None, create_time=None, create_user=None, last_modified_time=None, last_modified_user=None, protection=None, system_owned=None, description=None, display_name=None, id=None, resource_type='ChildPolicyLbPoolAccess', tags=None, marked_for_delete=None)¶

Bases: vmware.vapi.bindings.struct.VapiStruct

Child wrapper for PolicyLbPoolAccess, used in hierarchical API

Tip

The arguments are used to initialize data attributes with the same names.

Parameters

policy_lb_pool_access (PolicyLbPoolAccess) – Contains the actual PolicyLbPoolAccess object
links (list of ResourceLink or None) – The server will populate this field when returing the resource. Ignored on PUT and POST. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
schema (str or None) – Schema for this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
self (SelfResourceLink or None) – Link to this resource
revision (long or None) – The _revision property describes the current revision of the resource. To prevent clients from overwriting each other’s changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected. format: int32
create_time (long or None) – Timestamp of resource creation format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
create_user (str or None) – ID of the user who created this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
last_modified_time (long or None) – Timestamp of last modification format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
last_modified_user (str or None) – ID of the user who last modified this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
protection (str or None) – Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super user and can modify it, but only when providing the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this entity. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
system_owned (bool or None) – Indicates system owned resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
description (str or None) – Description of this resource
display_name (str or None) – Defaults to ID if not set
id (str or None) – Unique identifier of this resource
resource_type (str) –
tags (list of Tag or None) – Opaque identifiers meaningful to the API user
marked_for_delete (bool or None) – If this field is set to true, delete operation is triggered on the intent tree. This resource along with its all children in intent tree will be deleted. This is a cascade delete and should only be used if intent object along with its all children are to be deleted. This does not support deletion of single non-leaf node within the tree and should be used carefully.

property resource_type¶: Return the discriminator value

class com.vmware.nsx_policy.model_client.ChildPolicyLbRule(policy_lb_rule=None, links=None, schema=None, self_=None, revision=None, create_time=None, create_user=None, last_modified_time=None, last_modified_user=None, protection=None, system_owned=None, description=None, display_name=None, id=None, resource_type='ChildPolicyLbRule', tags=None, marked_for_delete=None)¶

Bases: vmware.vapi.bindings.struct.VapiStruct

Child wrapper for PolicyLbRule, used in hierarchical API

Tip

The arguments are used to initialize data attributes with the same names.

Parameters

policy_lb_rule (PolicyLbRule) – Contains the actual PolicyLbRule object
links (list of ResourceLink or None) – The server will populate this field when returing the resource. Ignored on PUT and POST. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
schema (str or None) – Schema for this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
self (SelfResourceLink or None) – Link to this resource
revision (long or None) – The _revision property describes the current revision of the resource. To prevent clients from overwriting each other’s changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected. format: int32
create_time (long or None) – Timestamp of resource creation format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
create_user (str or None) – ID of the user who created this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
last_modified_time (long or None) – Timestamp of last modification format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
last_modified_user (str or None) – ID of the user who last modified this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
protection (str or None) – Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super user and can modify it, but only when providing the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this entity. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
system_owned (bool or None) – Indicates system owned resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
description (str or None) – Description of this resource
display_name (str or None) – Defaults to ID if not set
id (str or None) – Unique identifier of this resource
resource_type (str) –
tags (list of Tag or None) – Opaque identifiers meaningful to the API user
marked_for_delete (bool or None) – If this field is set to true, delete operation is triggered on the intent tree. This resource along with its all children in intent tree will be deleted. This is a cascade delete and should only be used if intent object along with its all children are to be deleted. This does not support deletion of single non-leaf node within the tree and should be used carefully.

property resource_type¶: Return the discriminator value

class com.vmware.nsx_policy.model_client.ChildPolicyLbVirtualServer(policy_lb_virtual_server=None, links=None, schema=None, self_=None, revision=None, create_time=None, create_user=None, last_modified_time=None, last_modified_user=None, protection=None, system_owned=None, description=None, display_name=None, id=None, resource_type='ChildPolicyLbVirtualServer', tags=None, marked_for_delete=None)¶

Bases: vmware.vapi.bindings.struct.VapiStruct

Child wrapper for PolicyLbVirtualServer, used in hierarchical API

Tip

The arguments are used to initialize data attributes with the same names.

Parameters

policy_lb_virtual_server (vmware.vapi.struct.VapiStruct) – Contains the actual PolicyLbVirtualServer object When clients pass a value of this class as a parameter, the attribute must contain all the attributes defined in PolicyLbVirtualServer. When methods return a value of this class as a return value, the attribute will contain all the attributes defined in PolicyLbVirtualServer.
links (list of ResourceLink or None) – The server will populate this field when returing the resource. Ignored on PUT and POST. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
schema (str or None) – Schema for this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
self (SelfResourceLink or None) – Link to this resource
revision (long or None) – The _revision property describes the current revision of the resource. To prevent clients from overwriting each other’s changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected. format: int32
create_time (long or None) – Timestamp of resource creation format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
create_user (str or None) – ID of the user who created this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
last_modified_time (long or None) – Timestamp of last modification format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
last_modified_user (str or None) – ID of the user who last modified this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
protection (str or None) – Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super user and can modify it, but only when providing the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this entity. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
system_owned (bool or None) – Indicates system owned resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
description (str or None) – Description of this resource
display_name (str or None) – Defaults to ID if not set
id (str or None) – Unique identifier of this resource
resource_type (str) –
tags (list of Tag or None) – Opaque identifiers meaningful to the API user
marked_for_delete (bool or None) – If this field is set to true, delete operation is triggered on the intent tree. This resource along with its all children in intent tree will be deleted. This is a cascade delete and should only be used if intent object along with its all children are to be deleted. This does not support deletion of single non-leaf node within the tree and should be used carefully.

property resource_type¶: Return the discriminator value

class com.vmware.nsx_policy.model_client.ChildPolicyNat(policy_nat=None, links=None, schema=None, self_=None, revision=None, create_time=None, create_user=None, last_modified_time=None, last_modified_user=None, protection=None, system_owned=None, description=None, display_name=None, id=None, resource_type='ChildPolicyNat', tags=None, marked_for_delete=None)¶

Bases: vmware.vapi.bindings.struct.VapiStruct

Child wrapper object for PolicyNat, used in hierarchical API

Tip

The arguments are used to initialize data attributes with the same names.

Parameters

policy_nat (PolicyNat) – Contains the actual PolicyNAT object
links (list of ResourceLink or None) – The server will populate this field when returing the resource. Ignored on PUT and POST. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
schema (str or None) – Schema for this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
self (SelfResourceLink or None) – Link to this resource
revision (long or None) – The _revision property describes the current revision of the resource. To prevent clients from overwriting each other’s changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected. format: int32
create_time (long or None) – Timestamp of resource creation format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
create_user (str or None) – ID of the user who created this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
last_modified_time (long or None) – Timestamp of last modification format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
last_modified_user (str or None) – ID of the user who last modified this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
protection (str or None) – Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super user and can modify it, but only when providing the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this entity. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
system_owned (bool or None) – Indicates system owned resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
description (str or None) – Description of this resource
display_name (str or None) – Defaults to ID if not set
id (str or None) – Unique identifier of this resource
resource_type (str) –
tags (list of Tag or None) – Opaque identifiers meaningful to the API user
marked_for_delete (bool or None) – If this field is set to true, delete operation is triggered on the intent tree. This resource along with its all children in intent tree will be deleted. This is a cascade delete and should only be used if intent object along with its all children are to be deleted. This does not support deletion of single non-leaf node within the tree and should be used carefully.

property resource_type¶: Return the discriminator value

class com.vmware.nsx_policy.model_client.ChildPolicyNatRule(policy_nat_rule=None, links=None, schema=None, self_=None, revision=None, create_time=None, create_user=None, last_modified_time=None, last_modified_user=None, protection=None, system_owned=None, description=None, display_name=None, id=None, resource_type='ChildPolicyNatRule', tags=None, marked_for_delete=None)¶

Bases: vmware.vapi.bindings.struct.VapiStruct

Child wrapper object for PolicyNatRule, used in hierarchical API

Tip

The arguments are used to initialize data attributes with the same names.

Parameters

policy_nat_rule (PolicyNatRule) – Contains the actual PolicyNatRule object
links (list of ResourceLink or None) – The server will populate this field when returing the resource. Ignored on PUT and POST. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
schema (str or None) – Schema for this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
self (SelfResourceLink or None) – Link to this resource
revision (long or None) – The _revision property describes the current revision of the resource. To prevent clients from overwriting each other’s changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected. format: int32
create_time (long or None) – Timestamp of resource creation format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
create_user (str or None) – ID of the user who created this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
last_modified_time (long or None) – Timestamp of last modification format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
last_modified_user (str or None) – ID of the user who last modified this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
protection (str or None) – Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super user and can modify it, but only when providing the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this entity. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
system_owned (bool or None) – Indicates system owned resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
description (str or None) – Description of this resource
display_name (str or None) – Defaults to ID if not set
id (str or None) – Unique identifier of this resource
resource_type (str) –
tags (list of Tag or None) – Opaque identifiers meaningful to the API user
marked_for_delete (bool or None) – If this field is set to true, delete operation is triggered on the intent tree. This resource along with its all children in intent tree will be deleted. This is a cascade delete and should only be used if intent object along with its all children are to be deleted. This does not support deletion of single non-leaf node within the tree and should be used carefully.

property resource_type¶: Return the discriminator value

class com.vmware.nsx_policy.model_client.ChildPolicyServiceChain(policy_service_chain=None, links=None, schema=None, self_=None, revision=None, create_time=None, create_user=None, last_modified_time=None, last_modified_user=None, protection=None, system_owned=None, description=None, display_name=None, id=None, resource_type='ChildPolicyServiceChain', tags=None, marked_for_delete=None)¶

Bases: vmware.vapi.bindings.struct.VapiStruct

Child wrapper object for PolicyServiceInstance used in hierarchical API.

Tip

The arguments are used to initialize data attributes with the same names.

Parameters

policy_service_chain (PolicyServiceChain) – Contains actual PolicyServiceChain.
links (list of ResourceLink or None) – The server will populate this field when returing the resource. Ignored on PUT and POST. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
schema (str or None) – Schema for this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
self (SelfResourceLink or None) – Link to this resource
revision (long or None) – The _revision property describes the current revision of the resource. To prevent clients from overwriting each other’s changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected. format: int32
create_time (long or None) – Timestamp of resource creation format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
create_user (str or None) – ID of the user who created this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
last_modified_time (long or None) – Timestamp of last modification format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
last_modified_user (str or None) – ID of the user who last modified this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
protection (str or None) – Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super user and can modify it, but only when providing the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this entity. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
system_owned (bool or None) – Indicates system owned resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
description (str or None) – Description of this resource
display_name (str or None) – Defaults to ID if not set
id (str or None) – Unique identifier of this resource
resource_type (str) –
tags (list of Tag or None) – Opaque identifiers meaningful to the API user
marked_for_delete (bool or None) – If this field is set to true, delete operation is triggered on the intent tree. This resource along with its all children in intent tree will be deleted. This is a cascade delete and should only be used if intent object along with its all children are to be deleted. This does not support deletion of single non-leaf node within the tree and should be used carefully.

property resource_type¶: Return the discriminator value

class com.vmware.nsx_policy.model_client.ChildPolicyServiceInstance(policy_service_instance=None, links=None, schema=None, self_=None, revision=None, create_time=None, create_user=None, last_modified_time=None, last_modified_user=None, protection=None, system_owned=None, description=None, display_name=None, id=None, resource_type='ChildPolicyServiceInstance', tags=None, marked_for_delete=None)¶

Bases: vmware.vapi.bindings.struct.VapiStruct

Child wrapper object for PolicyServiceInstance used in hierarchical API.

Tip

The arguments are used to initialize data attributes with the same names.

Parameters

policy_service_instance (PolicyServiceInstance) – Contains actual PolicyServiceInstance.
links (list of ResourceLink or None) – The server will populate this field when returing the resource. Ignored on PUT and POST. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
schema (str or None) – Schema for this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
self (SelfResourceLink or None) – Link to this resource
revision (long or None) – The _revision property describes the current revision of the resource. To prevent clients from overwriting each other’s changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected. format: int32
create_time (long or None) – Timestamp of resource creation format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
create_user (str or None) – ID of the user who created this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
last_modified_time (long or None) – Timestamp of last modification format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
last_modified_user (str or None) – ID of the user who last modified this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
protection (str or None) – Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super user and can modify it, but only when providing the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this entity. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
system_owned (bool or None) – Indicates system owned resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
description (str or None) – Description of this resource
display_name (str or None) – Defaults to ID if not set
id (str or None) – Unique identifier of this resource
resource_type (str) –
tags (list of Tag or None) – Opaque identifiers meaningful to the API user
marked_for_delete (bool or None) – If this field is set to true, delete operation is triggered on the intent tree. This resource along with its all children in intent tree will be deleted. This is a cascade delete and should only be used if intent object along with its all children are to be deleted. This does not support deletion of single non-leaf node within the tree and should be used carefully.

property resource_type¶: Return the discriminator value

class com.vmware.nsx_policy.model_client.ChildPolicyServiceProfile(policy_service_profile=None, links=None, schema=None, self_=None, revision=None, create_time=None, create_user=None, last_modified_time=None, last_modified_user=None, protection=None, system_owned=None, description=None, display_name=None, id=None, resource_type='ChildPolicyServiceProfile', tags=None, marked_for_delete=None)¶

Bases: vmware.vapi.bindings.struct.VapiStruct

Child wrapper object for PolicyServiceProfile used in hierarchical API.

Tip

The arguments are used to initialize data attributes with the same names.

Parameters

policy_service_profile (PolicyServiceProfile) – Contains actual PolicyServiceProfile.
links (list of ResourceLink or None) – The server will populate this field when returing the resource. Ignored on PUT and POST. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
schema (str or None) – Schema for this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
self (SelfResourceLink or None) – Link to this resource
revision (long or None) – The _revision property describes the current revision of the resource. To prevent clients from overwriting each other’s changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected. format: int32
create_time (long or None) – Timestamp of resource creation format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
create_user (str or None) – ID of the user who created this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
last_modified_time (long or None) – Timestamp of last modification format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
last_modified_user (str or None) – ID of the user who last modified this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
protection (str or None) – Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super user and can modify it, but only when providing the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this entity. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
system_owned (bool or None) – Indicates system owned resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
description (str or None) – Description of this resource
display_name (str or None) – Defaults to ID if not set
id (str or None) – Unique identifier of this resource
resource_type (str) –
tags (list of Tag or None) – Opaque identifiers meaningful to the API user
marked_for_delete (bool or None) – If this field is set to true, delete operation is triggered on the intent tree. This resource along with its all children in intent tree will be deleted. This is a cascade delete and should only be used if intent object along with its all children are to be deleted. This does not support deletion of single non-leaf node within the tree and should be used carefully.

property resource_type¶: Return the discriminator value

class com.vmware.nsx_policy.model_client.ChildPolicyTransportZone(policy_transport_zone=None, links=None, schema=None, self_=None, revision=None, create_time=None, create_user=None, last_modified_time=None, last_modified_user=None, protection=None, system_owned=None, description=None, display_name=None, id=None, resource_type='ChildPolicyTransportZone', tags=None, marked_for_delete=None)¶

Bases: vmware.vapi.bindings.struct.VapiStruct

Child wrapper object for PolicyTransportZone, used in hierarchical API

Tip

The arguments are used to initialize data attributes with the same names.

Parameters

policy_transport_zone (PolicyTransportZone) – Contains the actual PolicyTransportZone object
links (list of ResourceLink or None) – The server will populate this field when returing the resource. Ignored on PUT and POST. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
schema (str or None) – Schema for this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
self (SelfResourceLink or None) – Link to this resource
revision (long or None) – The _revision property describes the current revision of the resource. To prevent clients from overwriting each other’s changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected. format: int32
create_time (long or None) – Timestamp of resource creation format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
create_user (str or None) – ID of the user who created this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
last_modified_time (long or None) – Timestamp of last modification format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
last_modified_user (str or None) – ID of the user who last modified this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
protection (str or None) – Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super user and can modify it, but only when providing the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this entity. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
system_owned (bool or None) – Indicates system owned resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
description (str or None) – Description of this resource
display_name (str or None) – Defaults to ID if not set
id (str or None) – Unique identifier of this resource
resource_type (str) –
tags (list of Tag or None) – Opaque identifiers meaningful to the API user
marked_for_delete (bool or None) – If this field is set to true, delete operation is triggered on the intent tree. This resource along with its all children in intent tree will be deleted. This is a cascade delete and should only be used if intent object along with its all children are to be deleted. This does not support deletion of single non-leaf node within the tree and should be used carefully.

property resource_type¶: Return the discriminator value

class com.vmware.nsx_policy.model_client.ChildPortDiscoveryProfileBindingMap(port_discovery_profile_binding_map=None, links=None, schema=None, self_=None, revision=None, create_time=None, create_user=None, last_modified_time=None, last_modified_user=None, protection=None, system_owned=None, description=None, display_name=None, id=None, resource_type='ChildPortDiscoveryProfileBindingMap', tags=None, marked_for_delete=None)¶

Bases: vmware.vapi.bindings.struct.VapiStruct

Child wrapper object for PortDiscoveryProfileBindingMap, used in hierarchical API

Tip

The arguments are used to initialize data attributes with the same names.

Parameters

port_discovery_profile_binding_map (PortDiscoveryProfileBindingMap) – Contains the actual PortDiscoveryProfileBindingMap object
links (list of ResourceLink or None) – The server will populate this field when returing the resource. Ignored on PUT and POST. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
schema (str or None) – Schema for this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
self (SelfResourceLink or None) – Link to this resource
revision (long or None) – The _revision property describes the current revision of the resource. To prevent clients from overwriting each other’s changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected. format: int32
create_time (long or None) – Timestamp of resource creation format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
create_user (str or None) – ID of the user who created this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
last_modified_time (long or None) – Timestamp of last modification format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
last_modified_user (str or None) – ID of the user who last modified this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
protection (str or None) – Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super user and can modify it, but only when providing the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this entity. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
system_owned (bool or None) – Indicates system owned resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
description (str or None) – Description of this resource
display_name (str or None) – Defaults to ID if not set
id (str or None) – Unique identifier of this resource
resource_type (str) –
tags (list of Tag or None) – Opaque identifiers meaningful to the API user
marked_for_delete (bool or None) – If this field is set to true, delete operation is triggered on the intent tree. This resource along with its all children in intent tree will be deleted. This is a cascade delete and should only be used if intent object along with its all children are to be deleted. This does not support deletion of single non-leaf node within the tree and should be used carefully.

property resource_type¶: Return the discriminator value

class com.vmware.nsx_policy.model_client.ChildPortMirroringProfile(port_mirroring_profile=None, links=None, schema=None, self_=None, revision=None, create_time=None, create_user=None, last_modified_time=None, last_modified_user=None, protection=None, system_owned=None, description=None, display_name=None, id=None, resource_type='ChildPortMirroringProfile', tags=None, marked_for_delete=None)¶

Bases: vmware.vapi.bindings.struct.VapiStruct

Child wrapper object for PortMirroringProfile, used in hierarchical API

Tip

The arguments are used to initialize data attributes with the same names.

Parameters

port_mirroring_profile (PortMirroringProfile) – Contains the actual PortMirroringProfile object
links (list of ResourceLink or None) – The server will populate this field when returing the resource. Ignored on PUT and POST. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
schema (str or None) – Schema for this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
self (SelfResourceLink or None) – Link to this resource
revision (long or None) – The _revision property describes the current revision of the resource. To prevent clients from overwriting each other’s changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected. format: int32
create_time (long or None) – Timestamp of resource creation format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
create_user (str or None) – ID of the user who created this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
last_modified_time (long or None) – Timestamp of last modification format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
last_modified_user (str or None) – ID of the user who last modified this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
protection (str or None) – Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super user and can modify it, but only when providing the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this entity. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
system_owned (bool or None) – Indicates system owned resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
description (str or None) – Description of this resource
display_name (str or None) – Defaults to ID if not set
id (str or None) – Unique identifier of this resource
resource_type (str) –
tags (list of Tag or None) – Opaque identifiers meaningful to the API user
marked_for_delete (bool or None) – If this field is set to true, delete operation is triggered on the intent tree. This resource along with its all children in intent tree will be deleted. This is a cascade delete and should only be used if intent object along with its all children are to be deleted. This does not support deletion of single non-leaf node within the tree and should be used carefully.

property resource_type¶: Return the discriminator value

class com.vmware.nsx_policy.model_client.ChildPortMonitoringProfileBindingMap(port_monitoring_profile_binding_map=None, links=None, schema=None, self_=None, revision=None, create_time=None, create_user=None, last_modified_time=None, last_modified_user=None, protection=None, system_owned=None, description=None, display_name=None, id=None, resource_type='ChildPortMonitoringProfileBindingMap', tags=None, marked_for_delete=None)¶

Bases: vmware.vapi.bindings.struct.VapiStruct

Child wrapper object for PortMonitoringProfileBindingMap, used in hierarchical API

Tip

The arguments are used to initialize data attributes with the same names.

Parameters

port_monitoring_profile_binding_map (PortMonitoringProfileBindingMap) – Contains the actual PortMonitoringProfileBindingMap object
links (list of ResourceLink or None) – The server will populate this field when returing the resource. Ignored on PUT and POST. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
schema (str or None) – Schema for this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
self (SelfResourceLink or None) – Link to this resource
revision (long or None) – The _revision property describes the current revision of the resource. To prevent clients from overwriting each other’s changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected. format: int32
create_time (long or None) – Timestamp of resource creation format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
create_user (str or None) – ID of the user who created this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
last_modified_time (long or None) – Timestamp of last modification format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
last_modified_user (str or None) – ID of the user who last modified this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
protection (str or None) – Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super user and can modify it, but only when providing the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this entity. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
system_owned (bool or None) – Indicates system owned resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
description (str or None) – Description of this resource
display_name (str or None) – Defaults to ID if not set
id (str or None) – Unique identifier of this resource
resource_type (str) –
tags (list of Tag or None) – Opaque identifiers meaningful to the API user
marked_for_delete (bool or None) – If this field is set to true, delete operation is triggered on the intent tree. This resource along with its all children in intent tree will be deleted. This is a cascade delete and should only be used if intent object along with its all children are to be deleted. This does not support deletion of single non-leaf node within the tree and should be used carefully.

property resource_type¶: Return the discriminator value

class com.vmware.nsx_policy.model_client.ChildPortQosProfileBindingMap(port_qos_profile_binding_map=None, links=None, schema=None, self_=None, revision=None, create_time=None, create_user=None, last_modified_time=None, last_modified_user=None, protection=None, system_owned=None, description=None, display_name=None, id=None, resource_type='ChildPortQoSProfileBindingMap', tags=None, marked_for_delete=None)¶

Bases: vmware.vapi.bindings.struct.VapiStruct

Child wrapper object for PortQoSProfileBindingMap, used in hierarchical API

Tip

The arguments are used to initialize data attributes with the same names.

Parameters

port_qos_profile_binding_map (PortQosProfileBindingMap) – Contains the actual PortQoSProfileBindingMap object
links (list of ResourceLink or None) – The server will populate this field when returing the resource. Ignored on PUT and POST. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
schema (str or None) – Schema for this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
self (SelfResourceLink or None) – Link to this resource
revision (long or None) – The _revision property describes the current revision of the resource. To prevent clients from overwriting each other’s changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected. format: int32
create_time (long or None) – Timestamp of resource creation format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
create_user (str or None) – ID of the user who created this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
last_modified_time (long or None) – Timestamp of last modification format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
last_modified_user (str or None) – ID of the user who last modified this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
protection (str or None) – Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super user and can modify it, but only when providing the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this entity. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
system_owned (bool or None) – Indicates system owned resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
description (str or None) – Description of this resource
display_name (str or None) – Defaults to ID if not set
id (str or None) – Unique identifier of this resource
resource_type (str) –
tags (list of Tag or None) – Opaque identifiers meaningful to the API user
marked_for_delete (bool or None) – If this field is set to true, delete operation is triggered on the intent tree. This resource along with its all children in intent tree will be deleted. This is a cascade delete and should only be used if intent object along with its all children are to be deleted. This does not support deletion of single non-leaf node within the tree and should be used carefully.

property resource_type¶: Return the discriminator value

class com.vmware.nsx_policy.model_client.ChildPortSecurityProfileBindingMap(port_security_profile_binding_map=None, links=None, schema=None, self_=None, revision=None, create_time=None, create_user=None, last_modified_time=None, last_modified_user=None, protection=None, system_owned=None, description=None, display_name=None, id=None, resource_type='ChildPortSecurityProfileBindingMap', tags=None, marked_for_delete=None)¶

Bases: vmware.vapi.bindings.struct.VapiStruct

Child wrapper object for PortSecurityProfileBindingMap, used in hierarchical API

Tip

The arguments are used to initialize data attributes with the same names.

Parameters

port_security_profile_binding_map (PortSecurityProfileBindingMap) – Contains the actual PortSecurityProfileBindingMap object
links (list of ResourceLink or None) – The server will populate this field when returing the resource. Ignored on PUT and POST. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
schema (str or None) – Schema for this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
self (SelfResourceLink or None) – Link to this resource
revision (long or None) – The _revision property describes the current revision of the resource. To prevent clients from overwriting each other’s changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected. format: int32
create_time (long or None) – Timestamp of resource creation format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
create_user (str or None) – ID of the user who created this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
last_modified_time (long or None) – Timestamp of last modification format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
last_modified_user (str or None) – ID of the user who last modified this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
protection (str or None) – Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super user and can modify it, but only when providing the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this entity. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
system_owned (bool or None) – Indicates system owned resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
description (str or None) – Description of this resource
display_name (str or None) – Defaults to ID if not set
id (str or None) – Unique identifier of this resource
resource_type (str) –
tags (list of Tag or None) – Opaque identifiers meaningful to the API user
marked_for_delete (bool or None) – If this field is set to true, delete operation is triggered on the intent tree. This resource along with its all children in intent tree will be deleted. This is a cascade delete and should only be used if intent object along with its all children are to be deleted. This does not support deletion of single non-leaf node within the tree and should be used carefully.

property resource_type¶: Return the discriminator value

class com.vmware.nsx_policy.model_client.ChildPrefixList(prefix_list=None, links=None, schema=None, self_=None, revision=None, create_time=None, create_user=None, last_modified_time=None, last_modified_user=None, protection=None, system_owned=None, description=None, display_name=None, id=None, resource_type='ChildPrefixList', tags=None, marked_for_delete=None)¶

Bases: vmware.vapi.bindings.struct.VapiStruct

Child wrapper object for PrefixList, used in hierarchical API.

Tip

The arguments are used to initialize data attributes with the same names.

Parameters

prefix_list (PrefixList) – Contains the actual PrefixList object.
links (list of ResourceLink or None) – The server will populate this field when returing the resource. Ignored on PUT and POST. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
schema (str or None) – Schema for this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
self (SelfResourceLink or None) – Link to this resource
revision (long or None) – The _revision property describes the current revision of the resource. To prevent clients from overwriting each other’s changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected. format: int32
create_time (long or None) – Timestamp of resource creation format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
create_user (str or None) – ID of the user who created this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
last_modified_time (long or None) – Timestamp of last modification format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
last_modified_user (str or None) – ID of the user who last modified this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
protection (str or None) – Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super user and can modify it, but only when providing the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this entity. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
system_owned (bool or None) – Indicates system owned resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
description (str or None) – Description of this resource
display_name (str or None) – Defaults to ID if not set
id (str or None) – Unique identifier of this resource
resource_type (str) –
tags (list of Tag or None) – Opaque identifiers meaningful to the API user
marked_for_delete (bool or None) – If this field is set to true, delete operation is triggered on the intent tree. This resource along with its all children in intent tree will be deleted. This is a cascade delete and should only be used if intent object along with its all children are to be deleted. This does not support deletion of single non-leaf node within the tree and should be used carefully.

property resource_type¶: Return the discriminator value

class com.vmware.nsx_policy.model_client.ChildQosProfile(qos_profile=None, links=None, schema=None, self_=None, revision=None, create_time=None, create_user=None, last_modified_time=None, last_modified_user=None, protection=None, system_owned=None, description=None, display_name=None, id=None, resource_type='ChildQoSProfile', tags=None, marked_for_delete=None)¶

Bases: vmware.vapi.bindings.struct.VapiStruct

Child wrapper object for QoSProfile, used in hierarchical API

Tip

The arguments are used to initialize data attributes with the same names.

Parameters

qos_profile (QosProfile) – Contains the actual QoSProfile object
links (list of ResourceLink or None) – The server will populate this field when returing the resource. Ignored on PUT and POST. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
schema (str or None) – Schema for this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
self (SelfResourceLink or None) – Link to this resource
revision (long or None) – The _revision property describes the current revision of the resource. To prevent clients from overwriting each other’s changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected. format: int32
create_time (long or None) – Timestamp of resource creation format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
create_user (str or None) – ID of the user who created this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
last_modified_time (long or None) – Timestamp of last modification format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
last_modified_user (str or None) – ID of the user who last modified this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
protection (str or None) – Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super user and can modify it, but only when providing the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this entity. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
system_owned (bool or None) – Indicates system owned resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
description (str or None) – Description of this resource
display_name (str or None) – Defaults to ID if not set
id (str or None) – Unique identifier of this resource
resource_type (str) –
tags (list of Tag or None) – Opaque identifiers meaningful to the API user
marked_for_delete (bool or None) – If this field is set to true, delete operation is triggered on the intent tree. This resource along with its all children in intent tree will be deleted. This is a cascade delete and should only be used if intent object along with its all children are to be deleted. This does not support deletion of single non-leaf node within the tree and should be used carefully.

property resource_type¶: Return the discriminator value

class com.vmware.nsx_policy.model_client.ChildReaction(reaction=None, links=None, schema=None, self_=None, revision=None, create_time=None, create_user=None, last_modified_time=None, last_modified_user=None, protection=None, system_owned=None, description=None, display_name=None, id=None, resource_type='ChildReaction', tags=None, marked_for_delete=None)¶

Bases: vmware.vapi.bindings.struct.VapiStruct

Child wrapper object for Reaction used in hierarchical API.

Tip

The arguments are used to initialize data attributes with the same names.

Parameters

reaction (Reaction) – Contains the actual Reaction object.
links (list of ResourceLink or None) – The server will populate this field when returing the resource. Ignored on PUT and POST. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
schema (str or None) – Schema for this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
self (SelfResourceLink or None) – Link to this resource
revision (long or None) – The _revision property describes the current revision of the resource. To prevent clients from overwriting each other’s changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected. format: int32
create_time (long or None) – Timestamp of resource creation format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
create_user (str or None) – ID of the user who created this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
last_modified_time (long or None) – Timestamp of last modification format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
last_modified_user (str or None) – ID of the user who last modified this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
protection (str or None) – Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super user and can modify it, but only when providing the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this entity. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
system_owned (bool or None) – Indicates system owned resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
description (str or None) – Description of this resource
display_name (str or None) – Defaults to ID if not set
id (str or None) – Unique identifier of this resource
resource_type (str) –
tags (list of Tag or None) – Opaque identifiers meaningful to the API user
marked_for_delete (bool or None) – If this field is set to true, delete operation is triggered on the intent tree. This resource along with its all children in intent tree will be deleted. This is a cascade delete and should only be used if intent object along with its all children are to be deleted. This does not support deletion of single non-leaf node within the tree and should be used carefully.

property resource_type¶: Return the discriminator value

class com.vmware.nsx_policy.model_client.ChildRedirectionPolicy(redirection_policy=None, links=None, schema=None, self_=None, revision=None, create_time=None, create_user=None, last_modified_time=None, last_modified_user=None, protection=None, system_owned=None, description=None, display_name=None, id=None, resource_type='ChildRedirectionPolicy', tags=None, marked_for_delete=None)¶

Bases: vmware.vapi.bindings.struct.VapiStruct

Child wrapper object for RedirectionPolicy used in Hierarchical API.

Tip

The arguments are used to initialize data attributes with the same names.

Parameters

redirection_policy (RedirectionPolicy) – Contains actual RedirectionPolicy.
links (list of ResourceLink or None) – The server will populate this field when returing the resource. Ignored on PUT and POST. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
schema (str or None) – Schema for this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
self (SelfResourceLink or None) – Link to this resource
revision (long or None) – The _revision property describes the current revision of the resource. To prevent clients from overwriting each other’s changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected. format: int32
create_time (long or None) – Timestamp of resource creation format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
create_user (str or None) – ID of the user who created this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
last_modified_time (long or None) – Timestamp of last modification format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
last_modified_user (str or None) – ID of the user who last modified this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
protection (str or None) – Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super user and can modify it, but only when providing the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this entity. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
system_owned (bool or None) – Indicates system owned resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
description (str or None) – Description of this resource
display_name (str or None) – Defaults to ID if not set
id (str or None) – Unique identifier of this resource
resource_type (str) –
tags (list of Tag or None) – Opaque identifiers meaningful to the API user
marked_for_delete (bool or None) – If this field is set to true, delete operation is triggered on the intent tree. This resource along with its all children in intent tree will be deleted. This is a cascade delete and should only be used if intent object along with its all children are to be deleted. This does not support deletion of single non-leaf node within the tree and should be used carefully.

property resource_type¶: Return the discriminator value

class com.vmware.nsx_policy.model_client.ChildRedirectionRule(redirection_rule=None, links=None, schema=None, self_=None, revision=None, create_time=None, create_user=None, last_modified_time=None, last_modified_user=None, protection=None, system_owned=None, description=None, display_name=None, id=None, resource_type='ChildRedirectionRule', tags=None, marked_for_delete=None)¶

Bases: vmware.vapi.bindings.struct.VapiStruct

Child wrapper object for ChildRedirectionRule used in Hierarchical API.

Tip

The arguments are used to initialize data attributes with the same names.

Parameters

redirection_rule (RedirectionRule) – Contains actual RedirectionRule.
links (list of ResourceLink or None) – The server will populate this field when returing the resource. Ignored on PUT and POST. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
schema (str or None) – Schema for this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
self (SelfResourceLink or None) – Link to this resource
revision (long or None) – The _revision property describes the current revision of the resource. To prevent clients from overwriting each other’s changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected. format: int32
create_time (long or None) – Timestamp of resource creation format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
create_user (str or None) – ID of the user who created this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
last_modified_time (long or None) – Timestamp of last modification format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
last_modified_user (str or None) – ID of the user who last modified this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
protection (str or None) – Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super user and can modify it, but only when providing the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this entity. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
system_owned (bool or None) – Indicates system owned resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
description (str or None) – Description of this resource
display_name (str or None) – Defaults to ID if not set
id (str or None) – Unique identifier of this resource
resource_type (str) –
tags (list of Tag or None) – Opaque identifiers meaningful to the API user
marked_for_delete (bool or None) – If this field is set to true, delete operation is triggered on the intent tree. This resource along with its all children in intent tree will be deleted. This is a cascade delete and should only be used if intent object along with its all children are to be deleted. This does not support deletion of single non-leaf node within the tree and should be used carefully.

property resource_type¶: Return the discriminator value

class com.vmware.nsx_policy.model_client.ChildResourceReference(children=None, target_type=None, links=None, schema=None, self_=None, revision=None, create_time=None, create_user=None, last_modified_time=None, last_modified_user=None, protection=None, system_owned=None, description=None, display_name=None, id=None, resource_type='ChildResourceReference', tags=None, marked_for_delete=None)¶

Bases: vmware.vapi.bindings.struct.VapiStruct

Represents a reference to ChildPolicyConfigResource in the hierarchical API. resource_type, id and target_type are mandatory fields.

Tip

The arguments are used to initialize data attributes with the same names.

Parameters

children (list of vmware.vapi.struct.VapiStruct or None) – subtree for this type within policy tree containing nested elements. When clients pass a value of this class as a parameter, the attribute must contain all the attributes defined in ChildPolicyConfigResource. When methods return a value of this class as a return value, the attribute will contain all the attributes defined in ChildPolicyConfigResource.
target_type (str) – The target type of this reference
links (list of ResourceLink or None) – The server will populate this field when returing the resource. Ignored on PUT and POST. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
schema (str or None) – Schema for this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
self (SelfResourceLink or None) – Link to this resource
revision (long or None) – The _revision property describes the current revision of the resource. To prevent clients from overwriting each other’s changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected. format: int32
create_time (long or None) – Timestamp of resource creation format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
create_user (str or None) – ID of the user who created this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
last_modified_time (long or None) – Timestamp of last modification format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
last_modified_user (str or None) – ID of the user who last modified this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
protection (str or None) – Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super user and can modify it, but only when providing the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this entity. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
system_owned (bool or None) – Indicates system owned resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
description (str or None) – Description of this resource
display_name (str or None) – Defaults to ID if not set
id (str or None) – Unique identifier of this resource
resource_type (str) –
tags (list of Tag or None) – Opaque identifiers meaningful to the API user
marked_for_delete (bool or None) – If this field is set to true, delete operation is triggered on the intent tree. This resource along with its all children in intent tree will be deleted. This is a cascade delete and should only be used if intent object along with its all children are to be deleted. This does not support deletion of single non-leaf node within the tree and should be used carefully.

property resource_type¶: Return the discriminator value

class com.vmware.nsx_policy.model_client.ChildRule(rule=None, links=None, schema=None, self_=None, revision=None, create_time=None, create_user=None, last_modified_time=None, last_modified_user=None, protection=None, system_owned=None, description=None, display_name=None, id=None, resource_type='ChildRule', tags=None, marked_for_delete=None)¶

Bases: vmware.vapi.bindings.struct.VapiStruct

Child wrapper object for Rule, used in hierarchical API

Tip

The arguments are used to initialize data attributes with the same names.

Parameters

rule (Rule) – Contains the actual Rule object
links (list of ResourceLink or None) – The server will populate this field when returing the resource. Ignored on PUT and POST. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
schema (str or None) – Schema for this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
self (SelfResourceLink or None) – Link to this resource
revision (long or None) – The _revision property describes the current revision of the resource. To prevent clients from overwriting each other’s changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected. format: int32
create_time (long or None) – Timestamp of resource creation format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
create_user (str or None) – ID of the user who created this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
last_modified_time (long or None) – Timestamp of last modification format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
last_modified_user (str or None) – ID of the user who last modified this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
protection (str or None) – Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super user and can modify it, but only when providing the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this entity. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
system_owned (bool or None) – Indicates system owned resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
description (str or None) – Description of this resource
display_name (str or None) – Defaults to ID if not set
id (str or None) – Unique identifier of this resource
resource_type (str) –
tags (list of Tag or None) – Opaque identifiers meaningful to the API user
marked_for_delete (bool or None) – If this field is set to true, delete operation is triggered on the intent tree. This resource along with its all children in intent tree will be deleted. This is a cascade delete and should only be used if intent object along with its all children are to be deleted. This does not support deletion of single non-leaf node within the tree and should be used carefully.

property resource_type¶: Return the discriminator value

class com.vmware.nsx_policy.model_client.ChildSecurityPolicy(security_policy=None, links=None, schema=None, self_=None, revision=None, create_time=None, create_user=None, last_modified_time=None, last_modified_user=None, protection=None, system_owned=None, description=None, display_name=None, id=None, resource_type='ChildSecurityPolicy', tags=None, marked_for_delete=None)¶

Bases: vmware.vapi.bindings.struct.VapiStruct

Child wrapper object for SecurityPolicy, used in hierarchical API

Tip

The arguments are used to initialize data attributes with the same names.

Parameters

security_policy (SecurityPolicy) – Contains the actual SecurityPolicy object
links (list of ResourceLink or None) – The server will populate this field when returing the resource. Ignored on PUT and POST. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
schema (str or None) – Schema for this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
self (SelfResourceLink or None) – Link to this resource
revision (long or None) – The _revision property describes the current revision of the resource. To prevent clients from overwriting each other’s changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected. format: int32
create_time (long or None) – Timestamp of resource creation format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
create_user (str or None) – ID of the user who created this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
last_modified_time (long or None) – Timestamp of last modification format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
last_modified_user (str or None) – ID of the user who last modified this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
protection (str or None) – Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super user and can modify it, but only when providing the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this entity. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
system_owned (bool or None) – Indicates system owned resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
description (str or None) – Description of this resource
display_name (str or None) – Defaults to ID if not set
id (str or None) – Unique identifier of this resource
resource_type (str) –
tags (list of Tag or None) – Opaque identifiers meaningful to the API user
marked_for_delete (bool or None) – If this field is set to true, delete operation is triggered on the intent tree. This resource along with its all children in intent tree will be deleted. This is a cascade delete and should only be used if intent object along with its all children are to be deleted. This does not support deletion of single non-leaf node within the tree and should be used carefully.

property resource_type¶: Return the discriminator value

class com.vmware.nsx_policy.model_client.ChildSegment(segment=None, links=None, schema=None, self_=None, revision=None, create_time=None, create_user=None, last_modified_time=None, last_modified_user=None, protection=None, system_owned=None, description=None, display_name=None, id=None, resource_type='ChildSegment', tags=None, marked_for_delete=None)¶

Bases: vmware.vapi.bindings.struct.VapiStruct

Child wrapper object for Segment, used in hierarchical API.

Tip

The arguments are used to initialize data attributes with the same names.

Parameters

segment (Segment) – Contains the actual Segment object.
links (list of ResourceLink or None) – The server will populate this field when returing the resource. Ignored on PUT and POST. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
schema (str or None) – Schema for this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
self (SelfResourceLink or None) – Link to this resource
revision (long or None) – The _revision property describes the current revision of the resource. To prevent clients from overwriting each other’s changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected. format: int32
create_time (long or None) – Timestamp of resource creation format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
create_user (str or None) – ID of the user who created this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
last_modified_time (long or None) – Timestamp of last modification format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
last_modified_user (str or None) – ID of the user who last modified this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
protection (str or None) – Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super user and can modify it, but only when providing the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this entity. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
system_owned (bool or None) – Indicates system owned resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
description (str or None) – Description of this resource
display_name (str or None) – Defaults to ID if not set
id (str or None) – Unique identifier of this resource
resource_type (str) –
tags (list of Tag or None) – Opaque identifiers meaningful to the API user
marked_for_delete (bool or None) – If this field is set to true, delete operation is triggered on the intent tree. This resource along with its all children in intent tree will be deleted. This is a cascade delete and should only be used if intent object along with its all children are to be deleted. This does not support deletion of single non-leaf node within the tree and should be used carefully.

property resource_type¶: Return the discriminator value

class com.vmware.nsx_policy.model_client.ChildSegmentDiscoveryProfileBindingMap(segment_discovery_profile_binding_map=None, links=None, schema=None, self_=None, revision=None, create_time=None, create_user=None, last_modified_time=None, last_modified_user=None, protection=None, system_owned=None, description=None, display_name=None, id=None, resource_type='ChildSegmentDiscoveryProfileBindingMap', tags=None, marked_for_delete=None)¶

Bases: vmware.vapi.bindings.struct.VapiStruct

Child wrapper object for SegmentDiscoveryProfileBindingMap, used in hierarchical API

Tip

The arguments are used to initialize data attributes with the same names.

Parameters

segment_discovery_profile_binding_map (SegmentDiscoveryProfileBindingMap) – Contains the actual SegmentDiscoveryProfileBindingMap object
links (list of ResourceLink or None) – The server will populate this field when returing the resource. Ignored on PUT and POST. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
schema (str or None) – Schema for this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
self (SelfResourceLink or None) – Link to this resource
revision (long or None) – The _revision property describes the current revision of the resource. To prevent clients from overwriting each other’s changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected. format: int32
create_time (long or None) – Timestamp of resource creation format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
create_user (str or None) – ID of the user who created this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
last_modified_time (long or None) – Timestamp of last modification format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
last_modified_user (str or None) – ID of the user who last modified this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
protection (str or None) – Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super user and can modify it, but only when providing the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this entity. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
system_owned (bool or None) – Indicates system owned resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
description (str or None) – Description of this resource
display_name (str or None) – Defaults to ID if not set
id (str or None) – Unique identifier of this resource
resource_type (str) –
tags (list of Tag or None) – Opaque identifiers meaningful to the API user
marked_for_delete (bool or None) – If this field is set to true, delete operation is triggered on the intent tree. This resource along with its all children in intent tree will be deleted. This is a cascade delete and should only be used if intent object along with its all children are to be deleted. This does not support deletion of single non-leaf node within the tree and should be used carefully.

property resource_type¶: Return the discriminator value

class com.vmware.nsx_policy.model_client.ChildSegmentMonitoringProfileBindingMap(segment_monitoring_profile_binding_map=None, links=None, schema=None, self_=None, revision=None, create_time=None, create_user=None, last_modified_time=None, last_modified_user=None, protection=None, system_owned=None, description=None, display_name=None, id=None, resource_type='ChildSegmentMonitoringProfileBindingMap', tags=None, marked_for_delete=None)¶

Bases: vmware.vapi.bindings.struct.VapiStruct

Child wrapper object for SegmentMonitoringProfileBindingMap, used in hierarchical API

Tip

The arguments are used to initialize data attributes with the same names.

Parameters

segment_monitoring_profile_binding_map (SegmentMonitoringProfileBindingMap) – Contains the actual SegmentMonitoringProfileBindingMap object
links (list of ResourceLink or None) – The server will populate this field when returing the resource. Ignored on PUT and POST. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
schema (str or None) – Schema for this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
self (SelfResourceLink or None) – Link to this resource
revision (long or None) – The _revision property describes the current revision of the resource. To prevent clients from overwriting each other’s changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected. format: int32
create_time (long or None) – Timestamp of resource creation format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
create_user (str or None) – ID of the user who created this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
last_modified_time (long or None) – Timestamp of last modification format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
last_modified_user (str or None) – ID of the user who last modified this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
protection (str or None) – Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super user and can modify it, but only when providing the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this entity. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
system_owned (bool or None) – Indicates system owned resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
description (str or None) – Description of this resource
display_name (str or None) – Defaults to ID if not set
id (str or None) – Unique identifier of this resource
resource_type (str) –
tags (list of Tag or None) – Opaque identifiers meaningful to the API user
marked_for_delete (bool or None) – If this field is set to true, delete operation is triggered on the intent tree. This resource along with its all children in intent tree will be deleted. This is a cascade delete and should only be used if intent object along with its all children are to be deleted. This does not support deletion of single non-leaf node within the tree and should be used carefully.

property resource_type¶: Return the discriminator value

class com.vmware.nsx_policy.model_client.ChildSegmentPort(segment_port=None, links=None, schema=None, self_=None, revision=None, create_time=None, create_user=None, last_modified_time=None, last_modified_user=None, protection=None, system_owned=None, description=None, display_name=None, id=None, resource_type='ChildSegmentPort', tags=None, marked_for_delete=None)¶

Bases: vmware.vapi.bindings.struct.VapiStruct

Child wrapper object for SegmentPort, used in hierarchical API

Tip

The arguments are used to initialize data attributes with the same names.

Parameters

segment_port (SegmentPort) – Contains the actual SegmentPort object
links (list of ResourceLink or None) – The server will populate this field when returing the resource. Ignored on PUT and POST. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
schema (str or None) – Schema for this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
self (SelfResourceLink or None) – Link to this resource
revision (long or None) – The _revision property describes the current revision of the resource. To prevent clients from overwriting each other’s changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected. format: int32
create_time (long or None) – Timestamp of resource creation format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
create_user (str or None) – ID of the user who created this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
last_modified_time (long or None) – Timestamp of last modification format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
last_modified_user (str or None) – ID of the user who last modified this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
protection (str or None) – Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super user and can modify it, but only when providing the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this entity. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
system_owned (bool or None) – Indicates system owned resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
description (str or None) – Description of this resource
display_name (str or None) – Defaults to ID if not set
id (str or None) – Unique identifier of this resource
resource_type (str) –
tags (list of Tag or None) – Opaque identifiers meaningful to the API user
marked_for_delete (bool or None) – If this field is set to true, delete operation is triggered on the intent tree. This resource along with its all children in intent tree will be deleted. This is a cascade delete and should only be used if intent object along with its all children are to be deleted. This does not support deletion of single non-leaf node within the tree and should be used carefully.

property resource_type¶: Return the discriminator value

class com.vmware.nsx_policy.model_client.ChildSegmentQosProfileBindingMap(segment_qos_profile_binding_map=None, links=None, schema=None, self_=None, revision=None, create_time=None, create_user=None, last_modified_time=None, last_modified_user=None, protection=None, system_owned=None, description=None, display_name=None, id=None, resource_type='ChildSegmentQoSProfileBindingMap', tags=None, marked_for_delete=None)¶

Bases: vmware.vapi.bindings.struct.VapiStruct

Child wrapper object for SegmentQoSProfileBindingMap, used in hierarchical API

Tip

The arguments are used to initialize data attributes with the same names.

Parameters

segment_qos_profile_binding_map (SegmentQosProfileBindingMap) – Contains the actual SegmentQoSProfileBindingMap object
links (list of ResourceLink or None) – The server will populate this field when returing the resource. Ignored on PUT and POST. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
schema (str or None) – Schema for this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
self (SelfResourceLink or None) – Link to this resource
revision (long or None) – The _revision property describes the current revision of the resource. To prevent clients from overwriting each other’s changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected. format: int32
create_time (long or None) – Timestamp of resource creation format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
create_user (str or None) – ID of the user who created this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
last_modified_time (long or None) – Timestamp of last modification format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
last_modified_user (str or None) – ID of the user who last modified this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
protection (str or None) – Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super user and can modify it, but only when providing the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this entity. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
system_owned (bool or None) – Indicates system owned resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
description (str or None) – Description of this resource
display_name (str or None) – Defaults to ID if not set
id (str or None) – Unique identifier of this resource
resource_type (str) –
tags (list of Tag or None) – Opaque identifiers meaningful to the API user
marked_for_delete (bool or None) – If this field is set to true, delete operation is triggered on the intent tree. This resource along with its all children in intent tree will be deleted. This is a cascade delete and should only be used if intent object along with its all children are to be deleted. This does not support deletion of single non-leaf node within the tree and should be used carefully.

property resource_type¶: Return the discriminator value

class com.vmware.nsx_policy.model_client.ChildSegmentSecurityProfile(segment_security_profile=None, links=None, schema=None, self_=None, revision=None, create_time=None, create_user=None, last_modified_time=None, last_modified_user=None, protection=None, system_owned=None, description=None, display_name=None, id=None, resource_type='ChildSegmentSecurityProfile', tags=None, marked_for_delete=None)¶

Bases: vmware.vapi.bindings.struct.VapiStruct

Child wrapper object for SegmentSecurityProfile, used in hierarchical API

Tip

The arguments are used to initialize data attributes with the same names.

Parameters

segment_security_profile (SegmentSecurityProfile) – Contains the actual SegmentSecurityProfile object
links (list of ResourceLink or None) – The server will populate this field when returing the resource. Ignored on PUT and POST. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
schema (str or None) – Schema for this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
self (SelfResourceLink or None) – Link to this resource
revision (long or None) – The _revision property describes the current revision of the resource. To prevent clients from overwriting each other’s changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected. format: int32
create_time (long or None) – Timestamp of resource creation format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
create_user (str or None) – ID of the user who created this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
last_modified_time (long or None) – Timestamp of last modification format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
last_modified_user (str or None) – ID of the user who last modified this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
protection (str or None) – Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super user and can modify it, but only when providing the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this entity. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
system_owned (bool or None) – Indicates system owned resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
description (str or None) – Description of this resource
display_name (str or None) – Defaults to ID if not set
id (str or None) – Unique identifier of this resource
resource_type (str) –
tags (list of Tag or None) – Opaque identifiers meaningful to the API user
marked_for_delete (bool or None) – If this field is set to true, delete operation is triggered on the intent tree. This resource along with its all children in intent tree will be deleted. This is a cascade delete and should only be used if intent object along with its all children are to be deleted. This does not support deletion of single non-leaf node within the tree and should be used carefully.

property resource_type¶: Return the discriminator value

class com.vmware.nsx_policy.model_client.ChildSegmentSecurityProfileBindingMap(segment_security_profile_binding_map=None, links=None, schema=None, self_=None, revision=None, create_time=None, create_user=None, last_modified_time=None, last_modified_user=None, protection=None, system_owned=None, description=None, display_name=None, id=None, resource_type='ChildSegmentSecurityProfileBindingMap', tags=None, marked_for_delete=None)¶

Bases: vmware.vapi.bindings.struct.VapiStruct

Child wrapper object for SegmentSecurityProfileBindingMap, used in hierarchical API

Tip

The arguments are used to initialize data attributes with the same names.

Parameters

segment_security_profile_binding_map (SegmentSecurityProfileBindingMap) – Contains the actual SegmentSecurityProfileBindingMap object
links (list of ResourceLink or None) – The server will populate this field when returing the resource. Ignored on PUT and POST. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
schema (str or None) – Schema for this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
self (SelfResourceLink or None) – Link to this resource
revision (long or None) – The _revision property describes the current revision of the resource. To prevent clients from overwriting each other’s changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected. format: int32
create_time (long or None) – Timestamp of resource creation format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
create_user (str or None) – ID of the user who created this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
last_modified_time (long or None) – Timestamp of last modification format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
last_modified_user (str or None) – ID of the user who last modified this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
protection (str or None) – Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super user and can modify it, but only when providing the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this entity. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
system_owned (bool or None) – Indicates system owned resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
description (str or None) – Description of this resource
display_name (str or None) – Defaults to ID if not set
id (str or None) – Unique identifier of this resource
resource_type (str) –
tags (list of Tag or None) – Opaque identifiers meaningful to the API user
marked_for_delete (bool or None) – If this field is set to true, delete operation is triggered on the intent tree. This resource along with its all children in intent tree will be deleted. This is a cascade delete and should only be used if intent object along with its all children are to be deleted. This does not support deletion of single non-leaf node within the tree and should be used carefully.

property resource_type¶: Return the discriminator value

class com.vmware.nsx_policy.model_client.ChildService(service=None, links=None, schema=None, self_=None, revision=None, create_time=None, create_user=None, last_modified_time=None, last_modified_user=None, protection=None, system_owned=None, description=None, display_name=None, id=None, resource_type='ChildService', tags=None, marked_for_delete=None)¶

Bases: vmware.vapi.bindings.struct.VapiStruct

Child wrapper object for Service, used in hierarchical API.

Tip

The arguments are used to initialize data attributes with the same names.

Parameters

service (Service) – Contains the actual Service object.
links (list of ResourceLink or None) – The server will populate this field when returing the resource. Ignored on PUT and POST. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
schema (str or None) – Schema for this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
self (SelfResourceLink or None) – Link to this resource
revision (long or None) – The _revision property describes the current revision of the resource. To prevent clients from overwriting each other’s changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected. format: int32
create_time (long or None) – Timestamp of resource creation format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
create_user (str or None) – ID of the user who created this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
last_modified_time (long or None) – Timestamp of last modification format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
last_modified_user (str or None) – ID of the user who last modified this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
protection (str or None) – Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super user and can modify it, but only when providing the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this entity. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
system_owned (bool or None) – Indicates system owned resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
description (str or None) – Description of this resource
display_name (str or None) – Defaults to ID if not set
id (str or None) – Unique identifier of this resource
resource_type (str) –
tags (list of Tag or None) – Opaque identifiers meaningful to the API user
marked_for_delete (bool or None) – If this field is set to true, delete operation is triggered on the intent tree. This resource along with its all children in intent tree will be deleted. This is a cascade delete and should only be used if intent object along with its all children are to be deleted. This does not support deletion of single non-leaf node within the tree and should be used carefully.

property resource_type¶: Return the discriminator value

class com.vmware.nsx_policy.model_client.ChildServiceEntry(service=None, service_entry=None, links=None, schema=None, self_=None, revision=None, create_time=None, create_user=None, last_modified_time=None, last_modified_user=None, protection=None, system_owned=None, description=None, display_name=None, id=None, resource_type='ChildServiceEntry', tags=None, marked_for_delete=None)¶

Bases: vmware.vapi.bindings.struct.VapiStruct

Child wrapper object for ServiceEntry, used in hierarchical API.

Tip

The arguments are used to initialize data attributes with the same names.

Parameters

service (vmware.vapi.struct.VapiStruct or None) – This is a deprecated property, Please use ‘ServiceEntry’ instead. When clients pass a value of this class as a parameter, the attribute must contain all the attributes defined in ServiceEntry. When methods return a value of this class as a return value, the attribute will contain all the attributes defined in ServiceEntry.
service_entry (vmware.vapi.struct.VapiStruct) – Contains the actual ServiceEntry object. When clients pass a value of this class as a parameter, the attribute must contain all the attributes defined in ServiceEntry. When methods return a value of this class as a return value, the attribute will contain all the attributes defined in ServiceEntry.
links (list of ResourceLink or None) – The server will populate this field when returing the resource. Ignored on PUT and POST. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
schema (str or None) – Schema for this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
self (SelfResourceLink or None) – Link to this resource
revision (long or None) – The _revision property describes the current revision of the resource. To prevent clients from overwriting each other’s changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected. format: int32
create_time (long or None) – Timestamp of resource creation format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
create_user (str or None) – ID of the user who created this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
last_modified_time (long or None) – Timestamp of last modification format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
last_modified_user (str or None) – ID of the user who last modified this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
protection (str or None) – Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super user and can modify it, but only when providing the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this entity. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
system_owned (bool or None) – Indicates system owned resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
description (str or None) – Description of this resource
display_name (str or None) – Defaults to ID if not set
id (str or None) – Unique identifier of this resource
resource_type (str) –
tags (list of Tag or None) – Opaque identifiers meaningful to the API user
marked_for_delete (bool or None) – If this field is set to true, delete operation is triggered on the intent tree. This resource along with its all children in intent tree will be deleted. This is a cascade delete and should only be used if intent object along with its all children are to be deleted. This does not support deletion of single non-leaf node within the tree and should be used carefully.

property resource_type¶: Return the discriminator value

class com.vmware.nsx_policy.model_client.ChildServiceInstanceEndpoint(service_instance_endpoint=None, links=None, schema=None, self_=None, revision=None, create_time=None, create_user=None, last_modified_time=None, last_modified_user=None, protection=None, system_owned=None, description=None, display_name=None, id=None, resource_type='ChildServiceInstanceEndpoint', tags=None, marked_for_delete=None)¶

Bases: vmware.vapi.bindings.struct.VapiStruct

Child wrapper object for ServiceInstanceEndpoint used in hierarchical API.

Tip

The arguments are used to initialize data attributes with the same names.

Parameters

service_instance_endpoint (ServiceInstanceEndpoint) – Contains actual ServiceInstanceEndpoint.
links (list of ResourceLink or None) – The server will populate this field when returing the resource. Ignored on PUT and POST. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
schema (str or None) – Schema for this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
self (SelfResourceLink or None) – Link to this resource
revision (long or None) – The _revision property describes the current revision of the resource. To prevent clients from overwriting each other’s changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected. format: int32
create_time (long or None) – Timestamp of resource creation format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
create_user (str or None) – ID of the user who created this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
last_modified_time (long or None) – Timestamp of last modification format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
last_modified_user (str or None) – ID of the user who last modified this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
protection (str or None) – Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super user and can modify it, but only when providing the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this entity. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
system_owned (bool or None) – Indicates system owned resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
description (str or None) – Description of this resource
display_name (str or None) – Defaults to ID if not set
id (str or None) – Unique identifier of this resource
resource_type (str) –
tags (list of Tag or None) – Opaque identifiers meaningful to the API user
marked_for_delete (bool or None) – If this field is set to true, delete operation is triggered on the intent tree. This resource along with its all children in intent tree will be deleted. This is a cascade delete and should only be used if intent object along with its all children are to be deleted. This does not support deletion of single non-leaf node within the tree and should be used carefully.

property resource_type¶: Return the discriminator value

class com.vmware.nsx_policy.model_client.ChildServiceInterface(service_interface=None, links=None, schema=None, self_=None, revision=None, create_time=None, create_user=None, last_modified_time=None, last_modified_user=None, protection=None, system_owned=None, description=None, display_name=None, id=None, resource_type='ChildServiceInterface', tags=None, marked_for_delete=None)¶

Bases: vmware.vapi.bindings.struct.VapiStruct

Child wrapper object for ServiceInterface, used in hierarchical API.

Tip

The arguments are used to initialize data attributes with the same names.

Parameters

service_interface (ServiceInterface) – Contains the actual ServiceInterface object.
links (list of ResourceLink or None) – The server will populate this field when returing the resource. Ignored on PUT and POST. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
schema (str or None) – Schema for this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
self (SelfResourceLink or None) – Link to this resource
revision (long or None) – The _revision property describes the current revision of the resource. To prevent clients from overwriting each other’s changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected. format: int32
create_time (long or None) – Timestamp of resource creation format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
create_user (str or None) – ID of the user who created this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
last_modified_time (long or None) – Timestamp of last modification format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
last_modified_user (str or None) – ID of the user who last modified this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
protection (str or None) – Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super user and can modify it, but only when providing the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this entity. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
system_owned (bool or None) – Indicates system owned resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
description (str or None) – Description of this resource
display_name (str or None) – Defaults to ID if not set
id (str or None) – Unique identifier of this resource
resource_type (str) –
tags (list of Tag or None) – Opaque identifiers meaningful to the API user
marked_for_delete (bool or None) – If this field is set to true, delete operation is triggered on the intent tree. This resource along with its all children in intent tree will be deleted. This is a cascade delete and should only be used if intent object along with its all children are to be deleted. This does not support deletion of single non-leaf node within the tree and should be used carefully.

property resource_type¶: Return the discriminator value

class com.vmware.nsx_policy.model_client.ChildServiceReference(service_reference=None, links=None, schema=None, self_=None, revision=None, create_time=None, create_user=None, last_modified_time=None, last_modified_user=None, protection=None, system_owned=None, description=None, display_name=None, id=None, resource_type='ChildServiceReference', tags=None, marked_for_delete=None)¶

Bases: vmware.vapi.bindings.struct.VapiStruct

Child wrapper object for ServiceReference used in hierarchical API.

Tip

The arguments are used to initialize data attributes with the same names.

Parameters

service_reference (ServiceReference) – Contains actual ServiceReference.
links (list of ResourceLink or None) – The server will populate this field when returing the resource. Ignored on PUT and POST. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
schema (str or None) – Schema for this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
self (SelfResourceLink or None) – Link to this resource
revision (long or None) – The _revision property describes the current revision of the resource. To prevent clients from overwriting each other’s changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected. format: int32
create_time (long or None) – Timestamp of resource creation format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
create_user (str or None) – ID of the user who created this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
last_modified_time (long or None) – Timestamp of last modification format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
last_modified_user (str or None) – ID of the user who last modified this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
protection (str or None) – Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super user and can modify it, but only when providing the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this entity. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
system_owned (bool or None) – Indicates system owned resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
description (str or None) – Description of this resource
display_name (str or None) – Defaults to ID if not set
id (str or None) – Unique identifier of this resource
resource_type (str) –
tags (list of Tag or None) – Opaque identifiers meaningful to the API user
marked_for_delete (bool or None) – If this field is set to true, delete operation is triggered on the intent tree. This resource along with its all children in intent tree will be deleted. This is a cascade delete and should only be used if intent object along with its all children are to be deleted. This does not support deletion of single non-leaf node within the tree and should be used carefully.

property resource_type¶: Return the discriminator value

class com.vmware.nsx_policy.model_client.ChildServiceSegment(service_segment=None, links=None, schema=None, self_=None, revision=None, create_time=None, create_user=None, last_modified_time=None, last_modified_user=None, protection=None, system_owned=None, description=None, display_name=None, id=None, resource_type='ChildServiceSegment', tags=None, marked_for_delete=None)¶

Bases: vmware.vapi.bindings.struct.VapiStruct

Child wrapper object for ServiceSegment, used in hierarchical API

Tip

The arguments are used to initialize data attributes with the same names.

Parameters

service_segment (ServiceSegment) – Contains the actual ServiceSegment objects
links (list of ResourceLink or None) – The server will populate this field when returing the resource. Ignored on PUT and POST. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
schema (str or None) – Schema for this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
self (SelfResourceLink or None) – Link to this resource
revision (long or None) – The _revision property describes the current revision of the resource. To prevent clients from overwriting each other’s changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected. format: int32
create_time (long or None) – Timestamp of resource creation format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
create_user (str or None) – ID of the user who created this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
last_modified_time (long or None) – Timestamp of last modification format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
last_modified_user (str or None) – ID of the user who last modified this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
protection (str or None) – Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super user and can modify it, but only when providing the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this entity. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
system_owned (bool or None) – Indicates system owned resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
description (str or None) – Description of this resource
display_name (str or None) – Defaults to ID if not set
id (str or None) – Unique identifier of this resource
resource_type (str) –
tags (list of Tag or None) – Opaque identifiers meaningful to the API user
marked_for_delete (bool or None) – If this field is set to true, delete operation is triggered on the intent tree. This resource along with its all children in intent tree will be deleted. This is a cascade delete and should only be used if intent object along with its all children are to be deleted. This does not support deletion of single non-leaf node within the tree and should be used carefully.

property resource_type¶: Return the discriminator value

class com.vmware.nsx_policy.model_client.ChildSessionTimerProfileBindingMap(session_timer_profile_binding_map=None, links=None, schema=None, self_=None, revision=None, create_time=None, create_user=None, last_modified_time=None, last_modified_user=None, protection=None, system_owned=None, description=None, display_name=None, id=None, resource_type='ChildSessionTimerProfileBindingMap', tags=None, marked_for_delete=None)¶

Bases: vmware.vapi.bindings.struct.VapiStruct

Child wrapper object for SessionTimerProfileBindingMap, used in hierarchical API

Tip

The arguments are used to initialize data attributes with the same names.

Parameters

session_timer_profile_binding_map (SessionTimerProfileBindingMap) – Contains the actual SessionTimerProfileBindingMap object
links (list of ResourceLink or None) – The server will populate this field when returing the resource. Ignored on PUT and POST. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
schema (str or None) – Schema for this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
self (SelfResourceLink or None) – Link to this resource
revision (long or None) – The _revision property describes the current revision of the resource. To prevent clients from overwriting each other’s changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected. format: int32
create_time (long or None) – Timestamp of resource creation format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
create_user (str or None) – ID of the user who created this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
last_modified_time (long or None) – Timestamp of last modification format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
last_modified_user (str or None) – ID of the user who last modified this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
protection (str or None) – Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super user and can modify it, but only when providing the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this entity. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
system_owned (bool or None) – Indicates system owned resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
description (str or None) – Description of this resource
display_name (str or None) – Defaults to ID if not set
id (str or None) – Unique identifier of this resource
resource_type (str) –
tags (list of Tag or None) – Opaque identifiers meaningful to the API user
marked_for_delete (bool or None) – If this field is set to true, delete operation is triggered on the intent tree. This resource along with its all children in intent tree will be deleted. This is a cascade delete and should only be used if intent object along with its all children are to be deleted. This does not support deletion of single non-leaf node within the tree and should be used carefully.

property resource_type¶: Return the discriminator value

class com.vmware.nsx_policy.model_client.ChildSite(site=None, links=None, schema=None, self_=None, revision=None, create_time=None, create_user=None, last_modified_time=None, last_modified_user=None, protection=None, system_owned=None, description=None, display_name=None, id=None, resource_type='ChildSite', tags=None, marked_for_delete=None)¶

Bases: vmware.vapi.bindings.struct.VapiStruct

Child wrapper object for Site, used in hierarchical API

Tip

The arguments are used to initialize data attributes with the same names.

Parameters

site (Site) – Contains the actual Site object
links (list of ResourceLink or None) – The server will populate this field when returing the resource. Ignored on PUT and POST. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
schema (str or None) – Schema for this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
self (SelfResourceLink or None) – Link to this resource
revision (long or None) – The _revision property describes the current revision of the resource. To prevent clients from overwriting each other’s changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected. format: int32
create_time (long or None) – Timestamp of resource creation format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
create_user (str or None) – ID of the user who created this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
last_modified_time (long or None) – Timestamp of last modification format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
last_modified_user (str or None) – ID of the user who last modified this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
protection (str or None) – Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super user and can modify it, but only when providing the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this entity. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
system_owned (bool or None) – Indicates system owned resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
description (str or None) – Description of this resource
display_name (str or None) – Defaults to ID if not set
id (str or None) – Unique identifier of this resource
resource_type (str) –
tags (list of Tag or None) – Opaque identifiers meaningful to the API user
marked_for_delete (bool or None) – If this field is set to true, delete operation is triggered on the intent tree. This resource along with its all children in intent tree will be deleted. This is a cascade delete and should only be used if intent object along with its all children are to be deleted. This does not support deletion of single non-leaf node within the tree and should be used carefully.

property resource_type¶: Return the discriminator value

class com.vmware.nsx_policy.model_client.ChildSpoofGuardProfile(spoof_guard_profile=None, links=None, schema=None, self_=None, revision=None, create_time=None, create_user=None, last_modified_time=None, last_modified_user=None, protection=None, system_owned=None, description=None, display_name=None, id=None, resource_type='ChildSpoofGuardProfile', tags=None, marked_for_delete=None)¶

Bases: vmware.vapi.bindings.struct.VapiStruct

Child wrapper object for SpoofGuardProfile, used in hierarchical API

Tip

The arguments are used to initialize data attributes with the same names.

Parameters

spoof_guard_profile (SpoofGuardProfile) – Contains the actual SpoofGuardProfile object
links (list of ResourceLink or None) – The server will populate this field when returing the resource. Ignored on PUT and POST. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
schema (str or None) – Schema for this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
self (SelfResourceLink or None) – Link to this resource
revision (long or None) – The _revision property describes the current revision of the resource. To prevent clients from overwriting each other’s changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected. format: int32
create_time (long or None) – Timestamp of resource creation format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
create_user (str or None) – ID of the user who created this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
last_modified_time (long or None) – Timestamp of last modification format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
last_modified_user (str or None) – ID of the user who last modified this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
protection (str or None) – Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super user and can modify it, but only when providing the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this entity. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
system_owned (bool or None) – Indicates system owned resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
description (str or None) – Description of this resource
display_name (str or None) – Defaults to ID if not set
id (str or None) – Unique identifier of this resource
resource_type (str) –
tags (list of Tag or None) – Opaque identifiers meaningful to the API user
marked_for_delete (bool or None) – If this field is set to true, delete operation is triggered on the intent tree. This resource along with its all children in intent tree will be deleted. This is a cascade delete and should only be used if intent object along with its all children are to be deleted. This does not support deletion of single non-leaf node within the tree and should be used carefully.

property resource_type¶: Return the discriminator value

class com.vmware.nsx_policy.model_client.ChildSslTrustObjectData(ssl_trust_object_data=None, links=None, schema=None, self_=None, revision=None, create_time=None, create_user=None, last_modified_time=None, last_modified_user=None, protection=None, system_owned=None, description=None, display_name=None, id=None, resource_type='ChildSslTrustObjectData', tags=None, marked_for_delete=None)¶

Bases: vmware.vapi.bindings.struct.VapiStruct

Child wrapper for SslTrustObjectData, used in hierarchical API

Tip

The arguments are used to initialize data attributes with the same names.

Parameters

ssl_trust_object_data (SslTrustObjectData) – Contains the actual SslTrustObjectData object
links (list of ResourceLink or None) – The server will populate this field when returing the resource. Ignored on PUT and POST. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
schema (str or None) – Schema for this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
self (SelfResourceLink or None) – Link to this resource
revision (long or None) – The _revision property describes the current revision of the resource. To prevent clients from overwriting each other’s changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected. format: int32
create_time (long or None) – Timestamp of resource creation format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
create_user (str or None) – ID of the user who created this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
last_modified_time (long or None) – Timestamp of last modification format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
last_modified_user (str or None) – ID of the user who last modified this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
protection (str or None) – Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super user and can modify it, but only when providing the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this entity. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
system_owned (bool or None) – Indicates system owned resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
description (str or None) – Description of this resource
display_name (str or None) – Defaults to ID if not set
id (str or None) – Unique identifier of this resource
resource_type (str) –
tags (list of Tag or None) – Opaque identifiers meaningful to the API user
marked_for_delete (bool or None) – If this field is set to true, delete operation is triggered on the intent tree. This resource along with its all children in intent tree will be deleted. This is a cascade delete and should only be used if intent object along with its all children are to be deleted. This does not support deletion of single non-leaf node within the tree and should be used carefully.

property resource_type¶: Return the discriminator value

class com.vmware.nsx_policy.model_client.ChildStandaloneHostIdfwConfiguration(standalone_host_idfw_configuration=None, links=None, schema=None, self_=None, revision=None, create_time=None, create_user=None, last_modified_time=None, last_modified_user=None, protection=None, system_owned=None, description=None, display_name=None, id=None, resource_type='ChildStandaloneHostIdfwConfiguration', tags=None, marked_for_delete=None)¶

Bases: vmware.vapi.bindings.struct.VapiStruct

Wrapper object for StandaloneHostIdfwConfiguration

Tip

The arguments are used to initialize data attributes with the same names.

Parameters

standalone_host_idfw_configuration (StandaloneHostIdfwConfiguration) – Contains the actual standalone host idfw configuration object.
links (list of ResourceLink or None) – The server will populate this field when returing the resource. Ignored on PUT and POST. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
schema (str or None) – Schema for this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
self (SelfResourceLink or None) – Link to this resource
revision (long or None) – The _revision property describes the current revision of the resource. To prevent clients from overwriting each other’s changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected. format: int32
create_time (long or None) – Timestamp of resource creation format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
create_user (str or None) – ID of the user who created this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
last_modified_time (long or None) – Timestamp of last modification format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
last_modified_user (str or None) – ID of the user who last modified this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
protection (str or None) – Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super user and can modify it, but only when providing the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this entity. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
system_owned (bool or None) – Indicates system owned resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
description (str or None) – Description of this resource
display_name (str or None) – Defaults to ID if not set
id (str or None) – Unique identifier of this resource
resource_type (str) –
tags (list of Tag or None) – Opaque identifiers meaningful to the API user
marked_for_delete (bool or None) – If this field is set to true, delete operation is triggered on the intent tree. This resource along with its all children in intent tree will be deleted. This is a cascade delete and should only be used if intent object along with its all children are to be deleted. This does not support deletion of single non-leaf node within the tree and should be used carefully.

property resource_type¶: Return the discriminator value

class com.vmware.nsx_policy.model_client.ChildStaticARPConfig(static_arp_config=None, links=None, schema=None, self_=None, revision=None, create_time=None, create_user=None, last_modified_time=None, last_modified_user=None, protection=None, system_owned=None, description=None, display_name=None, id=None, resource_type='ChildStaticARPConfig', tags=None, marked_for_delete=None)¶

Bases: vmware.vapi.bindings.struct.VapiStruct

Child wrapper object for StaticARPConfig, used in hierarchical API.

Tip

The arguments are used to initialize data attributes with the same names.

Parameters

static_arp_config (StaticARPConfig) – Contains the actual StaticARPConfig object.
links (list of ResourceLink or None) – The server will populate this field when returing the resource. Ignored on PUT and POST. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
schema (str or None) – Schema for this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
self (SelfResourceLink or None) – Link to this resource
revision (long or None) – The _revision property describes the current revision of the resource. To prevent clients from overwriting each other’s changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected. format: int32
create_time (long or None) – Timestamp of resource creation format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
create_user (str or None) – ID of the user who created this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
last_modified_time (long or None) – Timestamp of last modification format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
last_modified_user (str or None) – ID of the user who last modified this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
protection (str or None) – Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super user and can modify it, but only when providing the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this entity. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
system_owned (bool or None) – Indicates system owned resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
description (str or None) – Description of this resource
display_name (str or None) – Defaults to ID if not set
id (str or None) – Unique identifier of this resource
resource_type (str) –
tags (list of Tag or None) – Opaque identifiers meaningful to the API user
marked_for_delete (bool or None) – If this field is set to true, delete operation is triggered on the intent tree. This resource along with its all children in intent tree will be deleted. This is a cascade delete and should only be used if intent object along with its all children are to be deleted. This does not support deletion of single non-leaf node within the tree and should be used carefully.

property resource_type¶: Return the discriminator value

class com.vmware.nsx_policy.model_client.ChildStaticRoutes(static_routes=None, links=None, schema=None, self_=None, revision=None, create_time=None, create_user=None, last_modified_time=None, last_modified_user=None, protection=None, system_owned=None, description=None, display_name=None, id=None, resource_type='ChildStaticRoutes', tags=None, marked_for_delete=None)¶

Bases: vmware.vapi.bindings.struct.VapiStruct

Child wrapper object for StaticRoutes, used in hierarchical API.

Tip

The arguments are used to initialize data attributes with the same names.

Parameters

static_routes (StaticRoutes) – Contains the actual StaticRoutes object.
links (list of ResourceLink or None) – The server will populate this field when returing the resource. Ignored on PUT and POST. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
schema (str or None) – Schema for this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
self (SelfResourceLink or None) – Link to this resource
revision (long or None) – The _revision property describes the current revision of the resource. To prevent clients from overwriting each other’s changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected. format: int32
create_time (long or None) – Timestamp of resource creation format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
create_user (str or None) – ID of the user who created this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
last_modified_time (long or None) – Timestamp of last modification format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
last_modified_user (str or None) – ID of the user who last modified this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
protection (str or None) – Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super user and can modify it, but only when providing the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this entity. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
system_owned (bool or None) – Indicates system owned resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
description (str or None) – Description of this resource
display_name (str or None) – Defaults to ID if not set
id (str or None) – Unique identifier of this resource
resource_type (str) –
tags (list of Tag or None) – Opaque identifiers meaningful to the API user
marked_for_delete (bool or None) – If this field is set to true, delete operation is triggered on the intent tree. This resource along with its all children in intent tree will be deleted. This is a cascade delete and should only be used if intent object along with its all children are to be deleted. This does not support deletion of single non-leaf node within the tree and should be used carefully.

property resource_type¶: Return the discriminator value

class com.vmware.nsx_policy.model_client.ChildTier0(tier0=None, links=None, schema=None, self_=None, revision=None, create_time=None, create_user=None, last_modified_time=None, last_modified_user=None, protection=None, system_owned=None, description=None, display_name=None, id=None, resource_type='ChildTier0', tags=None, marked_for_delete=None)¶

Bases: vmware.vapi.bindings.struct.VapiStruct

Child wrapper object for Tier-0, used in hierarchical API.

Tip

The arguments are used to initialize data attributes with the same names.

Parameters

tier0 (Tier0) – Contains the actual Tier-0 object.
links (list of ResourceLink or None) – The server will populate this field when returing the resource. Ignored on PUT and POST. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
schema (str or None) – Schema for this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
self (SelfResourceLink or None) – Link to this resource
revision (long or None) – The _revision property describes the current revision of the resource. To prevent clients from overwriting each other’s changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected. format: int32
create_time (long or None) – Timestamp of resource creation format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
create_user (str or None) – ID of the user who created this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
last_modified_time (long or None) – Timestamp of last modification format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
last_modified_user (str or None) – ID of the user who last modified this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
protection (str or None) – Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super user and can modify it, but only when providing the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this entity. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
system_owned (bool or None) – Indicates system owned resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
description (str or None) – Description of this resource
display_name (str or None) – Defaults to ID if not set
id (str or None) – Unique identifier of this resource
resource_type (str) –
tags (list of Tag or None) – Opaque identifiers meaningful to the API user
marked_for_delete (bool or None) – If this field is set to true, delete operation is triggered on the intent tree. This resource along with its all children in intent tree will be deleted. This is a cascade delete and should only be used if intent object along with its all children are to be deleted. This does not support deletion of single non-leaf node within the tree and should be used carefully.

property resource_type¶: Return the discriminator value

class com.vmware.nsx_policy.model_client.ChildTier0DeploymentMap(tier0_deployment_map=None, links=None, schema=None, self_=None, revision=None, create_time=None, create_user=None, last_modified_time=None, last_modified_user=None, protection=None, system_owned=None, description=None, display_name=None, id=None, resource_type='ChildTier0DeploymentMap', tags=None, marked_for_delete=None)¶

Bases: vmware.vapi.bindings.struct.VapiStruct

Child wrapper object for Tier0DeploymentMap, used in hierarchical API

Tip

The arguments are used to initialize data attributes with the same names.

Parameters

tier0_deployment_map (Tier0DeploymentMap) – Contains the actual Tier0DeploymentMap object
links (list of ResourceLink or None) – The server will populate this field when returing the resource. Ignored on PUT and POST. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
schema (str or None) – Schema for this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
self (SelfResourceLink or None) – Link to this resource
revision (long or None) – The _revision property describes the current revision of the resource. To prevent clients from overwriting each other’s changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected. format: int32
create_time (long or None) – Timestamp of resource creation format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
create_user (str or None) – ID of the user who created this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
last_modified_time (long or None) – Timestamp of last modification format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
last_modified_user (str or None) – ID of the user who last modified this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
protection (str or None) – Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super user and can modify it, but only when providing the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this entity. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
system_owned (bool or None) – Indicates system owned resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
description (str or None) – Description of this resource
display_name (str or None) – Defaults to ID if not set
id (str or None) – Unique identifier of this resource
resource_type (str) –
tags (list of Tag or None) – Opaque identifiers meaningful to the API user
marked_for_delete (bool or None) – If this field is set to true, delete operation is triggered on the intent tree. This resource along with its all children in intent tree will be deleted. This is a cascade delete and should only be used if intent object along with its all children are to be deleted. This does not support deletion of single non-leaf node within the tree and should be used carefully.

property resource_type¶: Return the discriminator value

class com.vmware.nsx_policy.model_client.ChildTier0Interface(tier0_interface=None, links=None, schema=None, self_=None, revision=None, create_time=None, create_user=None, last_modified_time=None, last_modified_user=None, protection=None, system_owned=None, description=None, display_name=None, id=None, resource_type='ChildTier0Interface', tags=None, marked_for_delete=None)¶

Bases: vmware.vapi.bindings.struct.VapiStruct

Child wrapper object for Tier0Interface, used in hierarchical API.

Tip

The arguments are used to initialize data attributes with the same names.

Parameters

tier0_interface (Tier0Interface) – Contains the actual Tier0Interface object.
links (list of ResourceLink or None) – The server will populate this field when returing the resource. Ignored on PUT and POST. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
schema (str or None) – Schema for this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
self (SelfResourceLink or None) – Link to this resource
revision (long or None) – The _revision property describes the current revision of the resource. To prevent clients from overwriting each other’s changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected. format: int32
create_time (long or None) – Timestamp of resource creation format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
create_user (str or None) – ID of the user who created this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
last_modified_time (long or None) – Timestamp of last modification format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
last_modified_user (str or None) – ID of the user who last modified this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
protection (str or None) – Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super user and can modify it, but only when providing the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this entity. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
system_owned (bool or None) – Indicates system owned resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
description (str or None) – Description of this resource
display_name (str or None) – Defaults to ID if not set
id (str or None) – Unique identifier of this resource
resource_type (str) –
tags (list of Tag or None) – Opaque identifiers meaningful to the API user
marked_for_delete (bool or None) – If this field is set to true, delete operation is triggered on the intent tree. This resource along with its all children in intent tree will be deleted. This is a cascade delete and should only be used if intent object along with its all children are to be deleted. This does not support deletion of single non-leaf node within the tree and should be used carefully.

property resource_type¶: Return the discriminator value

class com.vmware.nsx_policy.model_client.ChildTier0RouteMap(tier0_route_map=None, links=None, schema=None, self_=None, revision=None, create_time=None, create_user=None, last_modified_time=None, last_modified_user=None, protection=None, system_owned=None, description=None, display_name=None, id=None, resource_type='ChildTier0RouteMap', tags=None, marked_for_delete=None)¶

Bases: vmware.vapi.bindings.struct.VapiStruct

Child wrapper object for Tier0RouteMap, used in hierarchical API

Tip

The arguments are used to initialize data attributes with the same names.

Parameters

tier0_route_map (Tier0RouteMap) – Contains the actual Tier0RouteMap object
links (list of ResourceLink or None) – The server will populate this field when returing the resource. Ignored on PUT and POST. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
schema (str or None) – Schema for this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
self (SelfResourceLink or None) – Link to this resource
revision (long or None) – The _revision property describes the current revision of the resource. To prevent clients from overwriting each other’s changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected. format: int32
create_time (long or None) – Timestamp of resource creation format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
create_user (str or None) – ID of the user who created this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
last_modified_time (long or None) – Timestamp of last modification format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
last_modified_user (str or None) – ID of the user who last modified this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
protection (str or None) – Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super user and can modify it, but only when providing the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this entity. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
system_owned (bool or None) – Indicates system owned resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
description (str or None) – Description of this resource
display_name (str or None) – Defaults to ID if not set
id (str or None) – Unique identifier of this resource
resource_type (str) –
tags (list of Tag or None) – Opaque identifiers meaningful to the API user
marked_for_delete (bool or None) – If this field is set to true, delete operation is triggered on the intent tree. This resource along with its all children in intent tree will be deleted. This is a cascade delete and should only be used if intent object along with its all children are to be deleted. This does not support deletion of single non-leaf node within the tree and should be used carefully.

property resource_type¶: Return the discriminator value

class com.vmware.nsx_policy.model_client.ChildTier1(tier1=None, links=None, schema=None, self_=None, revision=None, create_time=None, create_user=None, last_modified_time=None, last_modified_user=None, protection=None, system_owned=None, description=None, display_name=None, id=None, resource_type='ChildTier1', tags=None, marked_for_delete=None)¶

Bases: vmware.vapi.bindings.struct.VapiStruct

Child wrapper object for Tier-1 , used in hierarchical API.

Tip

The arguments are used to initialize data attributes with the same names.

Parameters

tier1 (Tier1) – Contains the actual Tier-1 object.
links (list of ResourceLink or None) – The server will populate this field when returing the resource. Ignored on PUT and POST. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
schema (str or None) – Schema for this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
self (SelfResourceLink or None) – Link to this resource
revision (long or None) – The _revision property describes the current revision of the resource. To prevent clients from overwriting each other’s changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected. format: int32
create_time (long or None) – Timestamp of resource creation format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
create_user (str or None) – ID of the user who created this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
last_modified_time (long or None) – Timestamp of last modification format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
last_modified_user (str or None) – ID of the user who last modified this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
protection (str or None) – Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super user and can modify it, but only when providing the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this entity. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
system_owned (bool or None) – Indicates system owned resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
description (str or None) – Description of this resource
display_name (str or None) – Defaults to ID if not set
id (str or None) – Unique identifier of this resource
resource_type (str) –
tags (list of Tag or None) – Opaque identifiers meaningful to the API user
marked_for_delete (bool or None) – If this field is set to true, delete operation is triggered on the intent tree. This resource along with its all children in intent tree will be deleted. This is a cascade delete and should only be used if intent object along with its all children are to be deleted. This does not support deletion of single non-leaf node within the tree and should be used carefully.

property resource_type¶: Return the discriminator value

class com.vmware.nsx_policy.model_client.ChildTier1DeploymentMap(tier1_deployment_map=None, links=None, schema=None, self_=None, revision=None, create_time=None, create_user=None, last_modified_time=None, last_modified_user=None, protection=None, system_owned=None, description=None, display_name=None, id=None, resource_type='ChildTier1DeploymentMap', tags=None, marked_for_delete=None)¶

Bases: vmware.vapi.bindings.struct.VapiStruct

Child wrapper object for Tier1DeploymentMap, used in hierarchical API.

Tip

The arguments are used to initialize data attributes with the same names.

Parameters

tier1_deployment_map (Tier1DeploymentMap) – Contains the actual Tier1DeploymentMap object
links (list of ResourceLink or None) – The server will populate this field when returing the resource. Ignored on PUT and POST. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
schema (str or None) – Schema for this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
self (SelfResourceLink or None) – Link to this resource
revision (long or None) – The _revision property describes the current revision of the resource. To prevent clients from overwriting each other’s changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected. format: int32
create_time (long or None) – Timestamp of resource creation format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
create_user (str or None) – ID of the user who created this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
last_modified_time (long or None) – Timestamp of last modification format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
last_modified_user (str or None) – ID of the user who last modified this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
protection (str or None) – Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super user and can modify it, but only when providing the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this entity. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
system_owned (bool or None) – Indicates system owned resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
description (str or None) – Description of this resource
display_name (str or None) – Defaults to ID if not set
id (str or None) – Unique identifier of this resource
resource_type (str) –
tags (list of Tag or None) – Opaque identifiers meaningful to the API user
marked_for_delete (bool or None) – If this field is set to true, delete operation is triggered on the intent tree. This resource along with its all children in intent tree will be deleted. This is a cascade delete and should only be used if intent object along with its all children are to be deleted. This does not support deletion of single non-leaf node within the tree and should be used carefully.

property resource_type¶: Return the discriminator value

class com.vmware.nsx_policy.model_client.ChildTier1Interface(tier1_interface=None, links=None, schema=None, self_=None, revision=None, create_time=None, create_user=None, last_modified_time=None, last_modified_user=None, protection=None, system_owned=None, description=None, display_name=None, id=None, resource_type='ChildTier1Interface', tags=None, marked_for_delete=None)¶

Bases: vmware.vapi.bindings.struct.VapiStruct

Child wrapper object for Tier1Interface, used in hierarchical API.

Tip

The arguments are used to initialize data attributes with the same names.

Parameters

tier1_interface (Tier1Interface) – Contains the actual Tier1Interface object.
links (list of ResourceLink or None) – The server will populate this field when returing the resource. Ignored on PUT and POST. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
schema (str or None) – Schema for this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
self (SelfResourceLink or None) – Link to this resource
revision (long or None) – The _revision property describes the current revision of the resource. To prevent clients from overwriting each other’s changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected. format: int32
create_time (long or None) – Timestamp of resource creation format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
create_user (str or None) – ID of the user who created this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
last_modified_time (long or None) – Timestamp of last modification format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
last_modified_user (str or None) – ID of the user who last modified this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
protection (str or None) – Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super user and can modify it, but only when providing the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this entity. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
system_owned (bool or None) – Indicates system owned resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
description (str or None) – Description of this resource
display_name (str or None) – Defaults to ID if not set
id (str or None) – Unique identifier of this resource
resource_type (str) –
tags (list of Tag or None) – Opaque identifiers meaningful to the API user
marked_for_delete (bool or None) – If this field is set to true, delete operation is triggered on the intent tree. This resource along with its all children in intent tree will be deleted. This is a cascade delete and should only be used if intent object along with its all children are to be deleted. This does not support deletion of single non-leaf node within the tree and should be used carefully.

property resource_type¶: Return the discriminator value

class com.vmware.nsx_policy.model_client.ChildTlsCertificate(tls_certificate=None, links=None, schema=None, self_=None, revision=None, create_time=None, create_user=None, last_modified_time=None, last_modified_user=None, protection=None, system_owned=None, description=None, display_name=None, id=None, resource_type='ChildTlsCertificate', tags=None, marked_for_delete=None)¶

Bases: vmware.vapi.bindings.struct.VapiStruct

Child wrapper for TlsCertificate, used in hierarchical API.

Tip

The arguments are used to initialize data attributes with the same names.

Parameters

tls_certificate (TlsCertificate) – Contains the actual TlsCertificate object.
links (list of ResourceLink or None) – The server will populate this field when returing the resource. Ignored on PUT and POST. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
schema (str or None) – Schema for this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
self (SelfResourceLink or None) – Link to this resource
revision (long or None) – The _revision property describes the current revision of the resource. To prevent clients from overwriting each other’s changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected. format: int32
create_time (long or None) – Timestamp of resource creation format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
create_user (str or None) – ID of the user who created this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
last_modified_time (long or None) – Timestamp of last modification format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
last_modified_user (str or None) – ID of the user who last modified this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
protection (str or None) – Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super user and can modify it, but only when providing the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this entity. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
system_owned (bool or None) – Indicates system owned resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
description (str or None) – Description of this resource
display_name (str or None) – Defaults to ID if not set
id (str or None) – Unique identifier of this resource
resource_type (str) –
tags (list of Tag or None) – Opaque identifiers meaningful to the API user
marked_for_delete (bool or None) – If this field is set to true, delete operation is triggered on the intent tree. This resource along with its all children in intent tree will be deleted. This is a cascade delete and should only be used if intent object along with its all children are to be deleted. This does not support deletion of single non-leaf node within the tree and should be used carefully.

property resource_type¶: Return the discriminator value

class com.vmware.nsx_policy.model_client.ChildTlsCrl(tls_crl=None, links=None, schema=None, self_=None, revision=None, create_time=None, create_user=None, last_modified_time=None, last_modified_user=None, protection=None, system_owned=None, description=None, display_name=None, id=None, resource_type='ChildTlsCrl', tags=None, marked_for_delete=None)¶

Bases: vmware.vapi.bindings.struct.VapiStruct

Child wrapper for TlsCrl, used in hierarchical API.

Tip

The arguments are used to initialize data attributes with the same names.

Parameters

tls_crl (TlsCrl) – Contains the actual TlsCrl object.
links (list of ResourceLink or None) – The server will populate this field when returing the resource. Ignored on PUT and POST. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
schema (str or None) – Schema for this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
self (SelfResourceLink or None) – Link to this resource
revision (long or None) – The _revision property describes the current revision of the resource. To prevent clients from overwriting each other’s changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected. format: int32
create_time (long or None) – Timestamp of resource creation format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
create_user (str or None) – ID of the user who created this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
last_modified_time (long or None) – Timestamp of last modification format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
last_modified_user (str or None) – ID of the user who last modified this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
protection (str or None) – Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super user and can modify it, but only when providing the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this entity. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
system_owned (bool or None) – Indicates system owned resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
description (str or None) – Description of this resource
display_name (str or None) – Defaults to ID if not set
id (str or None) – Unique identifier of this resource
resource_type (str) –
tags (list of Tag or None) – Opaque identifiers meaningful to the API user
marked_for_delete (bool or None) – If this field is set to true, delete operation is triggered on the intent tree. This resource along with its all children in intent tree will be deleted. This is a cascade delete and should only be used if intent object along with its all children are to be deleted. This does not support deletion of single non-leaf node within the tree and should be used carefully.

property resource_type¶: Return the discriminator value

class com.vmware.nsx_policy.model_client.ChildTlsTrustData(tls_trust_data=None, links=None, schema=None, self_=None, revision=None, create_time=None, create_user=None, last_modified_time=None, last_modified_user=None, protection=None, system_owned=None, description=None, display_name=None, id=None, resource_type='ChildTlsTrustData', tags=None, marked_for_delete=None)¶

Bases: vmware.vapi.bindings.struct.VapiStruct

Child wrapper for TlsTrustData, used in hierarchical API.

Tip

The arguments are used to initialize data attributes with the same names.

Parameters

tls_trust_data (TlsTrustData) – Contains the actual TlsTrustData object.
links (list of ResourceLink or None) – The server will populate this field when returing the resource. Ignored on PUT and POST. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
schema (str or None) – Schema for this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
self (SelfResourceLink or None) – Link to this resource
revision (long or None) – The _revision property describes the current revision of the resource. To prevent clients from overwriting each other’s changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected. format: int32
create_time (long or None) – Timestamp of resource creation format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
create_user (str or None) – ID of the user who created this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
last_modified_time (long or None) – Timestamp of last modification format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
last_modified_user (str or None) – ID of the user who last modified this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
protection (str or None) – Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super user and can modify it, but only when providing the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this entity. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
system_owned (bool or None) – Indicates system owned resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
description (str or None) – Description of this resource
display_name (str or None) – Defaults to ID if not set
id (str or None) – Unique identifier of this resource
resource_type (str) –
tags (list of Tag or None) – Opaque identifiers meaningful to the API user
marked_for_delete (bool or None) – If this field is set to true, delete operation is triggered on the intent tree. This resource along with its all children in intent tree will be deleted. This is a cascade delete and should only be used if intent object along with its all children are to be deleted. This does not support deletion of single non-leaf node within the tree and should be used carefully.

property resource_type¶: Return the discriminator value

class com.vmware.nsx_policy.model_client.ChildVirtualEndpoint(virtual_endpoint=None, links=None, schema=None, self_=None, revision=None, create_time=None, create_user=None, last_modified_time=None, last_modified_user=None, protection=None, system_owned=None, description=None, display_name=None, id=None, resource_type='ChildVirtualEndpoint', tags=None, marked_for_delete=None)¶

Bases: vmware.vapi.bindings.struct.VapiStruct

Child wrapper object for VirtualEndpoint used in hierarchical API.

Tip

The arguments are used to initialize data attributes with the same names.

Parameters

virtual_endpoint (VirtualEndpoint) – Contains reference to actual VirtualEndpoint.
links (list of ResourceLink or None) – The server will populate this field when returing the resource. Ignored on PUT and POST. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
schema (str or None) – Schema for this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
self (SelfResourceLink or None) – Link to this resource
revision (long or None) – The _revision property describes the current revision of the resource. To prevent clients from overwriting each other’s changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected. format: int32
create_time (long or None) – Timestamp of resource creation format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
create_user (str or None) – ID of the user who created this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
last_modified_time (long or None) – Timestamp of last modification format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
last_modified_user (str or None) – ID of the user who last modified this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
protection (str or None) – Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super user and can modify it, but only when providing the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this entity. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
system_owned (bool or None) – Indicates system owned resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
description (str or None) – Description of this resource
display_name (str or None) – Defaults to ID if not set
id (str or None) – Unique identifier of this resource
resource_type (str) –
tags (list of Tag or None) – Opaque identifiers meaningful to the API user
marked_for_delete (bool or None) – If this field is set to true, delete operation is triggered on the intent tree. This resource along with its all children in intent tree will be deleted. This is a cascade delete and should only be used if intent object along with its all children are to be deleted. This does not support deletion of single non-leaf node within the tree and should be used carefully.

property resource_type¶: Return the discriminator value

class com.vmware.nsx_policy.model_client.ColumnItem(column_identifier=None, drilldown_id=None, field=None, hidden=None, label=None, navigation=None, render_configuration=None, sort_ascending=None, sort_key=None, tooltip=None, type=None)¶

Bases: vmware.vapi.bindings.struct.VapiStruct

Represents a column of the Grid

Tip

The arguments are used to initialize data attributes with the same names.

Parameters

column_identifier (str or None) – Identifies the column and used for fetching content upon an user click or drilldown. If column identifier is not provided, the column’s data will not participate in searches and drilldowns.
drilldown_id (str or None) – Id of drilldown widget, if any. Id should be a valid id of an existing widget.
field (str) – Field from which values of the column will be derived.
hidden (bool or None) – If set to true, hides the column
label (Label) – Label of the column.
navigation (str or None) – Hyperlink of the specified UI page that provides details. If drilldown_id is provided, then navigation cannot be used.
render_configuration (list of RenderConfiguration or None) – Render configuration to be applied, if any.
sort_ascending (bool or None) – If true, the value of the column are sorted in ascending order. Otherwise, in descending order.
sort_key (str or None) – Sorting on column is based on the sort_key. sort_key represents the field in the output data on which sort is requested.
tooltip (list of Tooltip or None) – Multi-line text to be shown on tooltip while hovering over a cell in the grid.
type (str) –
Possible values are:
Data type of the field.

TYPE_DATE = 'Date'¶

TYPE_NUMBER = 'Number'¶

TYPE_STRING = 'String'¶

class com.vmware.nsx_policy.model_client.CommunicationEntry(links=None, schema=None, self_=None, revision=None, create_time=None, create_user=None, last_modified_time=None, last_modified_user=None, protection=None, system_owned=None, description=None, display_name=None, id=None, resource_type=None, tags=None, parent_path=None, path=None, relative_path=None, children=None, marked_for_delete=None, action=None, destination_groups=None, direction=None, disabled=None, logged=None, notes=None, scope=None, sequence_number=None, services=None, source_groups=None, tag=None)¶

Bases: vmware.vapi.bindings.struct.VapiStruct

A communication entry indicates the action to be performed for various types of traffic flowing between workload groups. This type is deprecated. Use the type Rule instead.

Tip

The arguments are used to initialize data attributes with the same names.

Parameters

links (list of ResourceLink or None) – The server will populate this field when returing the resource. Ignored on PUT and POST. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
schema (str or None) – Schema for this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
self (SelfResourceLink or None) – Link to this resource
revision (long or None) – The _revision property describes the current revision of the resource. To prevent clients from overwriting each other’s changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected. format: int32
create_time (long or None) – Timestamp of resource creation format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
create_user (str or None) – ID of the user who created this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
last_modified_time (long or None) – Timestamp of last modification format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
last_modified_user (str or None) – ID of the user who last modified this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
protection (str or None) – Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super user and can modify it, but only when providing the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this entity. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
system_owned (bool or None) – Indicates system owned resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
description (str or None) – Description of this resource
display_name (str or None) – Defaults to ID if not set
id (str or None) – Unique identifier of this resource
resource_type (str or None) – The type of this resource.
tags (list of Tag or None) – Opaque identifiers meaningful to the API user
parent_path (str or None) – Path of its parent This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
path (str or None) – Absolute path of this object This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
relative_path (str or None) – Path relative from its parent This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
children (list of vmware.vapi.struct.VapiStruct or None) – subtree for this type within policy tree containing nested elements. When clients pass a value of this class as a parameter, the attribute must contain all the attributes defined in ChildPolicyConfigResource. When methods return a value of this class as a return value, the attribute will contain all the attributes defined in ChildPolicyConfigResource.
marked_for_delete (bool or None) – Intent objects are not directly deleted from the system when a delete is invoked on them. They are marked for deletion and only when all the realized entities for that intent object gets deleted, the intent object is deleted. Objects that are marked for deletion are not returned in GET call. One can use the search API to get these objects. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
action (str or None) –
Possible values are:
- CommunicationEntry.ACTION_ALLOW
- CommunicationEntry.ACTION_DROP
- CommunicationEntry.ACTION_REJECT
The action to be applied to all the services.
destination_groups (list of str or None) – We need paths as duplicate names may exist for groups under different domains.In order to specify all groups, use the constant “ANY”. This is case insensitive. If “ANY” is used, it should be the ONLY element in the group array. Error will be thrown if ANY is used in conjunction with other values.
direction (str or None) –
Possible values are:
- CommunicationEntry.DIRECTION_IN
- CommunicationEntry.DIRECTION_OUT
- CommunicationEntry.DIRECTION_IN_OUT
Define direction of traffic.
disabled (bool or None) – Flag to disable the rule. Default is enabled.
logged (bool or None) – Flag to enable packet logging. Default is disabled.
notes (str or None) – Text for additional notes on changes.
scope (list of str or None) – The list of policy paths where the communication entry is applied Edge/LR/T0/T1/LRP/CGW/MGW/etc. Note that a given rule can be applied on multiple LRs/LRPs.
sequence_number (long or None) – This field is used to resolve conflicts between multiple CommunicationEntries under CommunicationMap for a Domain If no sequence number is specified in the payload, a value of 0 is assigned by default. If there are multiple communication entries with the same sequence number then their order is not deterministic. If a specific order of communication entry is desired, then one has to specify unique sequence numbers or use the POST request on the communication entry entity with a query parameter action=revise to let the framework assign a sequence number format: int32
services (list of str or None) – In order to specify all services, use the constant “ANY”. This is case insensitive. If “ANY” is used, it should be the ONLY element in the services array. Error will be thrown if ANY is used in conjunction with other values.
source_groups (list of str or None) – We need paths as duplicate names may exist for groups under different domains. In order to specify all groups, use the constant “ANY”. This is case insensitive. If “ANY” is used, it should be the ONLY element in the group array. Error will be thrown if ANY is used in conjunction with other values.
tag (str or None) – User level field which will be printed in CLI and packet logs.

ACTION_ALLOW = 'ALLOW'¶

ACTION_DROP = 'DROP'¶

ACTION_REJECT = 'REJECT'¶

DIRECTION_IN = 'IN'¶

DIRECTION_IN_OUT = 'IN_OUT'¶

DIRECTION_OUT = 'OUT'¶

class com.vmware.nsx_policy.model_client.CommunicationEntryListResult(links=None, schema=None, self_=None, cursor=None, result_count=None, sort_ascending=None, sort_by=None, results=None)¶

Bases: vmware.vapi.bindings.struct.VapiStruct

This type is deprecated. Use the type RuleListResult instead.

Tip

The arguments are used to initialize data attributes with the same names.

Parameters

links (list of ResourceLink or None) – The server will populate this field when returing the resource. Ignored on PUT and POST. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
schema (str or None) – Schema for this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
self (SelfResourceLink or None) – Link to this resource
cursor (str or None) – Opaque cursor to be used for getting next page of records (supplied by current result page) This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
result_count (long or None) – Count of results found (across all pages), set only on first page format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
sort_ascending (bool or None) – If true, results are sorted in ascending order This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
sort_by (str or None) – Field by which records are sorted This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
results (list of CommunicationEntry) – CommunicationEntry list results

class com.vmware.nsx_policy.model_client.CommunicationInsertParameters(anchor_path=None, operation=None)¶

Bases: vmware.vapi.bindings.struct.VapiStruct

Parameters to let the admin specify a relative position of a communication map or communication entry w.r.t to another one. This type is deprecated. Use the type RuleInsertParameters instead.

Tip

The arguments are used to initialize data attributes with the same names.

Parameters

anchor_path (str or None) – The communication map/communication entry path if operation is ‘insert_after’ or ‘insert_before’
operation (str or None) –
Possible values are:
Operation

OPERATION_AFTER = 'insert_after'¶

OPERATION_BEFORE = 'insert_before'¶

OPERATION_BOTTOM = 'insert_bottom'¶

OPERATION_TOP = 'insert_top'¶

class com.vmware.nsx_policy.model_client.CommunicationMap(links=None, schema=None, self_=None, revision=None, create_time=None, create_user=None, last_modified_time=None, last_modified_user=None, protection=None, system_owned=None, description=None, display_name=None, id=None, resource_type=None, tags=None, parent_path=None, path=None, relative_path=None, children=None, marked_for_delete=None, category=None, communication_entries=None, precedence=None)¶

Bases: vmware.vapi.bindings.struct.VapiStruct

Ordered list of CommunicationEntries. This object is created by default along with the Domain. This type is deprecated. Use the type SecurityPolicy instead.

Tip

The arguments are used to initialize data attributes with the same names.

Parameters

links (list of ResourceLink or None) – The server will populate this field when returing the resource. Ignored on PUT and POST. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
schema (str or None) – Schema for this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
self (SelfResourceLink or None) – Link to this resource
revision (long or None) – The _revision property describes the current revision of the resource. To prevent clients from overwriting each other’s changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected. format: int32
create_time (long or None) – Timestamp of resource creation format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
create_user (str or None) – ID of the user who created this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
last_modified_time (long or None) – Timestamp of last modification format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
last_modified_user (str or None) – ID of the user who last modified this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
protection (str or None) – Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super user and can modify it, but only when providing the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this entity. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
system_owned (bool or None) – Indicates system owned resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
description (str or None) – Description of this resource
display_name (str or None) – Defaults to ID if not set
id (str or None) – Unique identifier of this resource
resource_type (str or None) – The type of this resource.
tags (list of Tag or None) – Opaque identifiers meaningful to the API user
parent_path (str or None) – Path of its parent This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
path (str or None) – Absolute path of this object This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
relative_path (str or None) – Path relative from its parent This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
children (list of vmware.vapi.struct.VapiStruct or None) – subtree for this type within policy tree containing nested elements. When clients pass a value of this class as a parameter, the attribute must contain all the attributes defined in ChildPolicyConfigResource. When methods return a value of this class as a return value, the attribute will contain all the attributes defined in ChildPolicyConfigResource.
marked_for_delete (bool or None) – Intent objects are not directly deleted from the system when a delete is invoked on them. They are marked for deletion and only when all the realized entities for that intent object gets deleted, the intent object is deleted. Objects that are marked for deletion are not returned in GET call. One can use the search API to get these objects. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
category (str or None) –
- Distributed Firewall - Policy framework for Distributed Firewall
provides four pre-defined categories for classifying a communication map. They are “Emergency”, “Infrastructure”, “Environment” and “Application”. Amongst the layer 3 communication maps,there is a pre-determined order in which the policy framework manages the priority of these communication maps. Emergency category has the highest priority followed by Infrastructure, Environment and then Application rules. Administrator can choose to categorize a communication map into the above categories or can choose to leave it empty. If empty it will have the least precedence w.r.t the above four layer 3 categories.
communication_entries (list of CommunicationEntry or None) – CommunicationEntries that are a part of this CommunicationMap
precedence (long or None) – This field is used to resolve conflicts between communication maps across domains. In order to change the precedence of a communication map one can fire a POST request on the communication map entity with a query parameter action=revise The precedence field will reflect the value of the computed precedence upon execution of the above mentioned POST request. For scenarios where the administrator is using a template to update several communication maps, the only way to set the precedence is to explicitly specify the precedence number for each communication map. If no precedence is specified in the payload, a value of 0 is assigned by default. If there are multiple communication maps with the same precedence then their order is not deterministic. If a specific order of communication map is desired, then one has to specify a unique precedence or use the POST request on the communication map entity with a query parameter action=revise to let the framework assign a precedence format: int32

class com.vmware.nsx_policy.model_client.CommunicationMapListResult(links=None, schema=None, self_=None, cursor=None, result_count=None, sort_ascending=None, sort_by=None, results=None)¶

Bases: vmware.vapi.bindings.struct.VapiStruct

This type is deprecated. Use the type SecurityPolicyListResult instead.

Tip

The arguments are used to initialize data attributes with the same names.

Parameters

links (list of ResourceLink or None) – The server will populate this field when returing the resource. Ignored on PUT and POST. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
schema (str or None) – Schema for this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
self (SelfResourceLink or None) – Link to this resource
cursor (str or None) – Opaque cursor to be used for getting next page of records (supplied by current result page) This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
result_count (long or None) – Count of results found (across all pages), set only on first page format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
sort_ascending (bool or None) – If true, results are sorted in ascending order This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
sort_by (str or None) – Field by which records are sorted This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
results (list of CommunicationMap) – CommunicationMap list results

class com.vmware.nsx_policy.model_client.CommunityList(links=None, schema=None, self_=None, revision=None, create_time=None, create_user=None, last_modified_time=None, last_modified_user=None, protection=None, system_owned=None, description=None, display_name=None, id=None, resource_type=None, tags=None, parent_path=None, path=None, relative_path=None, children=None, marked_for_delete=None, communities=None)¶

Bases: vmware.vapi.bindings.struct.VapiStruct

Community list for BGP routing configuration

Tip

The arguments are used to initialize data attributes with the same names.

Parameters

links (list of ResourceLink or None) – The server will populate this field when returing the resource. Ignored on PUT and POST. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
schema (str or None) – Schema for this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
self (SelfResourceLink or None) – Link to this resource
revision (long or None) – The _revision property describes the current revision of the resource. To prevent clients from overwriting each other’s changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected. format: int32
create_time (long or None) – Timestamp of resource creation format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
create_user (str or None) – ID of the user who created this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
last_modified_time (long or None) – Timestamp of last modification format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
last_modified_user (str or None) – ID of the user who last modified this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
protection (str or None) – Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super user and can modify it, but only when providing the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this entity. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
system_owned (bool or None) – Indicates system owned resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
description (str or None) – Description of this resource
display_name (str or None) – Defaults to ID if not set
id (str or None) – Unique identifier of this resource
resource_type (str or None) – The type of this resource.
tags (list of Tag or None) – Opaque identifiers meaningful to the API user
parent_path (str or None) – Path of its parent This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
path (str or None) – Absolute path of this object This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
relative_path (str or None) – Path relative from its parent This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
children (list of vmware.vapi.struct.VapiStruct or None) – subtree for this type within policy tree containing nested elements. When clients pass a value of this class as a parameter, the attribute must contain all the attributes defined in ChildPolicyConfigResource. When methods return a value of this class as a return value, the attribute will contain all the attributes defined in ChildPolicyConfigResource.
marked_for_delete (bool or None) – Intent objects are not directly deleted from the system when a delete is invoked on them. They are marked for deletion and only when all the realized entities for that intent object gets deleted, the intent object is deleted. Objects that are marked for deletion are not returned in GET call. One can use the search API to get these objects. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
communities (list of str) – List of BGP community entries. Both standard and large communities are supported. Standard community format: aa:nn where aa and nn must be within the range [1 - 65536]. Large BGP Community format: aa:bb:nn where aa (Global Administrator), bb (Local Data Part 1) and nn (Local Data Part 2) must be within the range [1 - 4294967295]. In additon to numbered communites (e.g. 3356:2040), predefined communities (NO_EXPORT, NO_ADVERTISE, NO_EXPORT_SUBCONFED) are supported.

class com.vmware.nsx_policy.model_client.CommunityListListResult(links=None, schema=None, self_=None, cursor=None, result_count=None, sort_ascending=None, sort_by=None, results=None)¶

Bases: vmware.vapi.bindings.struct.VapiStruct

Paged collection of CommunityLists

Tip

The arguments are used to initialize data attributes with the same names.

Parameters

links (list of ResourceLink or None) – The server will populate this field when returing the resource. Ignored on PUT and POST. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
schema (str or None) – Schema for this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
self (SelfResourceLink or None) – Link to this resource
cursor (str or None) – Opaque cursor to be used for getting next page of records (supplied by current result page) This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
result_count (long or None) – Count of results found (across all pages), set only on first page format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
sort_ascending (bool or None) – If true, results are sorted in ascending order This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
sort_by (str or None) – Field by which records are sorted This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
results (list of CommunityList) – CommunityList results

class com.vmware.nsx_policy.model_client.CommunityMatchCriteria(criteria=None, match_operator=None)¶

Bases: vmware.vapi.bindings.struct.VapiStruct

Match criteria based on a community list

Tip

The arguments are used to initialize data attributes with the same names.

Parameters

criteria (str) – Match criteria specified as a community list path or a regular expression.
match_operator (str or None) –
Possible values are:
Match operator for community list entries. Not valid when a regular expression is specified for criteria.

MATCH_OPERATOR_ALL = 'MATCH_ALL'¶

MATCH_OPERATOR_ANY = 'MATCH_ANY'¶

MATCH_OPERATOR_COMMUNITY_REGEX = 'MATCH_COMMUNITY_REGEX'¶

MATCH_OPERATOR_EXACT = 'MATCH_EXACT'¶

MATCH_OPERATOR_LARGE_COMMUNITY_REGEX = 'MATCH_LARGE_COMMUNITY_REGEX'¶

class com.vmware.nsx_policy.model_client.ComputeClusterIdfwConfiguration(links=None, schema=None, self_=None, revision=None, create_time=None, create_user=None, last_modified_time=None, last_modified_user=None, protection=None, system_owned=None, description=None, display_name=None, id=None, resource_type=None, tags=None, parent_path=None, path=None, relative_path=None, children=None, marked_for_delete=None, cluster_idfw_enabled=None, member=None)¶

Bases: vmware.vapi.bindings.struct.VapiStruct

Idfw configuration for enable/disable idfw on cluster level.

Tip

The arguments are used to initialize data attributes with the same names.

Parameters

links (list of ResourceLink or None) – The server will populate this field when returing the resource. Ignored on PUT and POST. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
schema (str or None) – Schema for this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
self (SelfResourceLink or None) – Link to this resource
revision (long or None) – The _revision property describes the current revision of the resource. To prevent clients from overwriting each other’s changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected. format: int32
create_time (long or None) – Timestamp of resource creation format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
create_user (str or None) – ID of the user who created this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
last_modified_time (long or None) – Timestamp of last modification format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
last_modified_user (str or None) – ID of the user who last modified this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
protection (str or None) – Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super user and can modify it, but only when providing the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this entity. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
system_owned (bool or None) – Indicates system owned resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
description (str or None) – Description of this resource
display_name (str or None) – Defaults to ID if not set
id (str or None) – Unique identifier of this resource
resource_type (str or None) – The type of this resource.
tags (list of Tag or None) – Opaque identifiers meaningful to the API user
parent_path (str or None) – Path of its parent This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
path (str or None) – Absolute path of this object This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
relative_path (str or None) – Path relative from its parent This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
children (list of vmware.vapi.struct.VapiStruct or None) – subtree for this type within policy tree containing nested elements. When clients pass a value of this class as a parameter, the attribute must contain all the attributes defined in ChildPolicyConfigResource. When methods return a value of this class as a return value, the attribute will contain all the attributes defined in ChildPolicyConfigResource.
marked_for_delete (bool or None) – Intent objects are not directly deleted from the system when a delete is invoked on them. They are marked for deletion and only when all the realized entities for that intent object gets deleted, the intent object is deleted. Objects that are marked for deletion are not returned in GET call. One can use the search API to get these objects. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
cluster_idfw_enabled (bool) – If set to true, idfw is enabled for this cluster
member (PolicyResourceReference) – Contains actual policy resource reference object

class com.vmware.nsx_policy.model_client.ComputeClusterIdfwConfigurationListResult(links=None, schema=None, self_=None, cursor=None, result_count=None, sort_ascending=None, sort_by=None, results=None)¶

Bases: vmware.vapi.bindings.struct.VapiStruct

Paged collection of compute cluster idfw configuration

Tip

The arguments are used to initialize data attributes with the same names.

Parameters

links (list of ResourceLink or None) – The server will populate this field when returing the resource. Ignored on PUT and POST. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
schema (str or None) – Schema for this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
self (SelfResourceLink or None) – Link to this resource
cursor (str or None) – Opaque cursor to be used for getting next page of records (supplied by current result page) This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
result_count (long or None) – Count of results found (across all pages), set only on first page format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
sort_ascending (bool or None) – If true, results are sorted in ascending order This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
sort_by (str or None) – Field by which records are sorted This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
results (list of ComputeClusterIdfwConfiguration) – Compute cluster wise identity firewall configuration list results

class com.vmware.nsx_policy.model_client.ComputeCollection(cm_local_id=None, external_id=None, origin_id=None, origin_properties=None, origin_type=None, owner_id=None, links=None, schema=None, self_=None, last_sync_time=None, description=None, display_name=None, resource_type=None, tags=None)¶

Bases: vmware.vapi.bindings.struct.VapiStruct

Tip

The arguments are used to initialize data attributes with the same names.

Parameters

cm_local_id (str or None) – Local Id of the compute collection in the Compute Manager This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
external_id (str or None) – External ID of the ComputeCollection in the source Compute manager, e.g. mo-ref in VC This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
origin_id (str or None) – Id of the compute manager from where this Compute Collection was discovered This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
origin_properties (list of KeyValuePair or None) – Key-Value map of additional specific properties of compute collection in the Compute Manager This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
origin_type (str or None) – ComputeCollection type like VC_Cluster. Here the Compute Manager type prefix would help in differentiating similar named Compute Collection types from different Compute Managers This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
owner_id (str or None) – Id of the owner of compute collection in the Compute Manager This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
links (list of ResourceLink or None) – The server will populate this field when returing the resource. Ignored on PUT and POST. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
schema (str or None) – Schema for this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
self (SelfResourceLink or None) – Link to this resource
last_sync_time (long or None) – Timestamp of last modification format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
description (str or None) – Description of this resource
display_name (str or None) – Defaults to ID if not set
resource_type (str) – The type of this resource.
tags (list of Tag or None) – Opaque identifiers meaningful to the API user

property resource_type¶: Return the discriminator value

class com.vmware.nsx_policy.model_client.Condition(key=None, member_type=None, operator=None, value=None, links=None, schema=None, self_=None, revision=None, create_time=None, create_user=None, last_modified_time=None, last_modified_user=None, protection=None, system_owned=None, description=None, display_name=None, id=None, resource_type='Condition', tags=None, parent_path=None, path=None, relative_path=None, children=None, marked_for_delete=None)¶

Bases: vmware.vapi.bindings.struct.VapiStruct

Represents the leaf level condition.

Tip

The arguments are used to initialize data attributes with the same names.

Parameters

key (str) –
Possible values are:
- Condition.KEY_TAG
- Condition.KEY_NAME
- Condition.KEY_OSNAME
- Condition.KEY_COMPUTERNAME
Key
member_type (str) –
Possible values are:
- Condition.MEMBER_TYPE_IPSET
- Condition.MEMBER_TYPE_VIRTUALMACHINE
- Condition.MEMBER_TYPE_LOGICALPORT
- Condition.MEMBER_TYPE_LOGICALSWITCH
- Condition.MEMBER_TYPE_SEGMENT
- Condition.MEMBER_TYPE_SEGMENTPORT
Group member type
operator (str) –
Possible values are:
- Condition.OPERATOR_EQUALS
- Condition.OPERATOR_CONTAINS
- Condition.OPERATOR_STARTSWITH
- Condition.OPERATOR_ENDSWITH
- Condition.OPERATOR_NOTEQUALS
operator
value (str) – Value
links (list of ResourceLink or None) – The server will populate this field when returing the resource. Ignored on PUT and POST. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
schema (str or None) – Schema for this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
self (SelfResourceLink or None) – Link to this resource
revision (long or None) – The _revision property describes the current revision of the resource. To prevent clients from overwriting each other’s changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected. format: int32
create_time (long or None) – Timestamp of resource creation format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
create_user (str or None) – ID of the user who created this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
last_modified_time (long or None) – Timestamp of last modification format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
last_modified_user (str or None) – ID of the user who last modified this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
protection (str or None) – Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super user and can modify it, but only when providing the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this entity. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
system_owned (bool or None) – Indicates system owned resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
description (str or None) – Description of this resource
display_name (str or None) – Defaults to ID if not set
id (str or None) – Unique identifier of this resource
resource_type (str) –
Possible values are:
- Expression.RESOURCE_TYPE_CONDITION
- Expression.RESOURCE_TYPE_CONJUNCTIONOPERATOR
- Expression.RESOURCE_TYPE_NESTEDEXPRESSION
- Expression.RESOURCE_TYPE_IPADDRESSEXPRESSION
- Expression.RESOURCE_TYPE_MACADDRESSEXPRESSION
- Expression.RESOURCE_TYPE_EXTERNALIDEXPRESSION
- Expression.RESOURCE_TYPE_PATHEXPRESSION
- Expression.RESOURCE_TYPE_IDENTITYGROUPEXPRESSION
tags (list of Tag or None) – Opaque identifiers meaningful to the API user
parent_path (str or None) – Path of its parent This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
path (str or None) – Absolute path of this object This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
relative_path (str or None) – Path relative from its parent This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
children (list of vmware.vapi.struct.VapiStruct or None) – subtree for this type within policy tree containing nested elements. When clients pass a value of this class as a parameter, the attribute must contain all the attributes defined in ChildPolicyConfigResource. When methods return a value of this class as a return value, the attribute will contain all the attributes defined in ChildPolicyConfigResource.
marked_for_delete (bool or None) – Intent objects are not directly deleted from the system when a delete is invoked on them. They are marked for deletion and only when all the realized entities for that intent object gets deleted, the intent object is deleted. Objects that are marked for deletion are not returned in GET call. One can use the search API to get these objects. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.

KEY_COMPUTERNAME = 'ComputerName'¶

KEY_NAME = 'Name'¶

KEY_OSNAME = 'OSName'¶

KEY_TAG = 'Tag'¶

MEMBER_TYPE_IPSET = 'IPSet'¶

MEMBER_TYPE_LOGICALPORT = 'LogicalPort'¶

MEMBER_TYPE_LOGICALSWITCH = 'LogicalSwitch'¶

MEMBER_TYPE_SEGMENT = 'Segment'¶

MEMBER_TYPE_SEGMENTPORT = 'SegmentPort'¶

MEMBER_TYPE_VIRTUALMACHINE = 'VirtualMachine'¶

OPERATOR_CONTAINS = 'CONTAINS'¶

OPERATOR_ENDSWITH = 'ENDSWITH'¶

OPERATOR_EQUALS = 'EQUALS'¶

OPERATOR_NOTEQUALS = 'NOTEQUALS'¶

OPERATOR_STARTSWITH = 'STARTSWITH'¶

property resource_type¶: Return the discriminator value

class com.vmware.nsx_policy.model_client.ConditionalValueConstraintExpression(operator=None, rhs_value=None, value_constraint=None)¶

Bases: vmware.vapi.bindings.struct.VapiStruct

Represents the leaf level expression to restrict the target attribute value based on the set of existing values. Generally, used in combination with RelatedAttributeConditionalExpression to constraint the values related to another attribute on the same resource. This object is always used in conjunction with some exression. Example - { “condition” : { “operator”:”INCLUDES”, “rhs_value”: [“/infra/domains/mgw/groups/VCENTER”, “/infra/domains/mgw/groups/SRM”, “/infra/domains/mgw/groups/NSX”], “value_constraint”: { “resource_type”: “ValueConstraintExpression”, “operator”:”EXCLUDES”, “values”:[“/infra/domains/mgw/groups/VCENTER”, “/infra/domains/mgw/groups/SRM”, “/infra/domains/mgw/groups/NSX”] } }

Tip

The arguments are used to initialize data attributes with the same names.

Parameters

operator (str) –
Possible values are:
Set operation to constraint values.
rhs_value (list of str) – List of values.
value_constraint (ValueConstraintExpression) – Values to apply the conditional constraint on target.

OPERATOR_EQUALS = 'EQUALS'¶

OPERATOR_EXCLUDES = 'EXCLUDES'¶

OPERATOR_INCLUDES = 'INCLUDES'¶

class com.vmware.nsx_policy.model_client.ConfigurationState(details=None, failure_code=None, failure_message=None, state=None)¶

Bases: vmware.vapi.bindings.struct.VapiStruct

Describes status of configuration of an entity

Tip

The arguments are used to initialize data attributes with the same names.

Parameters

details (list of ConfigurationStateElement or None) – Array of configuration state of various sub systems This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
failure_code (long or None) – Error code format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
failure_message (str or None) – Error message in case of failure This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
state (str or None) –
Possible values are:
Gives details of state of desired configuration. Additional enums with more details on progress/success/error states are sent for edge node. The success states are NODE_READY and TRANSPORT_NODE_READY, pending states are {VM_DEPLOYMENT_QUEUED, VM_DEPLOYMENT_IN_PROGRESS, REGISTRATION_PENDING} and other values indicate failures. “in_sync” state indicates that the desired configuration has been received by the host to which it applies, but is not yet in effect. When the configuration is actually in effect, the state will change to “success”. Please note, failed state is deprecated. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.

STATE_APPLIANCE_INTERNAL_ERROR = 'APPLIANCE_INTERNAL_ERROR'¶

STATE_EDGE_CONFIG_ERROR = 'EDGE_CONFIG_ERROR'¶

STATE_EDGE_HARDWARE_NOT_SUPPORTED = 'EDGE_HARDWARE_NOT_SUPPORTED'¶

STATE_EDGE_NODE_VERSION_NOT_SUPPORTED = 'EDGE_NODE_VERSION_NOT_SUPPORTED'¶

STATE_ERROR = 'error'¶

STATE_FAILED = 'failed'¶

STATE_HOSTSWITCH_PROFILE_NOT_FOUND = 'HOSTSWITCH_PROFILE_NOT_FOUND'¶

STATE_INVALID_PNIC_DEVICE_NAME = 'INVALID_PNIC_DEVICE_NAME'¶

STATE_IN_PROGRESS = 'in_progress'¶

STATE_IN_SYNC = 'in_sync'¶

STATE_LACP_NOT_SUPPORTED_FOR_EDGE_VM = 'LACP_NOT_SUPPORTED_FOR_EDGE_VM'¶

STATE_LBSRCID_NOT_SUPPORTED_FOR_EDGE_VM = 'LBSRCID_NOT_SUPPORTED_FOR_EDGE_VM'¶

STATE_LLDP_SEND_ENABLED_NOT_SUPPORTED = 'LLDP_SEND_ENABLED_NOT_SUPPORTED'¶

STATE_MPA_DISCONNECTED = 'MPA_DISCONNECTED'¶

STATE_MULTIPLE_ACTIVE_UPLINKS_NOT_SUPPORTED_FOR_EDGE = 'MULTIPLE_ACTIVE_UPLINKS_NOT_SUPPORTED_FOR_EDGE'¶

STATE_MULTIPLE_OVERLAY_TZS_NOT_SUPPORTED = 'MULTIPLE_OVERLAY_TZS_NOT_SUPPORTED'¶

STATE_NODE_NOT_READY = 'NODE_NOT_READY'¶

STATE_NODE_READY = 'NODE_READY'¶

STATE_NOT_AVAILABLE = 'NOT_AVAILABLE'¶

STATE_NO_PNIC_PREPARED_IN_EDGE = 'NO_PNIC_PREPARED_IN_EDGE'¶

STATE_NO_PNIC_SPECIFIED_IN_TN = 'NO_PNIC_SPECIFIED_IN_TN'¶

STATE_ORPHANED = 'orphaned'¶

STATE_PARTIAL_SUCCESS = 'partial_success'¶

STATE_PENDING = 'pending'¶

STATE_REGISTRATION_FAILED = 'REGISTRATION_FAILED'¶

STATE_REGISTRATION_PENDING = 'REGISTRATION_PENDING'¶

STATE_STANDBY_UPLINKS_NOT_SUPPORTED_FOR_EDGE_VM = 'STANDBY_UPLINKS_NOT_SUPPORTED_FOR_EDGE_VM'¶

STATE_SUCCESS = 'success'¶

STATE_TN_OVERLAY_TZ_IN_USE_BY_EDGE_CLUSTER = 'TN_OVERLAY_TZ_IN_USE_BY_EDGE_CLUSTER'¶

STATE_TRANSPORT_NODE_CONFIGURATION_MISSING = 'TRANSPORT_NODE_CONFIGURATION_MISSING'¶

STATE_TRANSPORT_NODE_READY = 'TRANSPORT_NODE_READY'¶

STATE_TRANSPORT_NODE_SYNC_PENDING = 'TRANSPORT_NODE_SYNC_PENDING'¶

STATE_TZ_ENDPOINTS_NOT_SPECIFIED = 'TZ_ENDPOINTS_NOT_SPECIFIED'¶

STATE_UNKNOWN = 'unknown'¶

STATE_UNSUPPORTED_DEFAULT_TEAMING_POLICY = 'UNSUPPORTED_DEFAULT_TEAMING_POLICY'¶

STATE_UNSUPPORTED_HOST_SWITCH_PROFILE = 'UNSUPPORTED_HOST_SWITCH_PROFILE'¶

STATE_UNSUPPORTED_LACP_LB_ALGO_FOR_NODE = 'UNSUPPORTED_LACP_LB_ALGO_FOR_NODE'¶

STATE_UNSUPPORTED_NAMED_TEAMING_POLICY = 'UNSUPPORTED_NAMED_TEAMING_POLICY'¶

STATE_UPLINK_HOST_SWITCH_PROFILE_NOT_SPECIFIED = 'UPLINK_HOST_SWITCH_PROFILE_NOT_SPECIFIED'¶

STATE_VM_CONFIG_DISCREPANCY = 'VM_CONFIG_DISCREPANCY'¶

STATE_VM_CONFIG_EDIT_FAILED = 'VM_CONFIG_EDIT_FAILED'¶

STATE_VM_CONFIG_EDIT_PENDING = 'VM_CONFIG_EDIT_PENDING'¶

STATE_VM_DEPLOYMENT_FAILED = 'VM_DEPLOYMENT_FAILED'¶

STATE_VM_DEPLOYMENT_IN_PROGRESS = 'VM_DEPLOYMENT_IN_PROGRESS'¶

STATE_VM_DEPLOYMENT_QUEUED = 'VM_DEPLOYMENT_QUEUED'¶

STATE_VM_DEPLOYMENT_RESTARTED = 'VM_DEPLOYMENT_RESTARTED'¶

STATE_VM_NETWORK_EDIT_FAILED = 'VM_NETWORK_EDIT_FAILED'¶

STATE_VM_NETWORK_EDIT_PENDING = 'VM_NETWORK_EDIT_PENDING'¶

STATE_VM_NODE_REFRESH_FAILED = 'VM_NODE_REFRESH_FAILED'¶

STATE_VM_PLACEMENT_REFRESH_FAILED = 'VM_PLACEMENT_REFRESH_FAILED'¶

STATE_VM_POWER_OFF_FAILED = 'VM_POWER_OFF_FAILED'¶

STATE_VM_POWER_OFF_IN_PROGRESS = 'VM_POWER_OFF_IN_PROGRESS'¶

STATE_VM_POWER_ON_FAILED = 'VM_POWER_ON_FAILED'¶

STATE_VM_POWER_ON_IN_PROGRESS = 'VM_POWER_ON_IN_PROGRESS'¶

STATE_VM_RENAME_FAILED = 'VM_RENAME_FAILED'¶

STATE_VM_RENAME_PENDING = 'VM_RENAME_PENDING'¶

STATE_VM_UNDEPLOY_FAILED = 'VM_UNDEPLOY_FAILED'¶

STATE_VM_UNDEPLOY_IN_PROGRESS = 'VM_UNDEPLOY_IN_PROGRESS'¶

STATE_VM_UNDEPLOY_SUCCESSFUL = 'VM_UNDEPLOY_SUCCESSFUL'¶

STATE_VTEP_DHCP_NOT_SUPPORTED = 'VTEP_DHCP_NOT_SUPPORTED'¶

class com.vmware.nsx_policy.model_client.ConfigurationStateElement(failure_code=None, failure_message=None, state=None, sub_system_address=None, sub_system_id=None, sub_system_type=None)¶

Bases: vmware.vapi.bindings.struct.VapiStruct

Describes status of configuration of an entity

Tip

The arguments are used to initialize data attributes with the same names.

Parameters

failure_code (long or None) – Error code format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
failure_message (str or None) – Error message in case of failure This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
state (str or None) –
Possible values are:
State of configuration on this sub system

This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
sub_system_address (str or None) – URI of backing resource on sub system This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
sub_system_id (str or None) – Identifier of backing resource on sub system This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
sub_system_type (str or None) – Type of backing resource on sub system This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.

STATE_APPLIANCE_INTERNAL_ERROR = 'APPLIANCE_INTERNAL_ERROR'¶

STATE_EDGE_CONFIG_ERROR = 'EDGE_CONFIG_ERROR'¶

STATE_EDGE_HARDWARE_NOT_SUPPORTED = 'EDGE_HARDWARE_NOT_SUPPORTED'¶

STATE_EDGE_NODE_VERSION_NOT_SUPPORTED = 'EDGE_NODE_VERSION_NOT_SUPPORTED'¶

STATE_ERROR = 'error'¶

STATE_FAILED = 'failed'¶

STATE_HOSTSWITCH_PROFILE_NOT_FOUND = 'HOSTSWITCH_PROFILE_NOT_FOUND'¶

STATE_INVALID_PNIC_DEVICE_NAME = 'INVALID_PNIC_DEVICE_NAME'¶

STATE_IN_PROGRESS = 'in_progress'¶

STATE_IN_SYNC = 'in_sync'¶

STATE_LACP_NOT_SUPPORTED_FOR_EDGE_VM = 'LACP_NOT_SUPPORTED_FOR_EDGE_VM'¶

STATE_LBSRCID_NOT_SUPPORTED_FOR_EDGE_VM = 'LBSRCID_NOT_SUPPORTED_FOR_EDGE_VM'¶

STATE_LLDP_SEND_ENABLED_NOT_SUPPORTED = 'LLDP_SEND_ENABLED_NOT_SUPPORTED'¶

STATE_MPA_DISCONNECTED = 'MPA_DISCONNECTED'¶

STATE_MULTIPLE_ACTIVE_UPLINKS_NOT_SUPPORTED_FOR_EDGE = 'MULTIPLE_ACTIVE_UPLINKS_NOT_SUPPORTED_FOR_EDGE'¶

STATE_MULTIPLE_OVERLAY_TZS_NOT_SUPPORTED = 'MULTIPLE_OVERLAY_TZS_NOT_SUPPORTED'¶

STATE_NOT_AVAILABLE = 'NOT_AVAILABLE'¶

STATE_NO_PNIC_PREPARED_IN_EDGE = 'NO_PNIC_PREPARED_IN_EDGE'¶

STATE_NO_PNIC_SPECIFIED_IN_TN = 'NO_PNIC_SPECIFIED_IN_TN'¶

STATE_ORPHANED = 'orphaned'¶

STATE_PARTIAL_SUCCESS = 'partial_success'¶

STATE_PENDING = 'pending'¶

STATE_REGISTRATION_FAILED = 'REGISTRATION_FAILED'¶

STATE_STANDBY_UPLINKS_NOT_SUPPORTED_FOR_EDGE_VM = 'STANDBY_UPLINKS_NOT_SUPPORTED_FOR_EDGE_VM'¶

STATE_SUCCESS = 'success'¶

STATE_TN_OVERLAY_TZ_IN_USE_BY_EDGE_CLUSTER = 'TN_OVERLAY_TZ_IN_USE_BY_EDGE_CLUSTER'¶

STATE_TRANSPORT_NODE_CONFIGURATION_MISSING = 'TRANSPORT_NODE_CONFIGURATION_MISSING'¶

STATE_TZ_ENDPOINTS_NOT_SPECIFIED = 'TZ_ENDPOINTS_NOT_SPECIFIED'¶

STATE_UNKNOWN = 'unknown'¶

STATE_UNSUPPORTED_DEFAULT_TEAMING_POLICY = 'UNSUPPORTED_DEFAULT_TEAMING_POLICY'¶

STATE_UNSUPPORTED_HOST_SWITCH_PROFILE = 'UNSUPPORTED_HOST_SWITCH_PROFILE'¶

STATE_UNSUPPORTED_LACP_LB_ALGO_FOR_NODE = 'UNSUPPORTED_LACP_LB_ALGO_FOR_NODE'¶

STATE_UNSUPPORTED_NAMED_TEAMING_POLICY = 'UNSUPPORTED_NAMED_TEAMING_POLICY'¶

STATE_UPLINK_HOST_SWITCH_PROFILE_NOT_SPECIFIED = 'UPLINK_HOST_SWITCH_PROFILE_NOT_SPECIFIED'¶

STATE_VM_CONFIG_DISCREPANCY = 'VM_CONFIG_DISCREPANCY'¶

STATE_VM_CONFIG_EDIT_FAILED = 'VM_CONFIG_EDIT_FAILED'¶

STATE_VM_CONFIG_EDIT_PENDING = 'VM_CONFIG_EDIT_PENDING'¶

STATE_VM_DEPLOYMENT_FAILED = 'VM_DEPLOYMENT_FAILED'¶

STATE_VM_NETWORK_EDIT_FAILED = 'VM_NETWORK_EDIT_FAILED'¶

STATE_VM_NETWORK_EDIT_PENDING = 'VM_NETWORK_EDIT_PENDING'¶

STATE_VM_NODE_REFRESH_FAILED = 'VM_NODE_REFRESH_FAILED'¶

STATE_VM_PLACEMENT_REFRESH_FAILED = 'VM_PLACEMENT_REFRESH_FAILED'¶

STATE_VM_POWER_OFF_FAILED = 'VM_POWER_OFF_FAILED'¶

STATE_VM_POWER_ON_FAILED = 'VM_POWER_ON_FAILED'¶

STATE_VM_RENAME_FAILED = 'VM_RENAME_FAILED'¶

STATE_VM_RENAME_PENDING = 'VM_RENAME_PENDING'¶

STATE_VM_UNDEPLOY_FAILED = 'VM_UNDEPLOY_FAILED'¶

STATE_VTEP_DHCP_NOT_SUPPORTED = 'VTEP_DHCP_NOT_SUPPORTED'¶

class com.vmware.nsx_policy.model_client.ConjunctionOperator(conjunction_operator=None, links=None, schema=None, self_=None, revision=None, create_time=None, create_user=None, last_modified_time=None, last_modified_user=None, protection=None, system_owned=None, description=None, display_name=None, id=None, resource_type='ConjunctionOperator', tags=None, parent_path=None, path=None, relative_path=None, children=None, marked_for_delete=None)¶

Bases: vmware.vapi.bindings.struct.VapiStruct

Represents the operators AND or OR.

Tip

The arguments are used to initialize data attributes with the same names.

Parameters

conjunction_operator (str) –
Possible values are:
- ConjunctionOperator.CONJUNCTION_OPERATOR_OR
- ConjunctionOperator.CONJUNCTION_OPERATOR_AND
Conjunction Operator Node
links (list of ResourceLink or None) – The server will populate this field when returing the resource. Ignored on PUT and POST. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
schema (str or None) – Schema for this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
self (SelfResourceLink or None) – Link to this resource
revision (long or None) – The _revision property describes the current revision of the resource. To prevent clients from overwriting each other’s changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected. format: int32
create_time (long or None) – Timestamp of resource creation format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
create_user (str or None) – ID of the user who created this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
last_modified_time (long or None) – Timestamp of last modification format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
last_modified_user (str or None) – ID of the user who last modified this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
protection (str or None) – Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super user and can modify it, but only when providing the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this entity. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
system_owned (bool or None) – Indicates system owned resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
description (str or None) – Description of this resource
display_name (str or None) – Defaults to ID if not set
id (str or None) – Unique identifier of this resource
resource_type (str) –
Possible values are:
- Expression.RESOURCE_TYPE_CONDITION
- Expression.RESOURCE_TYPE_CONJUNCTIONOPERATOR
- Expression.RESOURCE_TYPE_NESTEDEXPRESSION
- Expression.RESOURCE_TYPE_IPADDRESSEXPRESSION
- Expression.RESOURCE_TYPE_MACADDRESSEXPRESSION
- Expression.RESOURCE_TYPE_EXTERNALIDEXPRESSION
- Expression.RESOURCE_TYPE_PATHEXPRESSION
- Expression.RESOURCE_TYPE_IDENTITYGROUPEXPRESSION
tags (list of Tag or None) – Opaque identifiers meaningful to the API user
parent_path (str or None) – Path of its parent This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
path (str or None) – Absolute path of this object This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
relative_path (str or None) – Path relative from its parent This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
children (list of vmware.vapi.struct.VapiStruct or None) – subtree for this type within policy tree containing nested elements. When clients pass a value of this class as a parameter, the attribute must contain all the attributes defined in ChildPolicyConfigResource. When methods return a value of this class as a return value, the attribute will contain all the attributes defined in ChildPolicyConfigResource.
marked_for_delete (bool or None) – Intent objects are not directly deleted from the system when a delete is invoked on them. They are marked for deletion and only when all the realized entities for that intent object gets deleted, the intent object is deleted. Objects that are marked for deletion are not returned in GET call. One can use the search API to get these objects. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.

CONJUNCTION_OPERATOR_AND = 'AND'¶

CONJUNCTION_OPERATOR_OR = 'OR'¶

property resource_type¶: Return the discriminator value

class com.vmware.nsx_policy.model_client.ConnectivityAdvancedConfig(connectivity=None)¶

Bases: vmware.vapi.bindings.struct.VapiStruct

Advanced configuration for Policy connectivity

Tip

The arguments are used to initialize data attributes with the same names.

Parameters

connectivity (str or None) –

Possible values are:

ConnectivityAdvancedConfig.CONNECTIVITY_ON
ConnectivityAdvancedConfig.CONNECTIVITY_OFF

Connectivity configuration to manually connect (ON) or disconnect (OFF) a logical entity from network topology.

CONNECTIVITY_OFF = 'OFF'¶

CONNECTIVITY_ON = 'ON'¶

class com.vmware.nsx_policy.model_client.ConsolidatedRealizedStatus(intent_path=None, consolidated_status=None, consolidated_status_per_enforcement_point=None)¶

Bases: vmware.vapi.bindings.struct.VapiStruct

Consolidated Realized Status of an intent object across enforcement points.

Tip

The arguments are used to initialize data attributes with the same names.

Parameters

intent_path (str or None) – Intent path of object, forward slashes must be escaped using %2F. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
consolidated_status (ConsolidatedStatus or None) – Consolidated Realized Status across enforcement points.
consolidated_status_per_enforcement_point (list of ConsolidatedStatusPerEnforcementPoint or None) – List of Consolidated Realized Status per enforcement point. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.

class com.vmware.nsx_policy.model_client.ConsolidatedStatus(consolidated_status=None)¶

Bases: vmware.vapi.bindings.struct.VapiStruct

Consolidated Status of an intent object. Status Consolidation of an intent happens at multiple levels: - Per Enforcement Point: calculation of the consolidated status is performed using all realized entities that the intent objet maps to on a specific enforcement point. - Across Enforcement Points: calculation of the consolidated status is performend aggregating the consolidated status from each enforcement point.

Tip

The arguments are used to initialize data attributes with the same names.

Parameters

consolidated_status (str or None) –

Possible values are:

ConsolidatedStatus.CONSOLIDATED_STATUS_SUCCESS
ConsolidatedStatus.CONSOLIDATED_STATUS_IN_PROGRESS
ConsolidatedStatus.CONSOLIDATED_STATUS_ERROR
ConsolidatedStatus.CONSOLIDATED_STATUS_UNKNOWN
ConsolidatedStatus.CONSOLIDATED_STATUS_UNINITIALIZED

Consolidated Realized Status of an intent object.

This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.

CONSOLIDATED_STATUS_ERROR = 'ERROR'¶

CONSOLIDATED_STATUS_IN_PROGRESS = 'IN_PROGRESS'¶

CONSOLIDATED_STATUS_SUCCESS = 'SUCCESS'¶

CONSOLIDATED_STATUS_UNINITIALIZED = 'UNINITIALIZED'¶

CONSOLIDATED_STATUS_UNKNOWN = 'UNKNOWN'¶

class com.vmware.nsx_policy.model_client.ConsolidatedStatusPerEnforcementPoint(alarm=None, enforcement_point_path=None, consolidated_status=None, enforcement_point_id=None)¶

Bases: vmware.vapi.bindings.struct.VapiStruct

Consolidated Realized Status Per Enforcement Point.

Tip

The arguments are used to initialize data attributes with the same names.

Parameters

alarm (PolicyRuntimeAlarm or None) – Alarm information details.
enforcement_point_path (str or None) – Policy Path referencing the enforcement point where the info is fetched. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
consolidated_status (ConsolidatedStatus or None) – Consolidated Realized Status of an Intent object per enforcement point.
enforcement_point_id (str or None) – Enforcement Point Id. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.

class com.vmware.nsx_policy.model_client.ConstantFieldValue(constant=None, resource_type='ConstantFieldValue')¶

Bases: vmware.vapi.bindings.struct.VapiStruct

Constant Field Value.

Tip

The arguments are used to initialize data attributes with the same names.

Parameters

constant (vmware.vapi.struct.VapiStruct or None) – Constant Value that the field must be set to.
resource_type (str) –
Possible values are:
- FieldSettingValue.RESOURCE_TYPE_CONSTANTFIELDVALUE
Field Setting Value resource type.

property resource_type¶: Return the discriminator value

class com.vmware.nsx_policy.model_client.Constraint(links=None, schema=None, self_=None, revision=None, create_time=None, create_user=None, last_modified_time=None, last_modified_user=None, protection=None, system_owned=None, description=None, display_name=None, id=None, resource_type=None, tags=None, parent_path=None, path=None, relative_path=None, children=None, marked_for_delete=None, constraint_expression=None, message=None, target=None)¶

Bases: vmware.vapi.bindings.struct.VapiStruct

Constraint object to constraint any attribute on a resource based on specified expression. Example- Restrict the allowed services in Edge Communication Entry to list of services, if the destinationGroups contain vCenter. { “target”:{ “target_resource_type”:”CommunicationEntry”, “attribute”:”services”, “path_prefix”:”/infra/domains/vmc-domain/edge-communication-maps/default/communication-entries” } “constraint_expression”:{ “related_attribute”:{ “attribute”:”destinationGroups” } “condition”:{ “operator”:”INCLUDES”, “rhs_value”:{“vCenter”} “value_constraint”:{ “operator”:”ALLOW”, “values”:{“/ref/services/HTTPS”, “/ref/services/HTTOP”, …} } } } }

Tip

The arguments are used to initialize data attributes with the same names.

Parameters

links (list of ResourceLink or None) – The server will populate this field when returing the resource. Ignored on PUT and POST. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
schema (str or None) – Schema for this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
self (SelfResourceLink or None) – Link to this resource
revision (long or None) – The _revision property describes the current revision of the resource. To prevent clients from overwriting each other’s changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected. format: int32
create_time (long or None) – Timestamp of resource creation format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
create_user (str or None) – ID of the user who created this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
last_modified_time (long or None) – Timestamp of last modification format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
last_modified_user (str or None) – ID of the user who last modified this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
protection (str or None) – Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super user and can modify it, but only when providing the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this entity. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
system_owned (bool or None) – Indicates system owned resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
description (str or None) – Description of this resource
display_name (str or None) – Defaults to ID if not set
id (str or None) – Unique identifier of this resource
resource_type (str or None) – The type of this resource.
tags (list of Tag or None) – Opaque identifiers meaningful to the API user
parent_path (str or None) – Path of its parent This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
path (str or None) – Absolute path of this object This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
relative_path (str or None) – Path relative from its parent This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
children (list of vmware.vapi.struct.VapiStruct or None) – subtree for this type within policy tree containing nested elements. When clients pass a value of this class as a parameter, the attribute must contain all the attributes defined in ChildPolicyConfigResource. When methods return a value of this class as a return value, the attribute will contain all the attributes defined in ChildPolicyConfigResource.
marked_for_delete (bool or None) – Intent objects are not directly deleted from the system when a delete is invoked on them. They are marked for deletion and only when all the realized entities for that intent object gets deleted, the intent object is deleted. Objects that are marked for deletion are not returned in GET call. One can use the search API to get these objects. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
constraint_expression (vmware.vapi.struct.VapiStruct) – Expression to constrain the target attribute value. When clients pass a value of this class as a parameter, the attribute must contain all the attributes defined in ConstraintExpression. When methods return a value of this class as a return value, the attribute will contain all the attributes defined in ConstraintExpression.
message (str or None) – User friendly message to be shown to users upon violation.
target (ConstraintTarget) – Target resource attribute details.

class com.vmware.nsx_policy.model_client.ConstraintExpression(links=None, schema=None, self_=None, revision=None, create_time=None, create_user=None, last_modified_time=None, last_modified_user=None, protection=None, system_owned=None, description=None, display_name=None, id=None, resource_type='ConstraintExpression', tags=None)¶

Bases: vmware.vapi.bindings.struct.VapiStruct

All the types of the expression extend from this abstract class. This is present for extensibility.

Tip

The arguments are used to initialize data attributes with the same names.

Parameters

links (list of ResourceLink or None) – The server will populate this field when returing the resource. Ignored on PUT and POST. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
schema (str or None) – Schema for this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
self (SelfResourceLink or None) – Link to this resource
revision (long or None) – The _revision property describes the current revision of the resource. To prevent clients from overwriting each other’s changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected. format: int32
create_time (long or None) – Timestamp of resource creation format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
create_user (str or None) – ID of the user who created this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
last_modified_time (long or None) – Timestamp of last modification format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
last_modified_user (str or None) – ID of the user who last modified this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
protection (str or None) – Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super user and can modify it, but only when providing the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this entity. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
system_owned (bool or None) – Indicates system owned resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
description (str or None) – Description of this resource
display_name (str or None) – Defaults to ID if not set
id (str or None) – Unique identifier of this resource
resource_type (str) –
Possible values are:
tags (list of Tag or None) – Opaque identifiers meaningful to the API user

RESOURCE_TYPE_ENTITYINSTANCECOUNTCONSTRAINTEXPRESSION = 'EntityInstanceCountConstraintExpression'¶

RESOURCE_TYPE_FIELDSANITYCONSTRAINTEXPRESSION = 'FieldSanityConstraintExpression'¶

RESOURCE_TYPE_RELATEDATTRIBUTECONDITIONALEXPRESSION = 'RelatedAttributeConditionalExpression'¶

RESOURCE_TYPE_VALUECONSTRAINTEXPRESSION = 'ValueConstraintExpression'¶

property resource_type¶: Return the discriminator value

class com.vmware.nsx_policy.model_client.ConstraintTarget(attribute=None, path_prefix=None, target_resource_type=None)¶

Bases: vmware.vapi.bindings.struct.VapiStruct

Resource attribute on which constraint should be applied. Example - sourceGroups attribute of Edge CommunicationEntry to be restricted, is given as: { “target_resource_type”:”CommunicationEntry”, “attribute”:”sourceGroups”, “path_prefix”:”/infra/domains/vmc-domain/edge-communication-maps/default/communication-entries” }

Tip

The arguments are used to initialize data attributes with the same names.

Parameters

attribute (str or None) – Attribute name of the target entity.
path_prefix (str or None) – Path prefix of the entity to apply constraint. This is required to further disambiguiate if multiple policy entities share the same resource type. Example - Edge FW and DFW use the same resource type CommunicationMap, CommunicationEntry, Group, etc.
target_resource_type (str) – Resource type of the target entity.

class com.vmware.nsx_policy.model_client.ContainerApplication(container_cluster_id=None, container_project_id=None, external_id=None, origin_properties=None, status=None, links=None, schema=None, self_=None, last_sync_time=None, description=None, display_name=None, resource_type='ContainerApplication', tags=None)¶

Bases: vmware.vapi.bindings.struct.VapiStruct

Container application within a project.

Tip

The arguments are used to initialize data attributes with the same names.

Parameters

container_cluster_id (str or None) – Identifier of the container cluster this container application belongs to. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
container_project_id (str or None) – Identifier of the project which this container application belongs to.
external_id (str) – Identifier of the container application on container cluster e.g. PCF app id, k8s service id.
origin_properties (list of KeyValuePair or None) – Array of additional specific properties of container application in key-value format.
status (str or None) –
Possible values are:
Status of the container application.
links (list of ResourceLink or None) – The server will populate this field when returing the resource. Ignored on PUT and POST. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
schema (str or None) – Schema for this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
self (SelfResourceLink or None) – Link to this resource
last_sync_time (long or None) – Timestamp of last modification format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
description (str or None) – Description of this resource
display_name (str or None) – Defaults to ID if not set
resource_type (str) – The type of this resource.
tags (list of Tag or None) – Opaque identifiers meaningful to the API user

STATUS_DEGRADED = 'DEGRADED'¶

STATUS_DOWN = 'DOWN'¶

STATUS_HEALTHY = 'HEALTHY'¶

STATUS_UNKNOWN = 'UNKNOWN'¶

STATUS_UP = 'UP'¶

property resource_type¶: Return the discriminator value

class com.vmware.nsx_policy.model_client.ContainerApplicationInstance(cluster_node_id=None, container_application_ids=None, container_cluster_id=None, container_project_id=None, external_id=None, origin_properties=None, status=None, links=None, schema=None, self_=None, last_sync_time=None, description=None, display_name=None, resource_type='ContainerApplicationInstance', tags=None)¶

Bases: vmware.vapi.bindings.struct.VapiStruct

Container application instance within a project.

Tip

The arguments are used to initialize data attributes with the same names.

Parameters

cluster_node_id (str or None) – Cluster node id where application instance is running.
container_application_ids (list of str or None) – List of identifiers of the container application.
container_cluster_id (str or None) – Identifier of the container cluster this application instance belongs to. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
container_project_id (str or None) – Identifier of the container project which this container application instance belongs to.
external_id (str) – Identifier of the container application instance on container cluster.
origin_properties (list of KeyValuePair or None) – Array of additional specific properties of container application instance in key-value format.
status (str or None) –
Possible values are:
Status of the container application instance.
links (list of ResourceLink or None) – The server will populate this field when returing the resource. Ignored on PUT and POST. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
schema (str or None) – Schema for this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
self (SelfResourceLink or None) – Link to this resource
last_sync_time (long or None) – Timestamp of last modification format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
description (str or None) – Description of this resource
display_name (str or None) – Defaults to ID if not set
resource_type (str) – The type of this resource.
tags (list of Tag or None) – Opaque identifiers meaningful to the API user

STATUS_DEGRADED = 'DEGRADED'¶

STATUS_DOWN = 'DOWN'¶

STATUS_HEALTHY = 'HEALTHY'¶

STATUS_UNKNOWN = 'UNKNOWN'¶

STATUS_UP = 'UP'¶

property resource_type¶: Return the discriminator value

class com.vmware.nsx_policy.model_client.ContainerCluster(cluster_type=None, external_id=None, infrastructure=None, origin_properties=None, links=None, schema=None, self_=None, last_sync_time=None, description=None, display_name=None, resource_type='ContainerCluster', tags=None)¶

Bases: vmware.vapi.bindings.struct.VapiStruct

Details of container cluster.

Tip

The arguments are used to initialize data attributes with the same names.

Parameters

cluster_type (str or None) –
Possible values are:
Type of the container cluster. In case of creating container cluster first time, it is expected to pass the valid cluster-type. In case of update, if there is no change in cluster-type, then this field can be omitted in the request.
external_id (str or None) – External identifier of the container cluster.
infrastructure (ContainerInfrastructureInfo or None) – Details of underlying infrastructure that hosts the container cluster. In case of creating container cluster first time, it is expected to pass the valid infrastructure. In case of update, if there is no change in cluster-type, then this field can be omitted in the request.
origin_properties (list of KeyValuePair or None) – Array of additional specific properties of container cluster in key-value format.
links (list of ResourceLink or None) – The server will populate this field when returing the resource. Ignored on PUT and POST. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
schema (str or None) – Schema for this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
self (SelfResourceLink or None) – Link to this resource
last_sync_time (long or None) – Timestamp of last modification format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
description (str or None) – Description of this resource
display_name (str or None) – Defaults to ID if not set
resource_type (str) – The type of this resource.
tags (list of Tag or None) – Opaque identifiers meaningful to the API user

CLUSTER_TYPE_KUBERNETES = 'Kubernetes'¶

CLUSTER_TYPE_OPENSHIFT = 'Openshift'¶

CLUSTER_TYPE_OTHER = 'Other'¶

CLUSTER_TYPE_PAS = 'PAS'¶

CLUSTER_TYPE_PKS = 'PKS'¶

CLUSTER_TYPE_WCP = 'WCP'¶

property resource_type¶: Return the discriminator value

class com.vmware.nsx_policy.model_client.ContainerClusterNode(container_cluster_id=None, external_id=None, origin_properties=None, links=None, schema=None, self_=None, last_sync_time=None, description=None, display_name=None, resource_type='ContainerClusterNode', tags=None)¶

Bases: vmware.vapi.bindings.struct.VapiStruct

Details of container cluster node i.e. container host.

Tip

The arguments are used to initialize data attributes with the same names.

Parameters

container_cluster_id (str or None) – External identifier of the container cluster.
external_id (str) – External identifier of the container cluster node in K8S/PAS.
origin_properties (list of KeyValuePair or None) – Array of additional specific properties of container cluster node in key-value format.
links (list of ResourceLink or None) – The server will populate this field when returing the resource. Ignored on PUT and POST. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
schema (str or None) – Schema for this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
self (SelfResourceLink or None) – Link to this resource
last_sync_time (long or None) – Timestamp of last modification format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
description (str or None) – Description of this resource
display_name (str or None) – Defaults to ID if not set
resource_type (str) – The type of this resource.
tags (list of Tag or None) – Opaque identifiers meaningful to the API user

property resource_type¶: Return the discriminator value

class com.vmware.nsx_policy.model_client.ContainerConfiguration(labels=None, layout=None, navigation=None, span=None, widgets=None, links=None, schema=None, self_=None, revision=None, create_time=None, create_user=None, last_modified_time=None, last_modified_user=None, protection=None, system_owned=None, description=None, display_name=None, id=None, resource_type='ContainerConfiguration', tags=None, datasources=None, drilldown_id=None, footer=None, icons=None, is_drilldown=None, legend=None, shared=None, weight=None)¶

Bases: vmware.vapi.bindings.struct.VapiStruct

Represents a container to group widgets that belong to a common category or have a common purpose.

Tip

The arguments are used to initialize data attributes with the same names.

Parameters

labels (list of Label or None) – Labels for the container.
layout (Layout or None) – Layout of widgets can be either vertical or horizontal. If layout is not specified a default horizontal layout is applied.
navigation (str or None) – Hyperlink of the specified UI page that provides details.
span (long or None) – Represents the horizontal span of the container. format: int32
widgets (list of WidgetItem or None) – If not specified, creates an empty container.
links (list of ResourceLink or None) – The server will populate this field when returing the resource. Ignored on PUT and POST. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
schema (str or None) – Schema for this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
self (SelfResourceLink or None) – Link to this resource
revision (long or None) – The _revision property describes the current revision of the resource. To prevent clients from overwriting each other’s changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected. format: int32
create_time (long or None) – Timestamp of resource creation format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
create_user (str or None) – ID of the user who created this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
last_modified_time (long or None) – Timestamp of last modification format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
last_modified_user (str or None) – ID of the user who last modified this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
protection (str or None) – Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super user and can modify it, but only when providing the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this entity. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
system_owned (bool or None) – Indicates system owned resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
description (str or None) – Description of this resource
display_name (str or None) – Title of the widget. If display_name is omitted, the widget will be shown without a title.
id (str or None) – Unique identifier of this resource
resource_type (str) –
Possible values are:
- WidgetConfiguration.RESOURCE_TYPE_LABELVALUECONFIGURATION
- WidgetConfiguration.RESOURCE_TYPE_DONUTCONFIGURATION
- WidgetConfiguration.RESOURCE_TYPE_MULTIWIDGETCONFIGURATION
- WidgetConfiguration.RESOURCE_TYPE_CONTAINERCONFIGURATION
- WidgetConfiguration.RESOURCE_TYPE_STATSCONFIGURATION
- WidgetConfiguration.RESOURCE_TYPE_GRIDCONFIGURATION
- WidgetConfiguration.RESOURCE_TYPE_GRAPHCONFIGURATION
Supported visualization types are LabelValueConfiguration, DonutConfiguration, GridConfiguration, StatsConfiguration, MultiWidgetConfiguration, GraphConfiguration and ContainerConfiguration.
tags (list of Tag or None) – Opaque identifiers meaningful to the API user
datasources (list of Datasource or None) – The ‘datasources’ represent the sources from which data will be fetched. Currently, only NSX-API is supported as a ‘default’ datasource. An example of specifying ‘default’ datasource along with the urls to fetch data from is given at ‘example_request’ section of ‘CreateWidgetConfiguration’ API.
drilldown_id (str or None) – Id of drilldown widget, if any. Id should be a valid id of an existing widget. A widget is considered as drilldown widget when it is associated with any other widget and provides more detailed information about any data item from the parent widget.
footer (Footer or None) –
icons (list of Icon or None) – Icons to be applied at dashboard for widgets and UI elements.
is_drilldown (bool or None) – Set to true if this widget should be used as a drilldown.
legend (Legend or None) – Legend to be displayed. If legend is not needed, do not include it.
shared (bool or None) – Please use the property ‘shared’ of View instead of this. The widgets of a shared view are visible to other users.
weight (long or None) – Specify relavite weight in WidgetItem for placement in a view. Please see WidgetItem for details. format: int32

property resource_type¶: Return the discriminator value

class com.vmware.nsx_policy.model_client.ContainerInfrastructureInfo(infra_type=None)¶

Bases: vmware.vapi.bindings.struct.VapiStruct

Details of infrastructure hosting the container cluster e.g. vSphere, AWS, VMC etc..

Tip

The arguments are used to initialize data attributes with the same names.

Parameters

infra_type (str) –

Possible values are:

ContainerInfrastructureInfo.INFRA_TYPE_VSPHERE
ContainerInfrastructureInfo.INFRA_TYPE_AWS
ContainerInfrastructureInfo.INFRA_TYPE_AZURE
ContainerInfrastructureInfo.INFRA_TYPE_VMC
ContainerInfrastructureInfo.INFRA_TYPE_KVM
ContainerInfrastructureInfo.INFRA_TYPE_BAREMETAL

Type of the infrastructure.

INFRA_TYPE_AWS = 'AWS'¶

INFRA_TYPE_AZURE = 'Azure'¶

INFRA_TYPE_BAREMETAL = 'Baremetal'¶

INFRA_TYPE_KVM = 'KVM'¶

INFRA_TYPE_VMC = 'VMC'¶

INFRA_TYPE_VSPHERE = 'vSphere'¶

class com.vmware.nsx_policy.model_client.ContainerIngressPolicy(container_cluster_id=None, container_project_id=None, external_id=None, origin_properties=None, spec=None, links=None, schema=None, self_=None, last_sync_time=None, description=None, display_name=None, resource_type='ContainerIngressPolicy', tags=None)¶

Bases: vmware.vapi.bindings.struct.VapiStruct

Details of Container Ingress Policy.

Tip

The arguments are used to initialize data attributes with the same names.

Parameters

container_cluster_id (str or None) – Identifier of the container cluster this ingress policy belongs to.
container_project_id (str or None) – Identifier of the project which this container ingress belongs to.
external_id (str) – Identifier of the container ingress policy.
origin_properties (list of KeyValuePair or None) – Array of additional specific properties of container ingress in key-value format.
spec (str or None) – Container ingress policy specification.
links (list of ResourceLink or None) – The server will populate this field when returing the resource. Ignored on PUT and POST. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
schema (str or None) – Schema for this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
self (SelfResourceLink or None) – Link to this resource
last_sync_time (long or None) – Timestamp of last modification format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
description (str or None) – Description of this resource
display_name (str or None) – Defaults to ID if not set
resource_type (str) – The type of this resource.
tags (list of Tag or None) – Opaque identifiers meaningful to the API user

property resource_type¶: Return the discriminator value

class com.vmware.nsx_policy.model_client.ContainerNetworkPolicy(container_cluster_id=None, container_project_id=None, external_id=None, origin_properties=None, policy_type=None, spec=None, links=None, schema=None, self_=None, last_sync_time=None, description=None, display_name=None, resource_type='ContainerNetworkPolicy', tags=None)¶

Bases: vmware.vapi.bindings.struct.VapiStruct

Network policy applied to container.

Tip

The arguments are used to initialize data attributes with the same names.

Parameters

container_cluster_id (str or None) – Identifier of the container cluster this network policy belongs to.
container_project_id (str or None) – Identifier of the project which this network policy belongs to.
external_id (str) – Identifier of the container network policy.
origin_properties (list of KeyValuePair or None) – Array of additional specific properties of container network policy in key-value format.
policy_type (str or None) –
Possible values are:
- ContainerNetworkPolicy.POLICY_TYPE_NETWORK_POLICY
- ContainerNetworkPolicy.POLICY_TYPE_ASG
Type e.g. Network Policy, ASG.
spec (str or None) – Container network policy specification.
links (list of ResourceLink or None) – The server will populate this field when returing the resource. Ignored on PUT and POST. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
schema (str or None) – Schema for this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
self (SelfResourceLink or None) – Link to this resource
last_sync_time (long or None) – Timestamp of last modification format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
description (str or None) – Description of this resource
display_name (str or None) – Defaults to ID if not set
resource_type (str) – The type of this resource.
tags (list of Tag or None) – Opaque identifiers meaningful to the API user

POLICY_TYPE_ASG = 'ASG'¶

POLICY_TYPE_NETWORK_POLICY = 'NETWORK_POLICY'¶

property resource_type¶: Return the discriminator value

class com.vmware.nsx_policy.model_client.ContainerProject(container_cluster_id=None, external_id=None, origin_properties=None, links=None, schema=None, self_=None, last_sync_time=None, description=None, display_name=None, resource_type='ContainerProject', tags=None)¶

Bases: vmware.vapi.bindings.struct.VapiStruct

Details of org/namespace within a container cluster.

Tip

The arguments are used to initialize data attributes with the same names.

Parameters

container_cluster_id (str or None) – Identifier of the container cluster to which this project/namespace belongs.
external_id (str) – External identifier of the container project.
origin_properties (list of KeyValuePair or None) – Array of additional specific properties of container project in key-value format.
links (list of ResourceLink or None) – The server will populate this field when returing the resource. Ignored on PUT and POST. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
schema (str or None) – Schema for this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
self (SelfResourceLink or None) – Link to this resource
last_sync_time (long or None) – Timestamp of last modification format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
description (str or None) – Description of this resource
display_name (str or None) – Defaults to ID if not set
resource_type (str) – The type of this resource.
tags (list of Tag or None) – Opaque identifiers meaningful to the API user

property resource_type¶: Return the discriminator value

class com.vmware.nsx_policy.model_client.Criterion(evaluations=None)¶

Bases: vmware.vapi.bindings.struct.VapiStruct

Event Criterion is the logical evaluations by which the event may be deemed fulfilled. All the evaluations must be met in order for the criterion to be met (implicit AND).

Tip

The arguments are used to initialize data attributes with the same names.

Parameters: evaluations (list of vmware.vapi.struct.VapiStruct) – Criterion Evaluations. When clients pass a value of this class as a parameter, the attribute must contain all the attributes defined in Evaluation. When methods return a value of this class as a return value, the attribute will contain all the attributes defined in Evaluation.

class com.vmware.nsx_policy.model_client.CsvListResult(file_name=None)¶

Bases: vmware.vapi.bindings.struct.VapiStruct

Base type for CSV result.

Tip

The arguments are used to initialize data attributes with the same names.

Parameters: file_name (str or None) – File name set by HTTP server if API returns CSV result as a file.

class com.vmware.nsx_policy.model_client.CsvRecord¶

Bases: vmware.vapi.bindings.struct.VapiStruct

Base type for CSV records.

Tip

The arguments are used to initialize data attributes with the same names.

class com.vmware.nsx_policy.model_client.CustomPolicyLbPersistenceProfile(persistence=None, persistence_shared=None, links=None, schema=None, self_=None, revision=None, create_time=None, create_user=None, last_modified_time=None, last_modified_user=None, protection=None, system_owned=None, description=None, display_name=None, id=None, resource_type='CustomPolicyLbPersistenceProfile', tags=None, parent_path=None, path=None, relative_path=None, children=None, marked_for_delete=None)¶

Bases: vmware.vapi.bindings.struct.VapiStruct

Some applications maintain state and require all relevant connections to be sent to the same server as the application state is not synchronized among servers. Persistence is enabled on a PolicyLbVirtualServer by binding a persistence profile to it.

Tip

The arguments are used to initialize data attributes with the same names.

Parameters

persistence (str) –
Possible values are:
- CustomPolicyLbPersistenceProfile.PERSISTENCE_COOKIE
- CustomPolicyLbPersistenceProfile.PERSISTENCE_SOURCE_IP
This field indicates the persistence method used for the PolicyLbVirtualServer. - COOKIE persistence allows related client connections, identified by the same cookie in HTTP requests [Refer to HTTP Cookie for details on HTTP cookies], to be redirected to the same server. Load balancer does not maintain any persistence table for cookie persistence. Instead, it encodes the necessary information in the HTTP cookie value sent to client and relies on the client to store it and send it back in subsequent related HTTP requests. Hence there is no limit on the number of cookie persistence entries that can be supported. - SOURCE_IP persistence ensures all connections from a client (identified by IP address) are sent to the same backend server for a specified period. - This object is not required and without creation of this object the virtual server persistence is disabled by default
persistence_shared (bool or None) – Persistence shared setting indicates that all PolicyLbVirtualServers that consume this PolicyLbPersistenceProfile should share the same persistence mechanism when enabled. Meaning, persistence entries of a client accessing one virtual server will also affect the same client’s connections to a different virtual server. For example, say there are two virtual servers vip-ip1:80 and vip-ip1:8080 bound to the same Group g1 consisting of two servers (s11:80 and s12:80). By default, each virtual server will have its own persistence table or cookie. So, in the earlier example, there will be two tables (vip-ip1:80, p1) and (vip-ip1:8080, p1) or cookies. So, if a client connects to vip1:80 and later connects to vip1:8080, the second connection may be sent to a different server than the first. When persistence_shared is enabled, then the second connection will always connect to the same server as the original connection. For COOKIE persistence type, the same cookie will be shared by multiple virtual servers. For SOURCE_IP persistenct type, the persistence table will be shared across virtual servers.
links (list of ResourceLink or None) – The server will populate this field when returing the resource. Ignored on PUT and POST. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
schema (str or None) – Schema for this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
self (SelfResourceLink or None) – Link to this resource
revision (long or None) – The _revision property describes the current revision of the resource. To prevent clients from overwriting each other’s changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected. format: int32
create_time (long or None) – Timestamp of resource creation format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
create_user (str or None) – ID of the user who created this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
last_modified_time (long or None) – Timestamp of last modification format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
last_modified_user (str or None) – ID of the user who last modified this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
protection (str or None) – Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super user and can modify it, but only when providing the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this entity. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
system_owned (bool or None) – Indicates system owned resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
description (str or None) – Description of this resource
display_name (str or None) – Defaults to ID if not set
id (str or None) – Unique identifier of this resource
resource_type (str) –
Possible values are:
- PolicyLbPersistenceProfile.RESOURCE_TYPE_L4POLICYLBPERSISTENCEPROFILE
- PolicyLbPersistenceProfile.RESOURCE_TYPE_L7POLICYLBPERSISTENCEPROFILE
- PolicyLbPersistenceProfile.RESOURCE_TYPE_CUSTOMPOLICYLBPERSISTENCEPROFILE
tags (list of Tag or None) – Opaque identifiers meaningful to the API user
parent_path (str or None) – Path of its parent This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
path (str or None) – Absolute path of this object This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
relative_path (str or None) – Path relative from its parent This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
children (list of vmware.vapi.struct.VapiStruct or None) – subtree for this type within policy tree containing nested elements. When clients pass a value of this class as a parameter, the attribute must contain all the attributes defined in ChildPolicyConfigResource. When methods return a value of this class as a return value, the attribute will contain all the attributes defined in ChildPolicyConfigResource.
marked_for_delete (bool or None) – Intent objects are not directly deleted from the system when a delete is invoked on them. They are marked for deletion and only when all the realized entities for that intent object gets deleted, the intent object is deleted. Objects that are marked for deletion are not returned in GET call. One can use the search API to get these objects. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.

PERSISTENCE_COOKIE = 'COOKIE'¶

PERSISTENCE_SOURCE_IP = 'SOURCE_IP'¶

property resource_type¶: Return the discriminator value

class com.vmware.nsx_policy.model_client.CustomPolicyLbVirtualServer(app_protocol=None, client_ssl_certificate_ids=None, client_ssl_settings=None, default_client_ssl_certificate_id=None, server_auth_ca_certificate_ids=None, server_ssl_settings=None, insert_client_ip_header=None, links=None, schema=None, self_=None, revision=None, create_time=None, create_user=None, last_modified_time=None, last_modified_user=None, protection=None, system_owned=None, description=None, display_name=None, id=None, resource_type=None, tags=None, parent_path=None, path=None, relative_path=None, children=None, marked_for_delete=None, access_log_enabled=None, ip_address=None, lb_persistence_profile=None, ports=None, router_path=None, traffic_source=None)¶

Bases: vmware.vapi.bindings.struct.VapiStruct

Virtual server acts as a facade to an application, receives all client connections over a specified protocol and distributes them among the backend servers. This custom type allows for more complex settings than the simplified PolicyLbVirtualServer types. This object allows for complex configurations for PolicyLbVirtualServers of all types. All HTTP specific inputs will be rejected when combined with TPC or UDP protocols.

Tip

The arguments are used to initialize data attributes with the same names.

Parameters

app_protocol (str) –
Possible values are:
- CustomPolicyLbVirtualServer.APP_PROTOCOL_TCP
- CustomPolicyLbVirtualServer.APP_PROTOCOL_UDP
- CustomPolicyLbVirtualServer.APP_PROTOCOL_HTTP
- CustomPolicyLbVirtualServer.APP_PROTOCOL_HTTPS
As the custom type allows for more complex settings than the simplified PolicyLbVirtualServer types, also specify the desired protocol for receiving all client connections.
client_ssl_certificate_ids (list of str or None) – Client-side SSL profile binding allows multiple certificates, for different hostnames, to be bound to the same virtual server. The setting is used when load balancer acts as an SSL server and terminating the client SSL connection
client_ssl_settings (str or None) –
Possible values are:
- CustomPolicyLbVirtualServer.CLIENT_SSL_SETTINGS_BASE_SECURE_111317
- CustomPolicyLbVirtualServer.CLIENT_SSL_SETTINGS_MODERATE_SECURE_111317
- CustomPolicyLbVirtualServer.CLIENT_SSL_SETTINGS_HIGH_SECURE_111317
Security settings representing various security settings when the VirtualServer acts as an SSL server - BASE_SECURE_111317 - MODERATE_SECURE_111317 - HIGH_SECURE_111317
default_client_ssl_certificate_id (str or None) – The setting is used when load balancer acts as an SSL server and terminating the client SSL connection. A default certificate should be specified which will be used if the server does not host multiple hostnames on the same IP address or if the client does not support SNI extension.
server_auth_ca_certificate_ids (list of str or None) – To support client authentication (load balancer acting as a client authenticating to the backend server), server_ssl_certificate_id can be specified. When supplied, the backend server certificate must be signed by one of the trusted Certificate Authorities (CAs), also referred to as root CAs, whose self signed certificates are specified. This setting is only applicable for L7 protocols and will be rejected in combination with TCP or UDP.
server_ssl_settings (str or None) –
Possible values are:
- CustomPolicyLbVirtualServer.SERVER_SSL_SETTINGS_BASE_SECURE_111317
- CustomPolicyLbVirtualServer.SERVER_SSL_SETTINGS_MODERATE_SECURE_111317
- CustomPolicyLbVirtualServer.SERVER_SSL_SETTINGS_HIGH_SECURE_111317
- CustomPolicyLbVirtualServer.SERVER_SSL_SETTINGS_DISABLED
Indicates whether to enable server side SSL. Server side SSL will be enabled when a specific security setting is selected. The selected security setting or profile represents various configurations related to SSL when the VirtualServer acts as a client connecting over SSL to the backend server. This setting is only applicable for L7 protocols and will be rejected in combination with TCP or UDP. - BASE_SECURE_111317 - MODERATE_SECURE_111317 - HIGH_SECURE_111317 - DISABLED
insert_client_ip_header (bool or None) – Backend web servers typically log each request they handle along with the requesting client IP address. These logs are used for debugging, analytics and other such purposes. If the deployment topology requires enabling SNAT on the load balancer, then server will see the client as the SNAT IP which defeats the purpose of logging. To work around this issue, load balancer can be configured to insert XFF HTTP header with the original client IP address. Backend servers can then be configured to log the IP address in XFF header instead of the source IP address of the connection. If XFF header is not present in the incoming request, load balancer inserts a new XFF header with the client IP address.
links (list of ResourceLink or None) – The server will populate this field when returing the resource. Ignored on PUT and POST. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
schema (str or None) – Schema for this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
self (SelfResourceLink or None) – Link to this resource
revision (long or None) – The _revision property describes the current revision of the resource. To prevent clients from overwriting each other’s changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected. format: int32
create_time (long or None) – Timestamp of resource creation format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
create_user (str or None) – ID of the user who created this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
last_modified_time (long or None) – Timestamp of last modification format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
last_modified_user (str or None) – ID of the user who last modified this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
protection (str or None) – Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super user and can modify it, but only when providing the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this entity. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
system_owned (bool or None) – Indicates system owned resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
description (str or None) – Description of this resource
display_name (str or None) – Defaults to ID if not set
id (str or None) – Unique identifier of this resource
resource_type (str) –
Possible values are:
- PolicyLbVirtualServer.RESOURCE_TYPE_TCPPOLICYLBVIRTUALSERVER
- PolicyLbVirtualServer.RESOURCE_TYPE_UDPPOLICYLBVIRTUALSERVER
- PolicyLbVirtualServer.RESOURCE_TYPE_HTTPPOLICYLBVIRTUALSERVER
- PolicyLbVirtualServer.RESOURCE_TYPE_HTTPSPOLICYLBVIRTUALSERVER
- PolicyLbVirtualServer.RESOURCE_TYPE_CUSTOMPOLICYLBVIRTUALSERVER
tags (list of Tag or None) – Opaque identifiers meaningful to the API user
parent_path (str or None) – Path of its parent This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
path (str or None) – Absolute path of this object This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
relative_path (str or None) – Path relative from its parent This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
children (list of vmware.vapi.struct.VapiStruct or None) – subtree for this type within policy tree containing nested elements. When clients pass a value of this class as a parameter, the attribute must contain all the attributes defined in ChildPolicyConfigResource. When methods return a value of this class as a return value, the attribute will contain all the attributes defined in ChildPolicyConfigResource.
marked_for_delete (bool or None) – Intent objects are not directly deleted from the system when a delete is invoked on them. They are marked for deletion and only when all the realized entities for that intent object gets deleted, the intent object is deleted. Objects that are marked for deletion are not returned in GET call. One can use the search API to get these objects. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
access_log_enabled (bool or None) – If access log is enabled, all HTTP requests sent to an L7 virtual server are logged to the access log file. Both successful requests (backend server returns 2xx) and unsuccessful requests (backend server returns 4xx or 5xx) are logged to access log, if enabled.
ip_address (str) – Configures the IP address of the PolicyLbVirtualServer where it receives all client connections and distributes them among the backend servers. format: ip
lb_persistence_profile (str or None) – Path to optional object that enables persistence on a virtual server allowing related client connections to be sent to the same backend server. Persistence is disabled by default.
ports (list of str) – Ports contains a list of at least one port or port range such as “80”, “1234-1236”. Each port element in the list should be a single port or a single port range. format: port-or-range
router_path (str) – Path to router type object that PolicyLbVirtualServer connects to. The only supported router object is Network.
traffic_source (str or None) –

APP_PROTOCOL_HTTP = 'HTTP'¶

APP_PROTOCOL_HTTPS = 'HTTPS'¶

APP_PROTOCOL_TCP = 'TCP'¶

APP_PROTOCOL_UDP = 'UDP'¶

CLIENT_SSL_SETTINGS_BASE_SECURE_111317 = 'BASE_SECURE_111317'¶

CLIENT_SSL_SETTINGS_HIGH_SECURE_111317 = 'HIGH_SECURE_111317'¶

CLIENT_SSL_SETTINGS_MODERATE_SECURE_111317 = 'MODERATE_SECURE_111317'¶

SERVER_SSL_SETTINGS_BASE_SECURE_111317 = 'BASE_SECURE_111317'¶

SERVER_SSL_SETTINGS_DISABLED = 'DISABLED'¶

SERVER_SSL_SETTINGS_HIGH_SECURE_111317 = 'HIGH_SECURE_111317'¶

SERVER_SSL_SETTINGS_MODERATE_SECURE_111317 = 'MODERATE_SECURE_111317'¶

property resource_type¶: Return the discriminator value

class com.vmware.nsx_policy.model_client.CvxConnectionInfo(password=None, thumbprint=None, username=None, enforcement_point_address=None, resource_type='CvxConnectionInfo')¶

Bases: vmware.vapi.bindings.struct.VapiStruct

Credential info to connect to cvx enforcement type

Tip

The arguments are used to initialize data attributes with the same names.

Parameters

password (str or None) – Password
thumbprint (str or None) – Thumbprint of EnforcementPoint. sha-256 hash represented in lower case hex.
username (str or None) – UserName
enforcement_point_address (str) – Value of this property could be hostname or ip. eg. For NSX-T manager running on default port the value can be “10.192.1.1”, for NSX-T manager running on custom port value can be “192.168.1.1:32789”. For NSX-T manager in VMC deployments value can have url prefix eg. “192.168.1.1:5480/nsxapi”
resource_type (str) –
Possible values are:

property resource_type¶: Return the discriminator value

class com.vmware.nsx_policy.model_client.DNSForwarderStatisticsPerEnforcementPoint(enforcement_point_path=None, resource_type='DNSForwarderStatisticsPerEnforcementPoint')¶

Bases: vmware.vapi.bindings.struct.VapiStruct

DNS forwarder statistics per enforcement point.

Tip

The arguments are used to initialize data attributes with the same names.

Parameters

enforcement_point_path (str or None) – Policy path referencing the enforcement point from where the statistics are fetched. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
resource_type (str) –
Possible values are:
- DNSForwarderStatisticsPerEnforcementPoint.RESOURCE_TYPE_NSXTDNSFORWARDERSTATISTICS

RESOURCE_TYPE_NSXTDNSFORWARDERSTATISTICS = 'NsxTDNSForwarderStatistics'¶

property resource_type¶: Return the discriminator value

class com.vmware.nsx_policy.model_client.DNSForwarderStatusPerEnforcementPoint(enforcement_point_path=None, resource_type='DNSForwarderStatusPerEnforcementPoint')¶

Bases: vmware.vapi.bindings.struct.VapiStruct

DNS forwarder status per enforcement point.

Tip

The arguments are used to initialize data attributes with the same names.

Parameters

enforcement_point_path (str or None) – Policy path referencing the enforcement point from where the status is fetched. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
resource_type (str) –
Possible values are:
- DNSForwarderStatusPerEnforcementPoint.RESOURCE_TYPE_NSXTDNSFORWARDERSTATUS

RESOURCE_TYPE_NSXTDNSFORWARDERSTATUS = 'NsxTDNSForwarderStatus'¶

property resource_type¶: Return the discriminator value

class com.vmware.nsx_policy.model_client.DataCounter(dropped=None, multicast_broadcast=None, total=None)¶

Bases: vmware.vapi.bindings.struct.VapiStruct

Tip

The arguments are used to initialize data attributes with the same names.

Parameters

dropped (long or None) – The dropped packets or bytes format: int64
multicast_broadcast (long or None) – The multicast and broadcast packets or bytes format: int64
total (long) – The total packets or bytes format: int64

class com.vmware.nsx_policy.model_client.DataSourceParameters(source=None)¶

Bases: vmware.vapi.bindings.struct.VapiStruct

Tip

The arguments are used to initialize data attributes with the same names.

Parameters

source (str or None) –

Possible values are:

DataSourceParameters.SOURCE_REALTIME
DataSourceParameters.SOURCE_CACHED

The data source, either realtime or cached. If not provided, cached data is returned.

SOURCE_CACHED = 'cached'¶

SOURCE_REALTIME = 'realtime'¶

class com.vmware.nsx_policy.model_client.Datasource(display_name=None, urls=None)¶

Bases: vmware.vapi.bindings.struct.VapiStruct

An instance of a datasource configuration.

Tip

The arguments are used to initialize data attributes with the same names.

Parameters

display_name (str) – Name of a datasource instance.
urls (list of UrlAlias) – Array of urls relative to the datasource configuration. For example, api/v1/fabric/nodes is a relative url of nsx-manager instance.

class com.vmware.nsx_policy.model_client.DeleteRequestParameters(force=None)¶

Bases: vmware.vapi.bindings.struct.VapiStruct

Parameters that affect how delete operations are processed

Tip

The arguments are used to initialize data attributes with the same names.

Parameters: force (bool or None) – If true, deleting the resource succeeds even if it is being referred as a resource reference.

class com.vmware.nsx_policy.model_client.DeploymentTemplate(attributes=None, name=None)¶

Bases: vmware.vapi.bindings.struct.VapiStruct

Deployment Template holds the attributes specific to partner for which the service is created. These attributes are opaque to NSX.

Tip

The arguments are used to initialize data attributes with the same names.

Parameters

attributes (list of Attribute or None) – List of attributes specific to a partner for which the service is created. There attributes are passed on to the partner appliance and is opaque to the NSX Manager.
name (str or None) – Deployment Template name.

class com.vmware.nsx_policy.model_client.DeploymentZone(links=None, schema=None, self_=None, revision=None, create_time=None, create_user=None, last_modified_time=None, last_modified_user=None, protection=None, system_owned=None, description=None, display_name=None, id=None, resource_type=None, tags=None, parent_path=None, path=None, relative_path=None, children=None, marked_for_delete=None, enforcement_points=None)¶

Bases: vmware.vapi.bindings.struct.VapiStruct

Logical grouping of enforcement points. This is a deprecated type. DeploymentZone has been renamed to Site. Use Site.

Tip

The arguments are used to initialize data attributes with the same names.

Parameters

links (list of ResourceLink or None) – The server will populate this field when returing the resource. Ignored on PUT and POST. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
schema (str or None) – Schema for this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
self (SelfResourceLink or None) – Link to this resource
revision (long or None) – The _revision property describes the current revision of the resource. To prevent clients from overwriting each other’s changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected. format: int32
create_time (long or None) – Timestamp of resource creation format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
create_user (str or None) – ID of the user who created this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
last_modified_time (long or None) – Timestamp of last modification format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
last_modified_user (str or None) – ID of the user who last modified this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
protection (str or None) – Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super user and can modify it, but only when providing the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this entity. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
system_owned (bool or None) – Indicates system owned resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
description (str or None) – Description of this resource
display_name (str or None) – Defaults to ID if not set
id (str or None) – Unique identifier of this resource
resource_type (str or None) – The type of this resource.
tags (list of Tag or None) – Opaque identifiers meaningful to the API user
parent_path (str or None) – Path of its parent This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
path (str or None) – Absolute path of this object This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
relative_path (str or None) – Path relative from its parent This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
children (list of vmware.vapi.struct.VapiStruct or None) – subtree for this type within policy tree containing nested elements. When clients pass a value of this class as a parameter, the attribute must contain all the attributes defined in ChildPolicyConfigResource. When methods return a value of this class as a return value, the attribute will contain all the attributes defined in ChildPolicyConfigResource.
marked_for_delete (bool or None) – Intent objects are not directly deleted from the system when a delete is invoked on them. They are marked for deletion and only when all the realized entities for that intent object gets deleted, the intent object is deleted. Objects that are marked for deletion are not returned in GET call. One can use the search API to get these objects. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
enforcement_points (list of EnforcementPoint or None) – Logical grouping of enforcement points

class com.vmware.nsx_policy.model_client.DfwFirewallConfiguration(idfw_enabled=None, links=None, schema=None, self_=None, revision=None, create_time=None, create_user=None, last_modified_time=None, last_modified_user=None, protection=None, system_owned=None, description=None, display_name=None, id=None, resource_type='DfwFirewallConfiguration', tags=None, parent_path=None, path=None, relative_path=None, children=None, marked_for_delete=None, disable_auto_drafts=None, enable_firewall=None)¶

Bases: vmware.vapi.bindings.struct.VapiStruct

DFW Firewall related configurations

Tip

The arguments are used to initialize data attributes with the same names.

Parameters

idfw_enabled (bool or None) – If set to true, identity firewall is enabled.
links (list of ResourceLink or None) – The server will populate this field when returing the resource. Ignored on PUT and POST. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
schema (str or None) – Schema for this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
self (SelfResourceLink or None) – Link to this resource
revision (long or None) – The _revision property describes the current revision of the resource. To prevent clients from overwriting each other’s changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected. format: int32
create_time (long or None) – Timestamp of resource creation format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
create_user (str or None) – ID of the user who created this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
last_modified_time (long or None) – Timestamp of last modification format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
last_modified_user (str or None) – ID of the user who last modified this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
protection (str or None) – Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super user and can modify it, but only when providing the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this entity. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
system_owned (bool or None) – Indicates system owned resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
description (str or None) – Description of this resource
display_name (str or None) – Defaults to ID if not set
id (str or None) – Unique identifier of this resource
resource_type (str) –
Possible values are:
- FirewallConfiguration.RESOURCE_TYPE_DFWFIREWALLCONFIGURATION
tags (list of Tag or None) – Opaque identifiers meaningful to the API user
parent_path (str or None) – Path of its parent This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
path (str or None) – Absolute path of this object This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
relative_path (str or None) – Path relative from its parent This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
children (list of vmware.vapi.struct.VapiStruct or None) – subtree for this type within policy tree containing nested elements. When clients pass a value of this class as a parameter, the attribute must contain all the attributes defined in ChildPolicyConfigResource. When methods return a value of this class as a return value, the attribute will contain all the attributes defined in ChildPolicyConfigResource.
marked_for_delete (bool or None) – Intent objects are not directly deleted from the system when a delete is invoked on them. They are marked for deletion and only when all the realized entities for that intent object gets deleted, the intent object is deleted. Objects that are marked for deletion are not returned in GET call. One can use the search API to get these objects. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
disable_auto_drafts (bool or None) – To disable auto drafts, set it to true. By default, auto drafts are enabled.
enable_firewall (bool or None) – If set to true, Firewall is enabled.

property resource_type¶: Return the discriminator value

class com.vmware.nsx_policy.model_client.DhcpRelayConfig(links=None, schema=None, self_=None, revision=None, create_time=None, create_user=None, last_modified_time=None, last_modified_user=None, protection=None, system_owned=None, description=None, display_name=None, id=None, resource_type=None, tags=None, parent_path=None, path=None, relative_path=None, children=None, marked_for_delete=None, server_addresses=None)¶

Bases: vmware.vapi.bindings.struct.VapiStruct

DHCP relay configuration

Tip

The arguments are used to initialize data attributes with the same names.

Parameters

links (list of ResourceLink or None) – The server will populate this field when returing the resource. Ignored on PUT and POST. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
schema (str or None) – Schema for this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
self (SelfResourceLink or None) – Link to this resource
revision (long or None) – The _revision property describes the current revision of the resource. To prevent clients from overwriting each other’s changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected. format: int32
create_time (long or None) – Timestamp of resource creation format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
create_user (str or None) – ID of the user who created this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
last_modified_time (long or None) – Timestamp of last modification format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
last_modified_user (str or None) – ID of the user who last modified this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
protection (str or None) – Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super user and can modify it, but only when providing the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this entity. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
system_owned (bool or None) – Indicates system owned resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
description (str or None) – Description of this resource
display_name (str or None) – Defaults to ID if not set
id (str or None) – Unique identifier of this resource
resource_type (str or None) – The type of this resource.
tags (list of Tag or None) – Opaque identifiers meaningful to the API user
parent_path (str or None) – Path of its parent This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
path (str or None) – Absolute path of this object This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
relative_path (str or None) – Path relative from its parent This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
children (list of vmware.vapi.struct.VapiStruct or None) – subtree for this type within policy tree containing nested elements. When clients pass a value of this class as a parameter, the attribute must contain all the attributes defined in ChildPolicyConfigResource. When methods return a value of this class as a return value, the attribute will contain all the attributes defined in ChildPolicyConfigResource.
marked_for_delete (bool or None) – Intent objects are not directly deleted from the system when a delete is invoked on them. They are marked for deletion and only when all the realized entities for that intent object gets deleted, the intent object is deleted. Objects that are marked for deletion are not returned in GET call. One can use the search API to get these objects. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
server_addresses (list of str) – DHCP server IP addresses for DHCP relay configuration. Both IPv4 and IPv6 addresses are supported. format: ip

class com.vmware.nsx_policy.model_client.DhcpRelayConfigListResult(links=None, schema=None, self_=None, cursor=None, result_count=None, sort_ascending=None, sort_by=None, results=None)¶

Bases: vmware.vapi.bindings.struct.VapiStruct

Paged collection of DhcpRelayConfigs

Tip

The arguments are used to initialize data attributes with the same names.

Parameters

links (list of ResourceLink or None) – The server will populate this field when returing the resource. Ignored on PUT and POST. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
schema (str or None) – Schema for this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
self (SelfResourceLink or None) – Link to this resource
cursor (str or None) – Opaque cursor to be used for getting next page of records (supplied by current result page) This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
result_count (long or None) – Count of results found (across all pages), set only on first page format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
sort_ascending (bool or None) – If true, results are sorted in ascending order This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
sort_by (str or None) – Field by which records are sorted This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
results (list of DhcpRelayConfig) – DhcpRelayConfig results

class com.vmware.nsx_policy.model_client.DhcpServerConfig(links=None, schema=None, self_=None, revision=None, create_time=None, create_user=None, last_modified_time=None, last_modified_user=None, protection=None, system_owned=None, description=None, display_name=None, id=None, resource_type=None, tags=None, parent_path=None, path=None, relative_path=None, children=None, marked_for_delete=None, edge_cluster_path=None, lease_time=None, server_address=None)¶

Bases: vmware.vapi.bindings.struct.VapiStruct

DHCP server configuration

Tip

The arguments are used to initialize data attributes with the same names.

Parameters

links (list of ResourceLink or None) – The server will populate this field when returing the resource. Ignored on PUT and POST. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
schema (str or None) – Schema for this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
self (SelfResourceLink or None) – Link to this resource
revision (long or None) – The _revision property describes the current revision of the resource. To prevent clients from overwriting each other’s changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected. format: int32
create_time (long or None) – Timestamp of resource creation format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
create_user (str or None) – ID of the user who created this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
last_modified_time (long or None) – Timestamp of last modification format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
last_modified_user (str or None) – ID of the user who last modified this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
protection (str or None) – Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super user and can modify it, but only when providing the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this entity. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
system_owned (bool or None) – Indicates system owned resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
description (str or None) – Description of this resource
display_name (str or None) – Defaults to ID if not set
id (str or None) – Unique identifier of this resource
resource_type (str or None) – The type of this resource.
tags (list of Tag or None) – Opaque identifiers meaningful to the API user
parent_path (str or None) – Path of its parent This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
path (str or None) – Absolute path of this object This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
relative_path (str or None) – Path relative from its parent This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
children (list of vmware.vapi.struct.VapiStruct or None) – subtree for this type within policy tree containing nested elements. When clients pass a value of this class as a parameter, the attribute must contain all the attributes defined in ChildPolicyConfigResource. When methods return a value of this class as a return value, the attribute will contain all the attributes defined in ChildPolicyConfigResource.
marked_for_delete (bool or None) – Intent objects are not directly deleted from the system when a delete is invoked on them. They are marked for deletion and only when all the realized entities for that intent object gets deleted, the intent object is deleted. Objects that are marked for deletion are not returned in GET call. One can use the search API to get these objects. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
edge_cluster_path (str or None) – Edge cluster path. Auto assigned if only one edge cluster is configured on enforcement-point.
lease_time (long or None) – IP address lease time in seconds. format: int64
server_address (str) – DHCP server address in CIDR format. Prefix length should be less than or equal to 30. DHCP server is deployed as DHCP relay service. IPv6 is not supported. format: ip-cidr-block

class com.vmware.nsx_policy.model_client.DhcpServerConfigListResult(links=None, schema=None, self_=None, cursor=None, result_count=None, sort_ascending=None, sort_by=None, results=None)¶

Bases: vmware.vapi.bindings.struct.VapiStruct

Paged collection of DhcpServerConfigs

Tip

The arguments are used to initialize data attributes with the same names.

Parameters

links (list of ResourceLink or None) – The server will populate this field when returing the resource. Ignored on PUT and POST. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
schema (str or None) – Schema for this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
self (SelfResourceLink or None) – Link to this resource
cursor (str or None) – Opaque cursor to be used for getting next page of records (supplied by current result page) This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
result_count (long or None) – Count of results found (across all pages), set only on first page format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
sort_ascending (bool or None) – If true, results are sorted in ascending order This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
sort_by (str or None) – Field by which records are sorted This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
results (list of DhcpServerConfig) – DhcpServerConfig results

class com.vmware.nsx_policy.model_client.DiscoveredNode(certificate=None, cm_local_id=None, external_id=None, hardware_id=None, ip_addresses=None, node_type=None, origin_id=None, origin_properties=None, os_type=None, os_version=None, parent_compute_collection=None, stateless=None, links=None, schema=None, self_=None, last_sync_time=None, description=None, display_name=None, resource_type='DiscoveredNode', tags=None)¶

Bases: vmware.vapi.bindings.struct.VapiStruct

Tip

The arguments are used to initialize data attributes with the same names.

Parameters

certificate (str or None) – Certificate of the discovered node
cm_local_id (str or None) – Local Id of the discovered node in the Compute Manager This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
external_id (str or None) – External id of the discovered node, ex. a mo-ref from VC This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
hardware_id (str or None) – Hardware Id is generated using system hardware info. It is used to retrieve fabric node of the esx. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
ip_addresses (list of str or None) – IP Addresses of the the discovered node. format: ip This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
node_type (str or None) – Discovered Node type like Host This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
origin_id (str or None) – Id of the compute manager from where this node was discovered This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
origin_properties (list of KeyValuePair or None) – Key-Value map of additional specific properties of discovered node in the Compute Manager This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
os_type (str or None) – OS type of the discovered node This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
os_version (str or None) – OS version of the discovered node This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
parent_compute_collection (str or None) – External id of the compute collection to which this node belongs This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
stateless (bool or None) – The stateless property describes whether host persists its state across reboot or not. If state persists, value is set as false otherwise true. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
links (list of ResourceLink or None) – The server will populate this field when returing the resource. Ignored on PUT and POST. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
schema (str or None) – Schema for this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
self (SelfResourceLink or None) – Link to this resource
last_sync_time (long or None) – Timestamp of last modification format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
description (str or None) – Description of this resource
display_name (str or None) – Defaults to ID if not set
resource_type (str) – The type of this resource.
tags (list of Tag or None) – Opaque identifiers meaningful to the API user

property resource_type¶: Return the discriminator value

class com.vmware.nsx_policy.model_client.DiscoveredResource(links=None, schema=None, self_=None, last_sync_time=None, description=None, display_name=None, resource_type='DiscoveredResource', tags=None)¶

Bases: vmware.vapi.bindings.struct.VapiStruct

Base class for resources that are discovered and automatically updated

Tip

The arguments are used to initialize data attributes with the same names.

Parameters

links (list of ResourceLink or None) – The server will populate this field when returing the resource. Ignored on PUT and POST. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
schema (str or None) – Schema for this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
self (SelfResourceLink or None) – Link to this resource
last_sync_time (long or None) – Timestamp of last modification format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
description (str or None) – Description of this resource
display_name (str or None) – Defaults to ID if not set
resource_type (str) – The type of this resource.
tags (list of Tag or None) – Opaque identifiers meaningful to the API user

property resource_type¶: Return the discriminator value

class com.vmware.nsx_policy.model_client.DiscoveryProfileBindingMap(links=None, schema=None, self_=None, revision=None, create_time=None, create_user=None, last_modified_time=None, last_modified_user=None, protection=None, system_owned=None, description=None, display_name=None, id=None, resource_type=None, tags=None, parent_path=None, path=None, relative_path=None, children=None, marked_for_delete=None)¶

Bases: vmware.vapi.bindings.struct.VapiStruct

Base Discovery Profile Binding Map

Tip

The arguments are used to initialize data attributes with the same names.

Parameters

links (list of ResourceLink or None) – The server will populate this field when returing the resource. Ignored on PUT and POST. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
schema (str or None) – Schema for this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
self (SelfResourceLink or None) – Link to this resource
revision (long or None) – The _revision property describes the current revision of the resource. To prevent clients from overwriting each other’s changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected. format: int32
create_time (long or None) – Timestamp of resource creation format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
create_user (str or None) – ID of the user who created this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
last_modified_time (long or None) – Timestamp of last modification format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
last_modified_user (str or None) – ID of the user who last modified this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
protection (str or None) – Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super user and can modify it, but only when providing the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this entity. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
system_owned (bool or None) – Indicates system owned resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
description (str or None) – Description of this resource
display_name (str or None) – Defaults to ID if not set
id (str or None) – Unique identifier of this resource
resource_type (str or None) – The type of this resource.
tags (list of Tag or None) – Opaque identifiers meaningful to the API user
parent_path (str or None) – Path of its parent This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
path (str or None) – Absolute path of this object This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
relative_path (str or None) – Path relative from its parent This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
children (list of vmware.vapi.struct.VapiStruct or None) – subtree for this type within policy tree containing nested elements. When clients pass a value of this class as a parameter, the attribute must contain all the attributes defined in ChildPolicyConfigResource. When methods return a value of this class as a return value, the attribute will contain all the attributes defined in ChildPolicyConfigResource.
marked_for_delete (bool or None) – Intent objects are not directly deleted from the system when a delete is invoked on them. They are marked for deletion and only when all the realized entities for that intent object gets deleted, the intent object is deleted. Objects that are marked for deletion are not returned in GET call. One can use the search API to get these objects. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.

class com.vmware.nsx_policy.model_client.DistributedFloodProtectionProfile(enable_rst_spoofing=None, enable_syncache=None, links=None, schema=None, self_=None, revision=None, create_time=None, create_user=None, last_modified_time=None, last_modified_user=None, protection=None, system_owned=None, description=None, display_name=None, id=None, resource_type='DistributedFloodProtectionProfile', tags=None, parent_path=None, path=None, relative_path=None, children=None, marked_for_delete=None, icmp_active_flow_limit=None, other_active_conn_limit=None, tcp_half_open_conn_limit=None, udp_active_flow_limit=None)¶

Bases: vmware.vapi.bindings.struct.VapiStruct

Tip

The arguments are used to initialize data attributes with the same names.

Parameters

enable_rst_spoofing (bool or None) – If set to true, rst spoofing will be enabled. Flag is used only for distributed firewall profiles.
enable_syncache (bool or None) – If set to true, sync cache will be enabled. Flag is used only for distributed firewall profiles.
links (list of ResourceLink or None) – The server will populate this field when returing the resource. Ignored on PUT and POST. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
schema (str or None) – Schema for this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
self (SelfResourceLink or None) – Link to this resource
revision (long or None) – The _revision property describes the current revision of the resource. To prevent clients from overwriting each other’s changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected. format: int32
create_time (long or None) – Timestamp of resource creation format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
create_user (str or None) – ID of the user who created this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
last_modified_time (long or None) – Timestamp of last modification format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
last_modified_user (str or None) – ID of the user who last modified this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
protection (str or None) – Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super user and can modify it, but only when providing the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this entity. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
system_owned (bool or None) – Indicates system owned resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
description (str or None) – Description of this resource
display_name (str or None) – Defaults to ID if not set
id (str or None) – Unique identifier of this resource
resource_type (str) –
Possible values are:
- FloodProtectionProfile.RESOURCE_TYPE_GATEWAYFLOODPROTECTIONPROFILE
- FloodProtectionProfile.RESOURCE_TYPE_DISTRIBUTEDFLOODPROTECTIONPROFILE
GatewayFloodProtectionProfile is used for all Tier0 and Tier1 gateways. DistributedFloodProtectionProfile is used for all Transport Nodes.
tags (list of Tag or None) – Opaque identifiers meaningful to the API user
parent_path (str or None) – Path of its parent This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
path (str or None) – Absolute path of this object This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
relative_path (str or None) – Path relative from its parent This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
children (list of vmware.vapi.struct.VapiStruct or None) – subtree for this type within policy tree containing nested elements. When clients pass a value of this class as a parameter, the attribute must contain all the attributes defined in ChildPolicyConfigResource. When methods return a value of this class as a return value, the attribute will contain all the attributes defined in ChildPolicyConfigResource.
marked_for_delete (bool or None) – Intent objects are not directly deleted from the system when a delete is invoked on them. They are marked for deletion and only when all the realized entities for that intent object gets deleted, the intent object is deleted. Objects that are marked for deletion are not returned in GET call. One can use the search API to get these objects. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
icmp_active_flow_limit (long or None) – If this field is empty, firewall will not set a limit to active ICMP connections. format: int64
other_active_conn_limit (long or None) – If this field is empty, firewall will not set a limit to other active connections. besides UDP, ICMP and half open TCP connections. format: int64
tcp_half_open_conn_limit (long or None) – If this field is empty, firewall will not set a limit to half open TCP connections. format: int64
udp_active_flow_limit (long or None) – If this field is empty, firewall will not set a limit to active UDP connections. format: int64

property resource_type¶: Return the discriminator value

class com.vmware.nsx_policy.model_client.DnsSecurityProfile(links=None, schema=None, self_=None, revision=None, create_time=None, create_user=None, last_modified_time=None, last_modified_user=None, protection=None, system_owned=None, description=None, display_name=None, id=None, resource_type=None, tags=None, parent_path=None, path=None, relative_path=None, children=None, marked_for_delete=None, ttl=None)¶

Bases: vmware.vapi.bindings.struct.VapiStruct

Used to configure DNS security profile

Tip

The arguments are used to initialize data attributes with the same names.

Parameters

links (list of ResourceLink or None) – The server will populate this field when returing the resource. Ignored on PUT and POST. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
schema (str or None) – Schema for this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
self (SelfResourceLink or None) – Link to this resource
revision (long or None) – The _revision property describes the current revision of the resource. To prevent clients from overwriting each other’s changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected. format: int32
create_time (long or None) – Timestamp of resource creation format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
create_user (str or None) – ID of the user who created this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
last_modified_time (long or None) – Timestamp of last modification format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
last_modified_user (str or None) – ID of the user who last modified this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
protection (str or None) – Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super user and can modify it, but only when providing the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this entity. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
system_owned (bool or None) – Indicates system owned resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
description (str or None) – Description of this resource
display_name (str or None) – Defaults to ID if not set
id (str or None) – Unique identifier of this resource
resource_type (str or None) – The type of this resource.
tags (list of Tag or None) – Opaque identifiers meaningful to the API user
parent_path (str or None) – Path of its parent This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
path (str or None) – Absolute path of this object This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
relative_path (str or None) – Path relative from its parent This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
children (list of vmware.vapi.struct.VapiStruct or None) – subtree for this type within policy tree containing nested elements. When clients pass a value of this class as a parameter, the attribute must contain all the attributes defined in ChildPolicyConfigResource. When methods return a value of this class as a return value, the attribute will contain all the attributes defined in ChildPolicyConfigResource.
marked_for_delete (bool or None) – Intent objects are not directly deleted from the system when a delete is invoked on them. They are marked for deletion and only when all the realized entities for that intent object gets deleted, the intent object is deleted. Objects that are marked for deletion are not returned in GET call. One can use the search API to get these objects. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
ttl (long or None) – Time to live for DNS cache entry in seconds. Valid TTL values are between 3600 to 864000. However, this field accepts values between 0 through 864000. We define TTL type based on the value of TTL as follows: TTL 0 - cached entry never expires. TTL 1 to 3599 - invalid input and error is thrown TTL 3600 to 864000 - ttl is set to user input TTL field not set by user - TTL type is ‘AUTO’ and ttl value is set from DNS response packet. User defined TTL value is used only when it is betweeen 3600 to 864000. format: int64

class com.vmware.nsx_policy.model_client.DnsSecurityProfileBindingMap(links=None, schema=None, self_=None, revision=None, create_time=None, create_user=None, last_modified_time=None, last_modified_user=None, protection=None, system_owned=None, description=None, display_name=None, id=None, resource_type=None, tags=None, parent_path=None, path=None, relative_path=None, children=None, marked_for_delete=None, profile_path=None, sequence_number=None)¶

Bases: vmware.vapi.bindings.struct.VapiStruct

This entity will be used to establish association between DNS security profile and Group. With this entity, user can specify intent for applying DNS security profile profile to particular Group.

Tip

The arguments are used to initialize data attributes with the same names.

Parameters

links (list of ResourceLink or None) – The server will populate this field when returing the resource. Ignored on PUT and POST. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
schema (str or None) – Schema for this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
self (SelfResourceLink or None) – Link to this resource
revision (long or None) – The _revision property describes the current revision of the resource. To prevent clients from overwriting each other’s changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected. format: int32
create_time (long or None) – Timestamp of resource creation format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
create_user (str or None) – ID of the user who created this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
last_modified_time (long or None) – Timestamp of last modification format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
last_modified_user (str or None) – ID of the user who last modified this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
protection (str or None) – Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super user and can modify it, but only when providing the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this entity. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
system_owned (bool or None) – Indicates system owned resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
description (str or None) – Description of this resource
display_name (str or None) – Defaults to ID if not set
id (str or None) – Unique identifier of this resource
resource_type (str or None) – The type of this resource.
tags (list of Tag or None) – Opaque identifiers meaningful to the API user
parent_path (str or None) – Path of its parent This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
path (str or None) – Absolute path of this object This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
relative_path (str or None) – Path relative from its parent This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
children (list of vmware.vapi.struct.VapiStruct or None) – subtree for this type within policy tree containing nested elements. When clients pass a value of this class as a parameter, the attribute must contain all the attributes defined in ChildPolicyConfigResource. When methods return a value of this class as a return value, the attribute will contain all the attributes defined in ChildPolicyConfigResource.
marked_for_delete (bool or None) – Intent objects are not directly deleted from the system when a delete is invoked on them. They are marked for deletion and only when all the realized entities for that intent object gets deleted, the intent object is deleted. Objects that are marked for deletion are not returned in GET call. One can use the search API to get these objects. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
profile_path (str) – PolicyPath of associated Profile
sequence_number (long or None) – Sequence number used to resolve conflicts betweeen two profiles applied on the same group. Lower sequence number takes higher precedence. Two binding maps applied to the same profile must have the same sequence number. User defined sequence numbers range from 1 through 100,000. System defined sequence numbers range from 100,001 through 200,000. format: int64

class com.vmware.nsx_policy.model_client.DnsSecurityProfileBindingMapListResult(links=None, schema=None, self_=None, cursor=None, result_count=None, sort_ascending=None, sort_by=None, results=None)¶

Bases: vmware.vapi.bindings.struct.VapiStruct

Paged collection of DNS Security Profile Binding Map

Tip

The arguments are used to initialize data attributes with the same names.

Parameters

links (list of ResourceLink or None) – The server will populate this field when returing the resource. Ignored on PUT and POST. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
schema (str or None) – Schema for this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
self (SelfResourceLink or None) – Link to this resource
cursor (str or None) – Opaque cursor to be used for getting next page of records (supplied by current result page) This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
result_count (long or None) – Count of results found (across all pages), set only on first page format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
sort_ascending (bool or None) – If true, results are sorted in ascending order This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
sort_by (str or None) – Field by which records are sorted This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
results (list of DnsSecurityProfileBindingMap or None) – DNS Security Profile Binding Map List Results

class com.vmware.nsx_policy.model_client.DnsSecurityProfileListResult(links=None, schema=None, self_=None, cursor=None, result_count=None, sort_ascending=None, sort_by=None, results=None)¶

Bases: vmware.vapi.bindings.struct.VapiStruct

Paged Collection of DnsSecurityProfile

Tip

The arguments are used to initialize data attributes with the same names.

Parameters

links (list of ResourceLink or None) – The server will populate this field when returing the resource. Ignored on PUT and POST. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
schema (str or None) – Schema for this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
self (SelfResourceLink or None) – Link to this resource
cursor (str or None) – Opaque cursor to be used for getting next page of records (supplied by current result page) This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
result_count (long or None) – Count of results found (across all pages), set only on first page format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
sort_ascending (bool or None) – If true, results are sorted in ascending order This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
sort_by (str or None) – Field by which records are sorted This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
results (list of DnsSecurityProfile) – DnsSecurityProfile list results

class com.vmware.nsx_policy.model_client.Domain(links=None, schema=None, self_=None, revision=None, create_time=None, create_user=None, last_modified_time=None, last_modified_user=None, protection=None, system_owned=None, description=None, display_name=None, id=None, resource_type=None, tags=None, parent_path=None, path=None, relative_path=None, children=None, marked_for_delete=None)¶

Bases: vmware.vapi.bindings.struct.VapiStruct

Domain.

Tip

The arguments are used to initialize data attributes with the same names.

Parameters

links (list of ResourceLink or None) – The server will populate this field when returing the resource. Ignored on PUT and POST. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
schema (str or None) – Schema for this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
self (SelfResourceLink or None) – Link to this resource
revision (long or None) – The _revision property describes the current revision of the resource. To prevent clients from overwriting each other’s changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected. format: int32
create_time (long or None) – Timestamp of resource creation format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
create_user (str or None) – ID of the user who created this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
last_modified_time (long or None) – Timestamp of last modification format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
last_modified_user (str or None) – ID of the user who last modified this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
protection (str or None) – Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super user and can modify it, but only when providing the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this entity. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
system_owned (bool or None) – Indicates system owned resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
description (str or None) – Description of this resource
display_name (str or None) – Defaults to ID if not set
id (str or None) – Unique identifier of this resource
resource_type (str or None) – The type of this resource.
tags (list of Tag or None) – Opaque identifiers meaningful to the API user
parent_path (str or None) – Path of its parent This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
path (str or None) – Absolute path of this object This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
relative_path (str or None) – Path relative from its parent This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
children (list of vmware.vapi.struct.VapiStruct or None) – subtree for this type within policy tree containing nested elements. When clients pass a value of this class as a parameter, the attribute must contain all the attributes defined in ChildPolicyConfigResource. When methods return a value of this class as a return value, the attribute will contain all the attributes defined in ChildPolicyConfigResource.
marked_for_delete (bool or None) – Intent objects are not directly deleted from the system when a delete is invoked on them. They are marked for deletion and only when all the realized entities for that intent object gets deleted, the intent object is deleted. Objects that are marked for deletion are not returned in GET call. One can use the search API to get these objects. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.

class com.vmware.nsx_policy.model_client.DomainDeploymentMap(links=None, schema=None, self_=None, revision=None, create_time=None, create_user=None, last_modified_time=None, last_modified_user=None, protection=None, system_owned=None, description=None, display_name=None, id=None, resource_type=None, tags=None, parent_path=None, path=None, relative_path=None, children=None, marked_for_delete=None, enforcement_point_path=None)¶

Bases: vmware.vapi.bindings.struct.VapiStruct

Binding of domains to the enforcement point.

Tip

The arguments are used to initialize data attributes with the same names.

Parameters

links (list of ResourceLink or None) – The server will populate this field when returing the resource. Ignored on PUT and POST. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
schema (str or None) – Schema for this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
self (SelfResourceLink or None) – Link to this resource
revision (long or None) – The _revision property describes the current revision of the resource. To prevent clients from overwriting each other’s changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected. format: int32
create_time (long or None) – Timestamp of resource creation format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
create_user (str or None) – ID of the user who created this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
last_modified_time (long or None) – Timestamp of last modification format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
last_modified_user (str or None) – ID of the user who last modified this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
protection (str or None) – Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super user and can modify it, but only when providing the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this entity. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
system_owned (bool or None) – Indicates system owned resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
description (str or None) – Description of this resource
display_name (str or None) – Defaults to ID if not set
id (str or None) – Unique identifier of this resource
resource_type (str or None) – The type of this resource.
tags (list of Tag or None) – Opaque identifiers meaningful to the API user
parent_path (str or None) – Path of its parent This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
path (str or None) – Absolute path of this object This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
relative_path (str or None) – Path relative from its parent This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
children (list of vmware.vapi.struct.VapiStruct or None) – subtree for this type within policy tree containing nested elements. When clients pass a value of this class as a parameter, the attribute must contain all the attributes defined in ChildPolicyConfigResource. When methods return a value of this class as a return value, the attribute will contain all the attributes defined in ChildPolicyConfigResource.
marked_for_delete (bool or None) – Intent objects are not directly deleted from the system when a delete is invoked on them. They are marked for deletion and only when all the realized entities for that intent object gets deleted, the intent object is deleted. Objects that are marked for deletion are not returned in GET call. One can use the search API to get these objects. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
enforcement_point_path (str) – Path of enforcement point on which domain will be deployed

class com.vmware.nsx_policy.model_client.DomainListResult(links=None, schema=None, self_=None, cursor=None, result_count=None, sort_ascending=None, sort_by=None, results=None)¶

Bases: vmware.vapi.bindings.struct.VapiStruct

Paged Collection of Domains

Tip

The arguments are used to initialize data attributes with the same names.

Parameters

links (list of ResourceLink or None) – The server will populate this field when returing the resource. Ignored on PUT and POST. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
schema (str or None) – Schema for this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
self (SelfResourceLink or None) – Link to this resource
cursor (str or None) – Opaque cursor to be used for getting next page of records (supplied by current result page) This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
result_count (long or None) – Count of results found (across all pages), set only on first page format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
sort_ascending (bool or None) – If true, results are sorted in ascending order This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
sort_by (str or None) – Field by which records are sorted This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
results (list of Domain) – Domain list results

class com.vmware.nsx_policy.model_client.DonutConfiguration(display_count=None, label=None, navigation=None, sections=None, links=None, schema=None, self_=None, revision=None, create_time=None, create_user=None, last_modified_time=None, last_modified_user=None, protection=None, system_owned=None, description=None, display_name=None, id=None, resource_type='DonutConfiguration', tags=None, datasources=None, drilldown_id=None, footer=None, icons=None, is_drilldown=None, legend=None, shared=None, weight=None)¶

Bases: vmware.vapi.bindings.struct.VapiStruct

Represents configuration of a Donut

Tip

The arguments are used to initialize data attributes with the same names.

Parameters

display_count (bool or None) – If true, displays the count of entities in the donut
label (Label or None) – Displayed at the middle of the donut, by default. It labels the entities of donut.
navigation (str or None) – Hyperlink of the specified UI page that provides details.
sections (list of DonutSection) – Sections
links (list of ResourceLink or None) – The server will populate this field when returing the resource. Ignored on PUT and POST. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
schema (str or None) – Schema for this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
self (SelfResourceLink or None) – Link to this resource
revision (long or None) – The _revision property describes the current revision of the resource. To prevent clients from overwriting each other’s changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected. format: int32
create_time (long or None) – Timestamp of resource creation format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
create_user (str or None) – ID of the user who created this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
last_modified_time (long or None) – Timestamp of last modification format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
last_modified_user (str or None) – ID of the user who last modified this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
protection (str or None) – Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super user and can modify it, but only when providing the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this entity. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
system_owned (bool or None) – Indicates system owned resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
description (str or None) – Description of this resource
display_name (str or None) – Title of the widget. If display_name is omitted, the widget will be shown without a title.
id (str or None) – Unique identifier of this resource
resource_type (str) –
Possible values are:
- WidgetConfiguration.RESOURCE_TYPE_LABELVALUECONFIGURATION
- WidgetConfiguration.RESOURCE_TYPE_DONUTCONFIGURATION
- WidgetConfiguration.RESOURCE_TYPE_MULTIWIDGETCONFIGURATION
- WidgetConfiguration.RESOURCE_TYPE_CONTAINERCONFIGURATION
- WidgetConfiguration.RESOURCE_TYPE_STATSCONFIGURATION
- WidgetConfiguration.RESOURCE_TYPE_GRIDCONFIGURATION
- WidgetConfiguration.RESOURCE_TYPE_GRAPHCONFIGURATION
Supported visualization types are LabelValueConfiguration, DonutConfiguration, GridConfiguration, StatsConfiguration, MultiWidgetConfiguration, GraphConfiguration and ContainerConfiguration.
tags (list of Tag or None) – Opaque identifiers meaningful to the API user
datasources (list of Datasource or None) – The ‘datasources’ represent the sources from which data will be fetched. Currently, only NSX-API is supported as a ‘default’ datasource. An example of specifying ‘default’ datasource along with the urls to fetch data from is given at ‘example_request’ section of ‘CreateWidgetConfiguration’ API.
drilldown_id (str or None) – Id of drilldown widget, if any. Id should be a valid id of an existing widget. A widget is considered as drilldown widget when it is associated with any other widget and provides more detailed information about any data item from the parent widget.
footer (Footer or None) –
icons (list of Icon or None) – Icons to be applied at dashboard for widgets and UI elements.
is_drilldown (bool or None) – Set to true if this widget should be used as a drilldown.
legend (Legend or None) – Legend to be displayed. If legend is not needed, do not include it.
shared (bool or None) – Please use the property ‘shared’ of View instead of this. The widgets of a shared view are visible to other users.
weight (long or None) – Specify relavite weight in WidgetItem for placement in a view. Please see WidgetItem for details. format: int32

property resource_type¶: Return the discriminator value

class com.vmware.nsx_policy.model_client.DonutPart(drilldown_id=None, field=None, label=None, navigation=None, render_configuration=None, tooltip=None)¶

Bases: vmware.vapi.bindings.struct.VapiStruct

Represents an entity or portion to be plotted on a donut or stats chart.

Tip

The arguments are used to initialize data attributes with the same names.

Parameters

drilldown_id (str or None) – Id of drilldown widget, if any. Id should be a valid id of an existing widget. A widget is considered as drilldown widget when it is associated with any other widget and provides more detailed information about any data item from the parent widget.
field (str) – A numerical value that represents the portion or entity of the donut or stats chart.
label (Label or None) – If a section ‘template’ holds this donut or stats part, then the label is auto-generated from the fetched field values after applying the template.
navigation (str or None) – Hyperlink of the specified UI page that provides details. If drilldown_id is provided, then navigation cannot be used.
render_configuration (list of RenderConfiguration or None) – Additional rendering or conditional evaluation of the field values to be performed, if any.
tooltip (list of Tooltip or None) – Multi-line text to be shown on tooltip while hovering over the portion.

class com.vmware.nsx_policy.model_client.DonutSection(parts=None, row_list_field=None, template=None)¶

Bases: vmware.vapi.bindings.struct.VapiStruct

Represents high level logical grouping of portions or segments of a donut / stats chart.

Tip

The arguments are used to initialize data attributes with the same names.

Parameters

parts (list of DonutPart) – Array of portions or parts of the donut or stats chart.
row_list_field (str or None) – Field of the root of the api result set for forming parts.
template (bool or None) – If true, the section will be appled as template for forming parts. Only one part will be formed from each element of ‘row_list_field’.

class com.vmware.nsx_policy.model_client.DuplicateIPDetectionOptions(duplicate_ip_detection_enabled=None)¶

Bases: vmware.vapi.bindings.struct.VapiStruct

Contains dupliacte IP detection related discovery options.

Tip

The arguments are used to initialize data attributes with the same names.

Parameters: duplicate_ip_detection_enabled (bool or None) – Indicates whether duplicate IP detection should be enabled

class com.vmware.nsx_policy.model_client.EgressRateLimiter(average_bandwidth=None, burst_size=None, peak_bandwidth=None, enabled=None, resource_type='EgressRateLimiter')¶

Bases: vmware.vapi.bindings.struct.VapiStruct

A shaper that specifies egress rate properties in Mb/s

Tip

The arguments are used to initialize data attributes with the same names.

Parameters

average_bandwidth (long or None) – Average bandwidth in Mb/s format: int32
burst_size (long or None) – Burst size in bytes format: int32
peak_bandwidth (long or None) – Peak bandwidth in Mb/s format: int32
enabled (bool) –
resource_type (str) –
Possible values are:
Type rate limiter

property resource_type¶: Return the discriminator value

class com.vmware.nsx_policy.model_client.EndpointPolicy(links=None, schema=None, self_=None, revision=None, create_time=None, create_user=None, last_modified_time=None, last_modified_user=None, protection=None, system_owned=None, description=None, display_name=None, id=None, resource_type=None, tags=None, parent_path=None, path=None, relative_path=None, children=None, marked_for_delete=None, endpoint_rules=None, sequence_number=None)¶

Bases: vmware.vapi.bindings.struct.VapiStruct

Ordered list of Endpoint Rules ordered by sequence number of the entries. The maximum number of policies is 25.

Tip

The arguments are used to initialize data attributes with the same names.

Parameters

links (list of ResourceLink or None) – The server will populate this field when returing the resource. Ignored on PUT and POST. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
schema (str or None) – Schema for this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
self (SelfResourceLink or None) – Link to this resource
revision (long or None) – The _revision property describes the current revision of the resource. To prevent clients from overwriting each other’s changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected. format: int32
create_time (long or None) – Timestamp of resource creation format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
create_user (str or None) – ID of the user who created this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
last_modified_time (long or None) – Timestamp of last modification format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
last_modified_user (str or None) – ID of the user who last modified this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
protection (str or None) – Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super user and can modify it, but only when providing the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this entity. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
system_owned (bool or None) – Indicates system owned resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
description (str or None) – Description of this resource
display_name (str or None) – Defaults to ID if not set
id (str or None) – Unique identifier of this resource
resource_type (str or None) – The type of this resource.
tags (list of Tag or None) – Opaque identifiers meaningful to the API user
parent_path (str or None) – Path of its parent This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
path (str or None) – Absolute path of this object This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
relative_path (str or None) – Path relative from its parent This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
children (list of vmware.vapi.struct.VapiStruct or None) – subtree for this type within policy tree containing nested elements. When clients pass a value of this class as a parameter, the attribute must contain all the attributes defined in ChildPolicyConfigResource. When methods return a value of this class as a return value, the attribute will contain all the attributes defined in ChildPolicyConfigResource.
marked_for_delete (bool or None) – Intent objects are not directly deleted from the system when a delete is invoked on them. They are marked for deletion and only when all the realized entities for that intent object gets deleted, the intent object is deleted. Objects that are marked for deletion are not returned in GET call. One can use the search API to get these objects. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
endpoint_rules (list of EndpointRule or None) – Endpoint Rules that are a part of this EndpointPolicy
sequence_number (long or None) – This field is used to resolve conflicts between maps across domains. format: int32

class com.vmware.nsx_policy.model_client.EndpointPolicyListResult(links=None, schema=None, self_=None, cursor=None, result_count=None, sort_ascending=None, sort_by=None, results=None)¶

Bases: vmware.vapi.bindings.struct.VapiStruct

Paged Collection of Groups

Tip

The arguments are used to initialize data attributes with the same names.

Parameters

links (list of ResourceLink or None) – The server will populate this field when returing the resource. Ignored on PUT and POST. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
schema (str or None) – Schema for this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
self (SelfResourceLink or None) – Link to this resource
cursor (str or None) – Opaque cursor to be used for getting next page of records (supplied by current result page) This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
result_count (long or None) – Count of results found (across all pages), set only on first page format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
sort_ascending (bool or None) – If true, results are sorted in ascending order This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
sort_by (str or None) – Field by which records are sorted This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
results (list of EndpointPolicy) – Guest Introspection Map list results

class com.vmware.nsx_policy.model_client.EndpointRule(links=None, schema=None, self_=None, revision=None, create_time=None, create_user=None, last_modified_time=None, last_modified_user=None, protection=None, system_owned=None, description=None, display_name=None, id=None, resource_type=None, tags=None, parent_path=None, path=None, relative_path=None, children=None, marked_for_delete=None, groups=None, sequence_number=None, service_profiles=None)¶

Bases: vmware.vapi.bindings.struct.VapiStruct

Endpoint Rule comes from user configuration. User configures Endpoint Rule to specify what services are applied on the groups.

Tip

The arguments are used to initialize data attributes with the same names.

Parameters

links (list of ResourceLink or None) – The server will populate this field when returing the resource. Ignored on PUT and POST. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
schema (str or None) – Schema for this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
self (SelfResourceLink or None) – Link to this resource
revision (long or None) – The _revision property describes the current revision of the resource. To prevent clients from overwriting each other’s changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected. format: int32
create_time (long or None) – Timestamp of resource creation format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
create_user (str or None) – ID of the user who created this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
last_modified_time (long or None) – Timestamp of last modification format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
last_modified_user (str or None) – ID of the user who last modified this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
protection (str or None) – Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super user and can modify it, but only when providing the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this entity. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
system_owned (bool or None) – Indicates system owned resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
description (str or None) – Description of this resource
display_name (str or None) – Defaults to ID if not set
id (str or None) – Unique identifier of this resource
resource_type (str or None) – The type of this resource.
tags (list of Tag or None) – Opaque identifiers meaningful to the API user
parent_path (str or None) – Path of its parent This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
path (str or None) – Absolute path of this object This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
relative_path (str or None) – Path relative from its parent This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
children (list of vmware.vapi.struct.VapiStruct or None) – subtree for this type within policy tree containing nested elements. When clients pass a value of this class as a parameter, the attribute must contain all the attributes defined in ChildPolicyConfigResource. When methods return a value of this class as a return value, the attribute will contain all the attributes defined in ChildPolicyConfigResource.
marked_for_delete (bool or None) – Intent objects are not directly deleted from the system when a delete is invoked on them. They are marked for deletion and only when all the realized entities for that intent object gets deleted, the intent object is deleted. Objects that are marked for deletion are not returned in GET call. One can use the search API to get these objects. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
groups (list of str) – We need paths as duplicate names may exist for groups under different domains. In order to specify all groups, use the constant “ANY”. This is case insensitive. If “ANY” is used, it should be the ONLY element in the group array. Error will be thrown if ANY is used in conjunction with other values.
sequence_number (long or None) – This field is used to resolve conflicts between multiple entries under EndpointPolicy. It will be system default value when not specified by user. format: int32
service_profiles (list of str) – The policy paths of service profiles are listed here. It pecifies what services are applied on the group. Currently only one is allowed.

class com.vmware.nsx_policy.model_client.EndpointRuleListResult(links=None, schema=None, self_=None, cursor=None, result_count=None, sort_ascending=None, sort_by=None, results=None)¶

Bases: vmware.vapi.bindings.struct.VapiStruct

Paged Collection of Endpoint Rules

Tip

The arguments are used to initialize data attributes with the same names.

Parameters

links (list of ResourceLink or None) – The server will populate this field when returing the resource. Ignored on PUT and POST. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
schema (str or None) – Schema for this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
self (SelfResourceLink or None) – Link to this resource
cursor (str or None) – Opaque cursor to be used for getting next page of records (supplied by current result page) This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
result_count (long or None) – Count of results found (across all pages), set only on first page format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
sort_ascending (bool or None) – If true, results are sorted in ascending order This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
sort_by (str or None) – Field by which records are sorted This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
results (list of EndpointRule) – Endpoint Rule list results

class com.vmware.nsx_policy.model_client.EnforcementPoint(links=None, schema=None, self_=None, revision=None, create_time=None, create_user=None, last_modified_time=None, last_modified_user=None, protection=None, system_owned=None, description=None, display_name=None, id=None, resource_type=None, tags=None, parent_path=None, path=None, relative_path=None, children=None, marked_for_delete=None, auto_enforce=None, connection_info=None, version=None)¶

Bases: vmware.vapi.bindings.struct.VapiStruct

Represents endpoint where policy will be applied

Tip

The arguments are used to initialize data attributes with the same names.

Parameters

links (list of ResourceLink or None) – The server will populate this field when returing the resource. Ignored on PUT and POST. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
schema (str or None) – Schema for this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
self (SelfResourceLink or None) – Link to this resource
revision (long or None) – The _revision property describes the current revision of the resource. To prevent clients from overwriting each other’s changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected. format: int32
create_time (long or None) – Timestamp of resource creation format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
create_user (str or None) – ID of the user who created this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
last_modified_time (long or None) – Timestamp of last modification format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
last_modified_user (str or None) – ID of the user who last modified this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
protection (str or None) – Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super user and can modify it, but only when providing the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this entity. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
system_owned (bool or None) – Indicates system owned resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
description (str or None) – Description of this resource
display_name (str or None) – Defaults to ID if not set
id (str or None) – Unique identifier of this resource
resource_type (str or None) – The type of this resource.
tags (list of Tag or None) – Opaque identifiers meaningful to the API user
parent_path (str or None) – Path of its parent This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
path (str or None) – Absolute path of this object This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
relative_path (str or None) – Path relative from its parent This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
children (list of vmware.vapi.struct.VapiStruct or None) – subtree for this type within policy tree containing nested elements. When clients pass a value of this class as a parameter, the attribute must contain all the attributes defined in ChildPolicyConfigResource. When methods return a value of this class as a return value, the attribute will contain all the attributes defined in ChildPolicyConfigResource.
marked_for_delete (bool or None) – Intent objects are not directly deleted from the system when a delete is invoked on them. They are marked for deletion and only when all the realized entities for that intent object gets deleted, the intent object is deleted. Objects that are marked for deletion are not returned in GET call. One can use the search API to get these objects. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
auto_enforce (bool or None) – The flag, which suggests whether the policy objects will be enforced automatically on this enforcement point or not. Default value is true, means policy objects will automatically enforced on the Enforcement point and if it is false, in that case user can use the usual means for realization. i.e deployment maps.
connection_info (vmware.vapi.struct.VapiStruct) – Enforcement point connection info When clients pass a value of this class as a parameter, the attribute must contain all the attributes defined in EnforcementPointConnectionInfo. When methods return a value of this class as a return value, the attribute will contain all the attributes defined in EnforcementPointConnectionInfo.
version (str or None) – Version of the Enforcement point This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.

class com.vmware.nsx_policy.model_client.EnforcementPointConnectionInfo(enforcement_point_address=None, resource_type='EnforcementPointConnectionInfo')¶

Bases: vmware.vapi.bindings.struct.VapiStruct

Contains information required to connect to enforcement point

Tip

The arguments are used to initialize data attributes with the same names.

Parameters

enforcement_point_address (str) – Value of this property could be hostname or ip. eg. For NSX-T manager running on default port the value can be “10.192.1.1”, for NSX-T manager running on custom port value can be “192.168.1.1:32789”. For NSX-T manager in VMC deployments value can have url prefix eg. “192.168.1.1:5480/nsxapi”
resource_type (str) –
Possible values are:

RESOURCE_TYPE_CVXCONNECTIONINFO = 'CvxConnectionInfo'¶

RESOURCE_TYPE_NSXTCONNECTIONINFO = 'NSXTConnectionInfo'¶

RESOURCE_TYPE_NSXVCONNECTIONINFO = 'NSXVConnectionInfo'¶

property resource_type¶: Return the discriminator value

class com.vmware.nsx_policy.model_client.EnforcementPointListResult(links=None, schema=None, self_=None, cursor=None, result_count=None, sort_ascending=None, sort_by=None, results=None)¶

Bases: vmware.vapi.bindings.struct.VapiStruct

Paged collection of enforcement points

Tip

The arguments are used to initialize data attributes with the same names.

Parameters

links (list of ResourceLink or None) – The server will populate this field when returing the resource. Ignored on PUT and POST. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
schema (str or None) – Schema for this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
self (SelfResourceLink or None) – Link to this resource
cursor (str or None) – Opaque cursor to be used for getting next page of records (supplied by current result page) This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
result_count (long or None) – Count of results found (across all pages), set only on first page format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
sort_ascending (bool or None) – If true, results are sorted in ascending order This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
sort_by (str or None) – Field by which records are sorted This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
results (list of EnforcementPoint) – EnforcementPoint list results

class com.vmware.nsx_policy.model_client.EntityInstanceCountConstraintExpression(count=None, operator=None, links=None, schema=None, self_=None, revision=None, create_time=None, create_user=None, last_modified_time=None, last_modified_user=None, protection=None, system_owned=None, description=None, display_name=None, id=None, resource_type='EntityInstanceCountConstraintExpression', tags=None)¶

Bases: vmware.vapi.bindings.struct.VapiStruct

Represents the leaf level constraint to restrict the number instances of an entity type can be created. This is useful in restricting number of CGWs or MGWs or Providers that can created in a system.

Tip

The arguments are used to initialize data attributes with the same names.

Parameters

count (long) – Instance count. format: int64
operator (str) – Operations supported ‘<’ and ‘<=’.
links (list of ResourceLink or None) – The server will populate this field when returing the resource. Ignored on PUT and POST. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
schema (str or None) – Schema for this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
self (SelfResourceLink or None) – Link to this resource
revision (long or None) – The _revision property describes the current revision of the resource. To prevent clients from overwriting each other’s changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected. format: int32
create_time (long or None) – Timestamp of resource creation format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
create_user (str or None) – ID of the user who created this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
last_modified_time (long or None) – Timestamp of last modification format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
last_modified_user (str or None) – ID of the user who last modified this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
protection (str or None) – Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super user and can modify it, but only when providing the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this entity. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
system_owned (bool or None) – Indicates system owned resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
description (str or None) – Description of this resource
display_name (str or None) – Defaults to ID if not set
id (str or None) – Unique identifier of this resource
resource_type (str) –
Possible values are:
tags (list of Tag or None) – Opaque identifiers meaningful to the API user

property resource_type¶: Return the discriminator value

class com.vmware.nsx_policy.model_client.EtherTypeServiceEntry(ether_type=None, links=None, schema=None, self_=None, revision=None, create_time=None, create_user=None, last_modified_time=None, last_modified_user=None, protection=None, system_owned=None, description=None, display_name=None, id=None, resource_type='EtherTypeServiceEntry', tags=None, parent_path=None, path=None, relative_path=None, children=None, marked_for_delete=None)¶

Bases: vmware.vapi.bindings.struct.VapiStruct

A ServiceEntry that represents an ethertype protocol

Tip

The arguments are used to initialize data attributes with the same names.

Parameters

ether_type (long) – Type of the encapsulated protocol format: int64
links (list of ResourceLink or None) – The server will populate this field when returing the resource. Ignored on PUT and POST. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
schema (str or None) – Schema for this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
self (SelfResourceLink or None) – Link to this resource
revision (long or None) – The _revision property describes the current revision of the resource. To prevent clients from overwriting each other’s changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected. format: int32
create_time (long or None) – Timestamp of resource creation format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
create_user (str or None) – ID of the user who created this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
last_modified_time (long or None) – Timestamp of last modification format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
last_modified_user (str or None) – ID of the user who last modified this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
protection (str or None) – Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super user and can modify it, but only when providing the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this entity. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
system_owned (bool or None) – Indicates system owned resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
description (str or None) – Description of this resource
display_name (str or None) – Defaults to ID if not set
id (str or None) – Unique identifier of this resource
resource_type (str) –
Possible values are:
- ServiceEntry.RESOURCE_TYPE_IPPROTOCOLSERVICEENTRY
- ServiceEntry.RESOURCE_TYPE_IGMPTYPESERVICEENTRY
- ServiceEntry.RESOURCE_TYPE_ICMPTYPESERVICEENTRY
- ServiceEntry.RESOURCE_TYPE_ALGTYPESERVICEENTRY
- ServiceEntry.RESOURCE_TYPE_L4PORTSETSERVICEENTRY
- ServiceEntry.RESOURCE_TYPE_ETHERTYPESERVICEENTRY
tags (list of Tag or None) – Opaque identifiers meaningful to the API user
parent_path (str or None) – Path of its parent This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
path (str or None) – Absolute path of this object This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
relative_path (str or None) – Path relative from its parent This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
children (list of vmware.vapi.struct.VapiStruct or None) – subtree for this type within policy tree containing nested elements. When clients pass a value of this class as a parameter, the attribute must contain all the attributes defined in ChildPolicyConfigResource. When methods return a value of this class as a return value, the attribute will contain all the attributes defined in ChildPolicyConfigResource.
marked_for_delete (bool or None) – Intent objects are not directly deleted from the system when a delete is invoked on them. They are marked for deletion and only when all the realized entities for that intent object gets deleted, the intent object is deleted. Objects that are marked for deletion are not returned in GET call. One can use the search API to get these objects. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.

property resource_type¶: Return the discriminator value

class com.vmware.nsx_policy.model_client.Evaluation(resource_type='Evaluation')¶

Bases: vmware.vapi.bindings.struct.VapiStruct

Criterion Evaluation is the basic logical condition to evaluate whether the event could be potentially met.

Tip

The arguments are used to initialize data attributes with the same names.

Parameters

resource_type (str) –

Possible values are:

Evaluation.RESOURCE_TYPE_SOURCEFIELDEVALUATION

Criterion Evaluation resource type.

RESOURCE_TYPE_SOURCEFIELDEVALUATION = 'SourceFieldEvaluation'¶

property resource_type¶: Return the discriminator value

class com.vmware.nsx_policy.model_client.Event(criteria=None, source=None)¶

Bases: vmware.vapi.bindings.struct.VapiStruct

The Event is the criterion or criteria applied to the source and, when met, prompt Policy to run the action. All Reaction Events are constructed with reference to the object, the “source”, that is logically deemed to be the object upon which the Event in question initially occurred upon. Some example events include: - New object was created. - Change in realization state. - Specific API is called.

Tip

The arguments are used to initialize data attributes with the same names.

Parameters

criteria (list of Criterion or None) – Criteria applied to the source and, if satisfied, would trigger the action. Criteria is composed of criterions. In order for the Criteria to be met, only one of the criterion must be fulfilled (implicit OR).
source (vmware.vapi.struct.VapiStruct) – Source that is logically deemed to be the “object” upon which the Event in question initially occurred upon. When clients pass a value of this class as a parameter, the attribute must contain all the attributes defined in Source. When methods return a value of this class as a return value, the attribute will contain all the attributes defined in Source.

class com.vmware.nsx_policy.model_client.Expression(links=None, schema=None, self_=None, revision=None, create_time=None, create_user=None, last_modified_time=None, last_modified_user=None, protection=None, system_owned=None, description=None, display_name=None, id=None, resource_type='Expression', tags=None, parent_path=None, path=None, relative_path=None, children=None, marked_for_delete=None)¶

Bases: vmware.vapi.bindings.struct.VapiStruct

All the nodes of the expression extend from this abstract class. This is present for extensibility.

Tip

The arguments are used to initialize data attributes with the same names.

Parameters

links (list of ResourceLink or None) – The server will populate this field when returing the resource. Ignored on PUT and POST. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
schema (str or None) – Schema for this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
self (SelfResourceLink or None) – Link to this resource
revision (long or None) – The _revision property describes the current revision of the resource. To prevent clients from overwriting each other’s changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected. format: int32
create_time (long or None) – Timestamp of resource creation format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
create_user (str or None) – ID of the user who created this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
last_modified_time (long or None) – Timestamp of last modification format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
last_modified_user (str or None) – ID of the user who last modified this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
protection (str or None) – Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super user and can modify it, but only when providing the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this entity. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
system_owned (bool or None) – Indicates system owned resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
description (str or None) – Description of this resource
display_name (str or None) – Defaults to ID if not set
id (str or None) – Unique identifier of this resource
resource_type (str) –
Possible values are:
- Expression.RESOURCE_TYPE_CONDITION
- Expression.RESOURCE_TYPE_CONJUNCTIONOPERATOR
- Expression.RESOURCE_TYPE_NESTEDEXPRESSION
- Expression.RESOURCE_TYPE_IPADDRESSEXPRESSION
- Expression.RESOURCE_TYPE_MACADDRESSEXPRESSION
- Expression.RESOURCE_TYPE_EXTERNALIDEXPRESSION
- Expression.RESOURCE_TYPE_PATHEXPRESSION
- Expression.RESOURCE_TYPE_IDENTITYGROUPEXPRESSION
tags (list of Tag or None) – Opaque identifiers meaningful to the API user
parent_path (str or None) – Path of its parent This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
path (str or None) – Absolute path of this object This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
relative_path (str or None) – Path relative from its parent This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
children (list of vmware.vapi.struct.VapiStruct or None) – subtree for this type within policy tree containing nested elements. When clients pass a value of this class as a parameter, the attribute must contain all the attributes defined in ChildPolicyConfigResource. When methods return a value of this class as a return value, the attribute will contain all the attributes defined in ChildPolicyConfigResource.
marked_for_delete (bool or None) – Intent objects are not directly deleted from the system when a delete is invoked on them. They are marked for deletion and only when all the realized entities for that intent object gets deleted, the intent object is deleted. Objects that are marked for deletion are not returned in GET call. One can use the search API to get these objects. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.

RESOURCE_TYPE_CONDITION = 'Condition'¶

RESOURCE_TYPE_CONJUNCTIONOPERATOR = 'ConjunctionOperator'¶

RESOURCE_TYPE_EXTERNALIDEXPRESSION = 'ExternalIDExpression'¶

RESOURCE_TYPE_IDENTITYGROUPEXPRESSION = 'IdentityGroupExpression'¶

RESOURCE_TYPE_IPADDRESSEXPRESSION = 'IPAddressExpression'¶

RESOURCE_TYPE_MACADDRESSEXPRESSION = 'MACAddressExpression'¶

RESOURCE_TYPE_NESTEDEXPRESSION = 'NestedExpression'¶

RESOURCE_TYPE_PATHEXPRESSION = 'PathExpression'¶

property resource_type¶: Return the discriminator value

class com.vmware.nsx_policy.model_client.ExternalIDExpression(external_ids=None, member_type=None, links=None, schema=None, self_=None, revision=None, create_time=None, create_user=None, last_modified_time=None, last_modified_user=None, protection=None, system_owned=None, description=None, display_name=None, id=None, resource_type='ExternalIDExpression', tags=None, parent_path=None, path=None, relative_path=None, children=None, marked_for_delete=None)¶

Bases: vmware.vapi.bindings.struct.VapiStruct

Represents external ID expressions in the form of an array, to support addition of objects like virtual interfaces and virtual machines to a group.

Tip

The arguments are used to initialize data attributes with the same names.

Parameters

external_ids (list of str) – This array can consist of one or more external IDs for the specified member type.
member_type (str) –
Possible values are:
- ExternalIDExpression.MEMBER_TYPE_VIRTUALMACHINE
- ExternalIDExpression.MEMBER_TYPE_VIRTUALNETWORKINTERFACE
External ID member type
links (list of ResourceLink or None) – The server will populate this field when returing the resource. Ignored on PUT and POST. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
schema (str or None) – Schema for this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
self (SelfResourceLink or None) – Link to this resource
revision (long or None) – The _revision property describes the current revision of the resource. To prevent clients from overwriting each other’s changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected. format: int32
create_time (long or None) – Timestamp of resource creation format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
create_user (str or None) – ID of the user who created this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
last_modified_time (long or None) – Timestamp of last modification format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
last_modified_user (str or None) – ID of the user who last modified this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
protection (str or None) – Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super user and can modify it, but only when providing the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this entity. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
system_owned (bool or None) – Indicates system owned resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
description (str or None) – Description of this resource
display_name (str or None) – Defaults to ID if not set
id (str or None) – Unique identifier of this resource
resource_type (str) –
Possible values are:
- Expression.RESOURCE_TYPE_CONDITION
- Expression.RESOURCE_TYPE_CONJUNCTIONOPERATOR
- Expression.RESOURCE_TYPE_NESTEDEXPRESSION
- Expression.RESOURCE_TYPE_IPADDRESSEXPRESSION
- Expression.RESOURCE_TYPE_MACADDRESSEXPRESSION
- Expression.RESOURCE_TYPE_EXTERNALIDEXPRESSION
- Expression.RESOURCE_TYPE_PATHEXPRESSION
- Expression.RESOURCE_TYPE_IDENTITYGROUPEXPRESSION
tags (list of Tag or None) – Opaque identifiers meaningful to the API user
parent_path (str or None) – Path of its parent This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
path (str or None) – Absolute path of this object This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
relative_path (str or None) – Path relative from its parent This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
children (list of vmware.vapi.struct.VapiStruct or None) – subtree for this type within policy tree containing nested elements. When clients pass a value of this class as a parameter, the attribute must contain all the attributes defined in ChildPolicyConfigResource. When methods return a value of this class as a return value, the attribute will contain all the attributes defined in ChildPolicyConfigResource.
marked_for_delete (bool or None) – Intent objects are not directly deleted from the system when a delete is invoked on them. They are marked for deletion and only when all the realized entities for that intent object gets deleted, the intent object is deleted. Objects that are marked for deletion are not returned in GET call. One can use the search API to get these objects. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.

MEMBER_TYPE_VIRTUALMACHINE = 'VirtualMachine'¶

MEMBER_TYPE_VIRTUALNETWORKINTERFACE = 'VirtualNetworkInterface'¶

property resource_type¶: Return the discriminator value

class com.vmware.nsx_policy.model_client.FIPSGlobalConfig(lb_fips_enabled=None)¶

Bases: vmware.vapi.bindings.struct.VapiStruct

Global configuration

Tip

The arguments are used to initialize data attributes with the same names.

Parameters: lb_fips_enabled (bool or None) – When this flag is set to true FIPS mode will be set on ssl encryptions of load balancer feature.

class com.vmware.nsx_policy.model_client.FieldSanityConstraintExpression(checks=None, operator=None, links=None, schema=None, self_=None, revision=None, create_time=None, create_user=None, last_modified_time=None, last_modified_user=None, protection=None, system_owned=None, description=None, display_name=None, id=None, resource_type='FieldSanityConstraintExpression', tags=None)¶

Bases: vmware.vapi.bindings.struct.VapiStruct

Represents the field value constraint to constrain specified field value based on defined sanity checks. Example - For DNS.upstream_servers, all the IP addresses must either be public or private. { “target”: { “target_resource_type”: “DnsForwarderZone”, “attribute”: “upstreamServers”, “path_prefix”: “/infra/dns-forwarder-zones/” }, “constraint_expression”: { “resource_type”: “FieldSanityConstraintExpression”, “operator”: “OR”, “checks”: [“ALL_PUBLIC_IPS”, “ALL_PRIVATE_IPS”] } }

Tip

The arguments are used to initialize data attributes with the same names.

Parameters

checks (list of str) –
Possible values are:
- FieldSanityConstraintExpression.CHECKS_PUBLIC_IPS
- FieldSanityConstraintExpression.CHECKS_PRIVATE_IPS
List of sanity checks.
operator (str) –
Possible values are:
- FieldSanityConstraintExpression.OPERATOR_OR
- FieldSanityConstraintExpression.OPERATOR_AND
A conditional operator
links (list of ResourceLink or None) – The server will populate this field when returing the resource. Ignored on PUT and POST. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
schema (str or None) – Schema for this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
self (SelfResourceLink or None) – Link to this resource
revision (long or None) – The _revision property describes the current revision of the resource. To prevent clients from overwriting each other’s changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected. format: int32
create_time (long or None) – Timestamp of resource creation format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
create_user (str or None) – ID of the user who created this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
last_modified_time (long or None) – Timestamp of last modification format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
last_modified_user (str or None) – ID of the user who last modified this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
protection (str or None) – Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super user and can modify it, but only when providing the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this entity. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
system_owned (bool or None) – Indicates system owned resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
description (str or None) – Description of this resource
display_name (str or None) – Defaults to ID if not set
id (str or None) – Unique identifier of this resource
resource_type (str) –
Possible values are:
tags (list of Tag or None) – Opaque identifiers meaningful to the API user

CHECKS_PRIVATE_IPS = 'ALL_PRIVATE_IPS'¶

CHECKS_PUBLIC_IPS = 'ALL_PUBLIC_IPS'¶

OPERATOR_AND = 'AND'¶

OPERATOR_OR = 'OR'¶

property resource_type¶: Return the discriminator value

class com.vmware.nsx_policy.model_client.FieldSetting(field_pointer=None, value=None)¶

Bases: vmware.vapi.bindings.struct.VapiStruct

Field Setting.

Tip

The arguments are used to initialize data attributes with the same names.

Parameters

field_pointer (str) – Field Pointer.
value (vmware.vapi.struct.VapiStruct) – Value that the field must be set to. When clients pass a value of this class as a parameter, the attribute must contain all the attributes defined in FieldSettingValue. When methods return a value of this class as a return value, the attribute will contain all the attributes defined in FieldSettingValue.

class com.vmware.nsx_policy.model_client.FieldSettingValue(resource_type='FieldSettingValue')¶

Bases: vmware.vapi.bindings.struct.VapiStruct

Field Setting Value.

Tip

The arguments are used to initialize data attributes with the same names.

Parameters

resource_type (str) –

Possible values are:

FieldSettingValue.RESOURCE_TYPE_CONSTANTFIELDVALUE

Field Setting Value resource type.

RESOURCE_TYPE_CONSTANTFIELDVALUE = 'ConstantFieldValue'¶

property resource_type¶: Return the discriminator value

class com.vmware.nsx_policy.model_client.FirewallConfiguration(links=None, schema=None, self_=None, revision=None, create_time=None, create_user=None, last_modified_time=None, last_modified_user=None, protection=None, system_owned=None, description=None, display_name=None, id=None, resource_type='FirewallConfiguration', tags=None, parent_path=None, path=None, relative_path=None, children=None, marked_for_delete=None, disable_auto_drafts=None, enable_firewall=None)¶

Bases: vmware.vapi.bindings.struct.VapiStruct

Firewall related configurations

Tip

The arguments are used to initialize data attributes with the same names.

Parameters

links (list of ResourceLink or None) – The server will populate this field when returing the resource. Ignored on PUT and POST. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
schema (str or None) – Schema for this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
self (SelfResourceLink or None) – Link to this resource
revision (long or None) – The _revision property describes the current revision of the resource. To prevent clients from overwriting each other’s changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected. format: int32
create_time (long or None) – Timestamp of resource creation format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
create_user (str or None) – ID of the user who created this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
last_modified_time (long or None) – Timestamp of last modification format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
last_modified_user (str or None) – ID of the user who last modified this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
protection (str or None) – Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super user and can modify it, but only when providing the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this entity. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
system_owned (bool or None) – Indicates system owned resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
description (str or None) – Description of this resource
display_name (str or None) – Defaults to ID if not set
id (str or None) – Unique identifier of this resource
resource_type (str) –
Possible values are:
- FirewallConfiguration.RESOURCE_TYPE_DFWFIREWALLCONFIGURATION
tags (list of Tag or None) – Opaque identifiers meaningful to the API user
parent_path (str or None) – Path of its parent This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
path (str or None) – Absolute path of this object This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
relative_path (str or None) – Path relative from its parent This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
children (list of vmware.vapi.struct.VapiStruct or None) – subtree for this type within policy tree containing nested elements. When clients pass a value of this class as a parameter, the attribute must contain all the attributes defined in ChildPolicyConfigResource. When methods return a value of this class as a return value, the attribute will contain all the attributes defined in ChildPolicyConfigResource.
marked_for_delete (bool or None) – Intent objects are not directly deleted from the system when a delete is invoked on them. They are marked for deletion and only when all the realized entities for that intent object gets deleted, the intent object is deleted. Objects that are marked for deletion are not returned in GET call. One can use the search API to get these objects. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
disable_auto_drafts (bool or None) – To disable auto drafts, set it to true. By default, auto drafts are enabled.
enable_firewall (bool or None) – If set to true, Firewall is enabled.

RESOURCE_TYPE_DFWFIREWALLCONFIGURATION = 'DfwFirewallConfiguration'¶

property resource_type¶: Return the discriminator value

class com.vmware.nsx_policy.model_client.FloodProtectionProfile(links=None, schema=None, self_=None, revision=None, create_time=None, create_user=None, last_modified_time=None, last_modified_user=None, protection=None, system_owned=None, description=None, display_name=None, id=None, resource_type='FloodProtectionProfile', tags=None, parent_path=None, path=None, relative_path=None, children=None, marked_for_delete=None, icmp_active_flow_limit=None, other_active_conn_limit=None, tcp_half_open_conn_limit=None, udp_active_flow_limit=None)¶

Bases: vmware.vapi.bindings.struct.VapiStruct

A profile holding TCP, UDP and ICMP and other protcol connection limits.

Tip

The arguments are used to initialize data attributes with the same names.

Parameters

links (list of ResourceLink or None) – The server will populate this field when returing the resource. Ignored on PUT and POST. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
schema (str or None) – Schema for this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
self (SelfResourceLink or None) – Link to this resource
revision (long or None) – The _revision property describes the current revision of the resource. To prevent clients from overwriting each other’s changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected. format: int32
create_time (long or None) – Timestamp of resource creation format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
create_user (str or None) – ID of the user who created this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
last_modified_time (long or None) – Timestamp of last modification format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
last_modified_user (str or None) – ID of the user who last modified this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
protection (str or None) – Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super user and can modify it, but only when providing the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this entity. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
system_owned (bool or None) – Indicates system owned resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
description (str or None) – Description of this resource
display_name (str or None) – Defaults to ID if not set
id (str or None) – Unique identifier of this resource
resource_type (str) –
Possible values are:
- FloodProtectionProfile.RESOURCE_TYPE_GATEWAYFLOODPROTECTIONPROFILE
- FloodProtectionProfile.RESOURCE_TYPE_DISTRIBUTEDFLOODPROTECTIONPROFILE
GatewayFloodProtectionProfile is used for all Tier0 and Tier1 gateways. DistributedFloodProtectionProfile is used for all Transport Nodes.
tags (list of Tag or None) – Opaque identifiers meaningful to the API user
parent_path (str or None) – Path of its parent This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
path (str or None) – Absolute path of this object This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
relative_path (str or None) – Path relative from its parent This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
children (list of vmware.vapi.struct.VapiStruct or None) – subtree for this type within policy tree containing nested elements. When clients pass a value of this class as a parameter, the attribute must contain all the attributes defined in ChildPolicyConfigResource. When methods return a value of this class as a return value, the attribute will contain all the attributes defined in ChildPolicyConfigResource.
marked_for_delete (bool or None) – Intent objects are not directly deleted from the system when a delete is invoked on them. They are marked for deletion and only when all the realized entities for that intent object gets deleted, the intent object is deleted. Objects that are marked for deletion are not returned in GET call. One can use the search API to get these objects. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
icmp_active_flow_limit (long or None) – If this field is empty, firewall will not set a limit to active ICMP connections. format: int64
other_active_conn_limit (long or None) – If this field is empty, firewall will not set a limit to other active connections. besides UDP, ICMP and half open TCP connections. format: int64
tcp_half_open_conn_limit (long or None) – If this field is empty, firewall will not set a limit to half open TCP connections. format: int64
udp_active_flow_limit (long or None) – If this field is empty, firewall will not set a limit to active UDP connections. format: int64

RESOURCE_TYPE_DISTRIBUTEDFLOODPROTECTIONPROFILE = 'DistributedFloodProtectionProfile'¶

RESOURCE_TYPE_GATEWAYFLOODPROTECTIONPROFILE = 'GatewayFloodProtectionProfile'¶

property resource_type¶: Return the discriminator value

class com.vmware.nsx_policy.model_client.FloodProtectionProfileBindingListResult(links=None, schema=None, self_=None, cursor=None, result_count=None, sort_ascending=None, sort_by=None, results=None)¶

Bases: vmware.vapi.bindings.struct.VapiStruct

Paged Collection of flood protection profile binding maps

Tip

The arguments are used to initialize data attributes with the same names.

Parameters

links (list of ResourceLink or None) – The server will populate this field when returing the resource. Ignored on PUT and POST. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
schema (str or None) – Schema for this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
self (SelfResourceLink or None) – Link to this resource
cursor (str or None) – Opaque cursor to be used for getting next page of records (supplied by current result page) This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
result_count (long or None) – Count of results found (across all pages), set only on first page format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
sort_ascending (bool or None) – If true, results are sorted in ascending order This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
sort_by (str or None) – Field by which records are sorted This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
results (list of FloodProtectionProfileBindingMap) – Flood protection profile binding maps list results

class com.vmware.nsx_policy.model_client.FloodProtectionProfileBindingMap(links=None, schema=None, self_=None, revision=None, create_time=None, create_user=None, last_modified_time=None, last_modified_user=None, protection=None, system_owned=None, description=None, display_name=None, id=None, resource_type=None, tags=None, parent_path=None, path=None, relative_path=None, children=None, marked_for_delete=None, profile_path=None)¶

Bases: vmware.vapi.bindings.struct.VapiStruct

This entity will be used to establish association between Flood Protection profile and Logical Routers.

Tip

The arguments are used to initialize data attributes with the same names.

Parameters

links (list of ResourceLink or None) – The server will populate this field when returing the resource. Ignored on PUT and POST. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
schema (str or None) – Schema for this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
self (SelfResourceLink or None) – Link to this resource
revision (long or None) – The _revision property describes the current revision of the resource. To prevent clients from overwriting each other’s changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected. format: int32
create_time (long or None) – Timestamp of resource creation format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
create_user (str or None) – ID of the user who created this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
last_modified_time (long or None) – Timestamp of last modification format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
last_modified_user (str or None) – ID of the user who last modified this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
protection (str or None) – Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super user and can modify it, but only when providing the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this entity. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
system_owned (bool or None) – Indicates system owned resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
description (str or None) – Description of this resource
display_name (str or None) – Defaults to ID if not set
id (str or None) – Unique identifier of this resource
resource_type (str or None) – The type of this resource.
tags (list of Tag or None) – Opaque identifiers meaningful to the API user
parent_path (str or None) – Path of its parent This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
path (str or None) – Absolute path of this object This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
relative_path (str or None) – Path relative from its parent This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
children (list of vmware.vapi.struct.VapiStruct or None) – subtree for this type within policy tree containing nested elements. When clients pass a value of this class as a parameter, the attribute must contain all the attributes defined in ChildPolicyConfigResource. When methods return a value of this class as a return value, the attribute will contain all the attributes defined in ChildPolicyConfigResource.
marked_for_delete (bool or None) – Intent objects are not directly deleted from the system when a delete is invoked on them. They are marked for deletion and only when all the realized entities for that intent object gets deleted, the intent object is deleted. Objects that are marked for deletion are not returned in GET call. One can use the search API to get these objects. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
profile_path (str) – PolicyPath of associated Profile

class com.vmware.nsx_policy.model_client.FloodProtectionProfileListResult(links=None, schema=None, self_=None, cursor=None, result_count=None, sort_ascending=None, sort_by=None, results=None)¶

Bases: vmware.vapi.bindings.struct.VapiStruct

Paged Collection of flood protection profiles

Tip

The arguments are used to initialize data attributes with the same names.

Parameters

links (list of ResourceLink or None) – The server will populate this field when returing the resource. Ignored on PUT and POST. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
schema (str or None) – Schema for this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
self (SelfResourceLink or None) – Link to this resource
cursor (str or None) – Opaque cursor to be used for getting next page of records (supplied by current result page) This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
result_count (long or None) – Count of results found (across all pages), set only on first page format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
sort_ascending (bool or None) – If true, results are sorted in ascending order This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
sort_by (str or None) – Field by which records are sorted This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
results (list of vmware.vapi.struct.VapiStruct) – Flood protection profile list results When clients pass a value of this class as a parameter, the attribute must contain all the attributes defined in FloodProtectionProfile. When methods return a value of this class as a return value, the attribute will contain all the attributes defined in FloodProtectionProfile.

class com.vmware.nsx_policy.model_client.Footer(actions=None, condition=None)¶

Bases: vmware.vapi.bindings.struct.VapiStruct

Footer of a widget that provides additional information or allows an action such as clickable url for navigation. An example usage of footer is provided under ‘example_request’ section of ‘CreateWidgetConfiguration’ API.

Tip

The arguments are used to initialize data attributes with the same names.

Parameters

actions (list of FooterAction or None) – Action to be performed at the footer of a widget. An action at the footer can be simple text description or a hyperlink to a UI page. Action allows a clickable url for navigation. An example usage of footer action is provided under ‘example_request’ section of ‘CreateWidgetConfiguration’ API.
condition (str or None) – If the condition is met then the footer will be applied. Examples of expression syntax are provided under ‘example_request’ section of ‘CreateWidgetConfiguration’ API.

class com.vmware.nsx_policy.model_client.FooterAction(dock_to_container_footer=None, label=None, url=None)¶

Bases: vmware.vapi.bindings.struct.VapiStruct

Action specified at the footer of a widget to provide additional information or to provide a clickable url for navigation. An example usage of footer action is provided under the ‘example_request’ section of ‘CreateWidgetConfiguration’ API.

Tip

The arguments are used to initialize data attributes with the same names.

Parameters

dock_to_container_footer (bool or None) – If true, the footer will appear in the underlying container that holds the widget.
label (Label) – Label to be displayed against the footer action.
url (str or None) – Hyperlink to the UI page that provides details of action.

class com.vmware.nsx_policy.model_client.ForwardingPolicy(links=None, schema=None, self_=None, revision=None, create_time=None, create_user=None, last_modified_time=None, last_modified_user=None, protection=None, system_owned=None, description=None, display_name=None, id=None, resource_type=None, tags=None, parent_path=None, path=None, relative_path=None, children=None, marked_for_delete=None, category=None, comments=None, lock_modified_by=None, lock_modified_time=None, locked=None, scope=None, sequence_number=None, stateful=None, tcp_strict=None, rules=None)¶

Bases: vmware.vapi.bindings.struct.VapiStruct

Contains ordered list of forwarding rules that determine when to forward traffic to / from the underlay for accessing cloud native services.

Tip

The arguments are used to initialize data attributes with the same names.

Parameters

links (list of ResourceLink or None) – The server will populate this field when returing the resource. Ignored on PUT and POST. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
schema (str or None) – Schema for this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
self (SelfResourceLink or None) – Link to this resource
revision (long or None) – The _revision property describes the current revision of the resource. To prevent clients from overwriting each other’s changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected. format: int32
create_time (long or None) – Timestamp of resource creation format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
create_user (str or None) – ID of the user who created this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
last_modified_time (long or None) – Timestamp of last modification format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
last_modified_user (str or None) – ID of the user who last modified this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
protection (str or None) – Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super user and can modify it, but only when providing the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this entity. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
system_owned (bool or None) – Indicates system owned resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
description (str or None) – Description of this resource
display_name (str or None) – Defaults to ID if not set
id (str or None) – Unique identifier of this resource
resource_type (str or None) – The type of this resource.
tags (list of Tag or None) – Opaque identifiers meaningful to the API user
parent_path (str or None) – Path of its parent This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
path (str or None) – Absolute path of this object This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
relative_path (str or None) – Path relative from its parent This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
children (list of vmware.vapi.struct.VapiStruct or None) – subtree for this type within policy tree containing nested elements. When clients pass a value of this class as a parameter, the attribute must contain all the attributes defined in ChildPolicyConfigResource. When methods return a value of this class as a return value, the attribute will contain all the attributes defined in ChildPolicyConfigResource.
marked_for_delete (bool or None) – Intent objects are not directly deleted from the system when a delete is invoked on them. They are marked for deletion and only when all the realized entities for that intent object gets deleted, the intent object is deleted. Objects that are marked for deletion are not returned in GET call. One can use the search API to get these objects. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
category (str or None) –
- Distributed Firewall - Policy framework provides five pre-defined
categories for classifying a security policy. They are “Ethernet”,”Emergency”, “Infrastructure” “Environment” and “Application”. There is a pre-determined order in which the policy framework manages the priority of these security policies. Ethernet category is for supporting layer 2 firewall rules. The other four categories are applicable for layer 3 rules. Amongst them, the Emergency category has the highest priority followed by Infrastructure, Environment and then Application rules. Administrator can choose to categorize a security policy into the above categories or can choose to leave it empty. If empty it will have the least precedence w.r.t the above four categories. - Edge Firewall - Policy Framework for Edge Firewall provides six pre-defined categories “Emergency”, “SystemRules”, “SharedPreRules”, “LocalGatewayRules”, “AutoServiceRules” and “Default”, in order of priority of rules. All categories are allowed for Gatetway Policies that belong to ‘default’ Domain. However, for user created domains, category is restricted to “SharedPreRules” or “LocalGatewayRules” only. Also, the users can add/modify/delete rules from only the “SharedPreRules” and “LocalGatewayRules” categories. If user doesn’t specify the category then defaulted to “Rules”. System generated category is used by NSX created rules, for example BFD rules. Autoplumbed category used by NSX verticals to autoplumb data path rules. Finally, “Default” category is the placeholder default rules with lowest in the order of priority.
comments (str or None) – Comments for security policy lock/unlock.
lock_modified_by (str or None) – ID of the user who last modified the lock for the secruity policy. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
lock_modified_time (long or None) – SecurityPolicy locked/unlocked time in epoch milliseconds. format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
locked (bool or None) – Indicates whether a security policy should be locked. If the security policy is locked by a user, then no other user would be able to modify this security policy. Once the user releases the lock, other users can update this security policy.
scope (list of str or None) – The list of group paths where the rules in this policy will get applied. This scope will take precedence over rule level scope. Supported only for security policies.
sequence_number (long or None) – This field is used to resolve conflicts between security policies across domains. In order to change the sequence number of a policy one can fire a POST request on the policy entity with a query parameter action=revise The sequence number field will reflect the value of the computed sequence number upon execution of the above mentioned POST request. For scenarios where the administrator is using a template to update several security policies, the only way to set the sequence number is to explicitly specify the sequence number for each security policy. If no sequence number is specified in the payload, a value of 0 is assigned by default. If there are multiple policies with the same sequence number then their order is not deterministic. If a specific order of policies is desired, then one has to specify unique sequence numbers or use the POST request on the policy entity with a query parameter action=revise to let the framework assign a sequence number format: int32
stateful (bool or None) – Stateful or Stateless nature of security policy is enforced on all rules in this security policy. When it is stateful, the state of the network connects are tracked and a stateful packet inspection is performed. Layer3 security policies can be stateful or stateless. By default, they are stateful. Layer2 security policies can only be stateless.
tcp_strict (bool or None) – Ensures that a 3 way TCP handshake is done before the data packets are sent. tcp_strict=true is supported only for stateful security policies.
rules (list of ForwardingRule or None) – Rules that are a part of this ForwardingPolicy

class com.vmware.nsx_policy.model_client.ForwardingPolicyListResult(links=None, schema=None, self_=None, cursor=None, result_count=None, sort_ascending=None, sort_by=None, results=None)¶

Bases: vmware.vapi.bindings.struct.VapiStruct

Paged Collection of ForwardingPolicy objects

Tip

The arguments are used to initialize data attributes with the same names.

Parameters

links (list of ResourceLink or None) – The server will populate this field when returing the resource. Ignored on PUT and POST. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
schema (str or None) – Schema for this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
self (SelfResourceLink or None) – Link to this resource
cursor (str or None) – Opaque cursor to be used for getting next page of records (supplied by current result page) This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
result_count (long or None) – Count of results found (across all pages), set only on first page format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
sort_ascending (bool or None) – If true, results are sorted in ascending order This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
sort_by (str or None) – Field by which records are sorted This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
results (list of ForwardingPolicy) – ForwardingPolicy list results

class com.vmware.nsx_policy.model_client.ForwardingRule(links=None, schema=None, self_=None, revision=None, create_time=None, create_user=None, last_modified_time=None, last_modified_user=None, protection=None, system_owned=None, description=None, display_name=None, id=None, resource_type=None, tags=None, parent_path=None, path=None, relative_path=None, children=None, marked_for_delete=None, destination_groups=None, destinations_excluded=None, direction=None, disabled=None, ip_protocol=None, logged=None, notes=None, profiles=None, scope=None, sequence_number=None, services=None, source_groups=None, sources_excluded=None, tag=None, action=None)¶

Bases: vmware.vapi.bindings.struct.VapiStruct

Forwarding rule that determine how to forward traffic from a VM. Traffic from VM can either be routed via Overlay or Underlay when VM is on hybrid port. Additionally NAT can be performed for VM or container on overlay to route traffic to/from underlay ROUTE_TO_UNDERLAY - Access a service on underlay space from a VM connected to hybrid port. Eg access to AWS S3 on AWS underlay ROUTE_TO_OVERLAY - Access a service on overlay space from a VM connected to hybrid port. ROUTE_FROM_UNDERLAY - Access a service hosted on a VM (that is connected to hybrid port) from underlay space. Eg access from AWS ELB to VM ROUTE_FROM_OVERLAY - Access a service hosted on a VM (that is connected to hybrid port) from overlay space NAT_FROM_UNDERLAY - Access a service on overlay VM/container from underlay space using DNAT from underlay IP to overlay IP NAT_TO_UNDERLAY - Access an underlay service from a VM/container on overlay space using SNAT from overlay IP to underlay IP

Tip

The arguments are used to initialize data attributes with the same names.

Parameters

links (list of ResourceLink or None) – The server will populate this field when returing the resource. Ignored on PUT and POST. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
schema (str or None) – Schema for this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
self (SelfResourceLink or None) – Link to this resource
revision (long or None) – The _revision property describes the current revision of the resource. To prevent clients from overwriting each other’s changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected. format: int32
create_time (long or None) – Timestamp of resource creation format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
create_user (str or None) – ID of the user who created this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
last_modified_time (long or None) – Timestamp of last modification format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
last_modified_user (str or None) – ID of the user who last modified this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
protection (str or None) – Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super user and can modify it, but only when providing the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this entity. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
system_owned (bool or None) – Indicates system owned resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
description (str or None) – Description of this resource
display_name (str or None) – Defaults to ID if not set
id (str or None) – Unique identifier of this resource
resource_type (str or None) – The type of this resource.
tags (list of Tag or None) – Opaque identifiers meaningful to the API user
parent_path (str or None) – Path of its parent This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
path (str or None) – Absolute path of this object This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
relative_path (str or None) – Path relative from its parent This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
children (list of vmware.vapi.struct.VapiStruct or None) – subtree for this type within policy tree containing nested elements. When clients pass a value of this class as a parameter, the attribute must contain all the attributes defined in ChildPolicyConfigResource. When methods return a value of this class as a return value, the attribute will contain all the attributes defined in ChildPolicyConfigResource.
marked_for_delete (bool or None) – Intent objects are not directly deleted from the system when a delete is invoked on them. They are marked for deletion and only when all the realized entities for that intent object gets deleted, the intent object is deleted. Objects that are marked for deletion are not returned in GET call. One can use the search API to get these objects. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
destination_groups (list of str or None) – We need paths as duplicate names may exist for groups under different domains.In order to specify all groups, use the constant “ANY”. This is case insensitive. If “ANY” is used, it should be the ONLY element in the group array. Error will be thrown if ANY is used in conjunction with other values.
destinations_excluded (bool or None) – If set to true, the rule gets applied on all the groups that are NOT part of the destination groups. If false, the rule applies to the destination groups
direction (str or None) –
Possible values are:
- ForwardingRule.DIRECTION_IN
- ForwardingRule.DIRECTION_OUT
- ForwardingRule.DIRECTION_IN_OUT
Define direction of traffic.
disabled (bool or None) – Flag to disable the rule. Default is enabled.
ip_protocol (str or None) –
Possible values are:
- ForwardingRule.IP_PROTOCOL_IPV4
- ForwardingRule.IP_PROTOCOL_IPV6
- ForwardingRule.IP_PROTOCOL_IPV4_IPV6
Type of IP packet that should be matched while enforcing the rule. The value is set to IPV4_IPV6 for Layer3 rule if not specified. For Layer2/Ether rule the value must be null.
logged (bool or None) – Flag to enable packet logging. Default is disabled.
notes (str or None) – Text for additional notes on changes.
profiles (list of str or None) – Holds the list of layer 7 service profile paths. These profiles accept attributes and sub-attributes of various network services (e.g. L4 AppId, encryption algorithm, domain name, etc) as key value pairs.
scope (list of str or None) – The list of policy paths where the rule is applied LR/Edge/T0/T1/LRP etc. Note that a given rule can be applied on multiple LRs/LRPs.
sequence_number (long or None) – This field is used to resolve conflicts between multiple Rules under Security or Gateway Policy for a Domain If no sequence number is specified in the payload, a value of 0 is assigned by default. If there are multiple rules with the same sequence number then their order is not deterministic. If a specific order of rules is desired, then one has to specify unique sequence numbers or use the POST request on the rule entity with a query parameter action=revise to let the framework assign a sequence number format: int32
services (list of str or None) – In order to specify all services, use the constant “ANY”. This is case insensitive. If “ANY” is used, it should be the ONLY element in the services array. Error will be thrown if ANY is used in conjunction with other values.
source_groups (list of str or None) – We need paths as duplicate names may exist for groups under different domains. In order to specify all groups, use the constant “ANY”. This is case insensitive. If “ANY” is used, it should be the ONLY element in the group array. Error will be thrown if ANY is used in conjunction with other values.
sources_excluded (bool or None) – If set to true, the rule gets applied on all the groups that are NOT part of the source groups. If false, the rule applies to the source groups
tag (str or None) – User level field which will be printed in CLI and packet logs.
action (str or None) –
Possible values are:
- ForwardingRule.ACTION_ROUTE_TO_UNDERLAY
- ForwardingRule.ACTION_ROUTE_TO_OVERLAY
- ForwardingRule.ACTION_ROUTE_FROM_UNDERLAY
- ForwardingRule.ACTION_ROUTE_FROM_OVERLAY
- ForwardingRule.ACTION_NAT_FROM_UNDERLAY
- ForwardingRule.ACTION_NAT_TO_UNDERLAY
The action to be applied to all the services

ACTION_NAT_FROM_UNDERLAY = 'NAT_FROM_UNDERLAY'¶

ACTION_NAT_TO_UNDERLAY = 'NAT_TO_UNDERLAY'¶

ACTION_ROUTE_FROM_OVERLAY = 'ROUTE_FROM_OVERLAY'¶

ACTION_ROUTE_FROM_UNDERLAY = 'ROUTE_FROM_UNDERLAY'¶

ACTION_ROUTE_TO_OVERLAY = 'ROUTE_TO_OVERLAY'¶

ACTION_ROUTE_TO_UNDERLAY = 'ROUTE_TO_UNDERLAY'¶

DIRECTION_IN = 'IN'¶

DIRECTION_IN_OUT = 'IN_OUT'¶

DIRECTION_OUT = 'OUT'¶

IP_PROTOCOL_IPV4 = 'IPV4'¶

IP_PROTOCOL_IPV4_IPV6 = 'IPV4_IPV6'¶

IP_PROTOCOL_IPV6 = 'IPV6'¶

class com.vmware.nsx_policy.model_client.ForwardingRuleListResult(links=None, schema=None, self_=None, cursor=None, result_count=None, sort_ascending=None, sort_by=None, results=None)¶

Bases: vmware.vapi.bindings.struct.VapiStruct

Paged Collection of ForwardingRules

Tip

The arguments are used to initialize data attributes with the same names.

Parameters

links (list of ResourceLink or None) – The server will populate this field when returing the resource. Ignored on PUT and POST. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
schema (str or None) – Schema for this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
self (SelfResourceLink or None) – Link to this resource
cursor (str or None) – Opaque cursor to be used for getting next page of records (supplied by current result page) This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
result_count (long or None) – Count of results found (across all pages), set only on first page format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
sort_ascending (bool or None) – If true, results are sorted in ascending order This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
sort_by (str or None) – Field by which records are sorted This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
results (list of ForwardingRule) – Rule list results

class com.vmware.nsx_policy.model_client.GatewayFloodProtectionProfile(links=None, schema=None, self_=None, revision=None, create_time=None, create_user=None, last_modified_time=None, last_modified_user=None, protection=None, system_owned=None, description=None, display_name=None, id=None, resource_type='GatewayFloodProtectionProfile', tags=None, parent_path=None, path=None, relative_path=None, children=None, marked_for_delete=None, icmp_active_flow_limit=None, other_active_conn_limit=None, tcp_half_open_conn_limit=None, udp_active_flow_limit=None)¶

Bases: vmware.vapi.bindings.struct.VapiStruct

Tip

The arguments are used to initialize data attributes with the same names.

Parameters

links (list of ResourceLink or None) – The server will populate this field when returing the resource. Ignored on PUT and POST. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
schema (str or None) – Schema for this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
self (SelfResourceLink or None) – Link to this resource
revision (long or None) – The _revision property describes the current revision of the resource. To prevent clients from overwriting each other’s changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected. format: int32
create_time (long or None) – Timestamp of resource creation format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
create_user (str or None) – ID of the user who created this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
last_modified_time (long or None) – Timestamp of last modification format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
last_modified_user (str or None) – ID of the user who last modified this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
protection (str or None) – Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super user and can modify it, but only when providing the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this entity. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
system_owned (bool or None) – Indicates system owned resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
description (str or None) – Description of this resource
display_name (str or None) – Defaults to ID if not set
id (str or None) – Unique identifier of this resource
resource_type (str) –
Possible values are:
- FloodProtectionProfile.RESOURCE_TYPE_GATEWAYFLOODPROTECTIONPROFILE
- FloodProtectionProfile.RESOURCE_TYPE_DISTRIBUTEDFLOODPROTECTIONPROFILE
GatewayFloodProtectionProfile is used for all Tier0 and Tier1 gateways. DistributedFloodProtectionProfile is used for all Transport Nodes.
tags (list of Tag or None) – Opaque identifiers meaningful to the API user
parent_path (str or None) – Path of its parent This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
path (str or None) – Absolute path of this object This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
relative_path (str or None) – Path relative from its parent This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
children (list of vmware.vapi.struct.VapiStruct or None) – subtree for this type within policy tree containing nested elements. When clients pass a value of this class as a parameter, the attribute must contain all the attributes defined in ChildPolicyConfigResource. When methods return a value of this class as a return value, the attribute will contain all the attributes defined in ChildPolicyConfigResource.
marked_for_delete (bool or None) – Intent objects are not directly deleted from the system when a delete is invoked on them. They are marked for deletion and only when all the realized entities for that intent object gets deleted, the intent object is deleted. Objects that are marked for deletion are not returned in GET call. One can use the search API to get these objects. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
icmp_active_flow_limit (long or None) – If this field is empty, firewall will not set a limit to active ICMP connections. format: int64
other_active_conn_limit (long or None) – If this field is empty, firewall will not set a limit to other active connections. besides UDP, ICMP and half open TCP connections. format: int64
tcp_half_open_conn_limit (long or None) – If this field is empty, firewall will not set a limit to half open TCP connections. format: int64
udp_active_flow_limit (long or None) – If this field is empty, firewall will not set a limit to active UDP connections. format: int64

property resource_type¶: Return the discriminator value

class com.vmware.nsx_policy.model_client.GatewayPolicy(links=None, schema=None, self_=None, revision=None, create_time=None, create_user=None, last_modified_time=None, last_modified_user=None, protection=None, system_owned=None, description=None, display_name=None, id=None, resource_type=None, tags=None, parent_path=None, path=None, relative_path=None, children=None, marked_for_delete=None, category=None, comments=None, lock_modified_by=None, lock_modified_time=None, locked=None, scope=None, sequence_number=None, stateful=None, tcp_strict=None, rules=None)¶

Bases: vmware.vapi.bindings.struct.VapiStruct

Contains ordered list of Rules for GatewayPolicy

Tip

The arguments are used to initialize data attributes with the same names.

Parameters

links (list of ResourceLink or None) – The server will populate this field when returing the resource. Ignored on PUT and POST. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
schema (str or None) – Schema for this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
self (SelfResourceLink or None) – Link to this resource
revision (long or None) – The _revision property describes the current revision of the resource. To prevent clients from overwriting each other’s changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected. format: int32
create_time (long or None) – Timestamp of resource creation format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
create_user (str or None) – ID of the user who created this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
last_modified_time (long or None) – Timestamp of last modification format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
last_modified_user (str or None) – ID of the user who last modified this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
protection (str or None) – Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super user and can modify it, but only when providing the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this entity. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
system_owned (bool or None) – Indicates system owned resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
description (str or None) – Description of this resource
display_name (str or None) – Defaults to ID if not set
id (str or None) – Unique identifier of this resource
resource_type (str or None) – The type of this resource.
tags (list of Tag or None) – Opaque identifiers meaningful to the API user
parent_path (str or None) – Path of its parent This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
path (str or None) – Absolute path of this object This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
relative_path (str or None) – Path relative from its parent This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
children (list of vmware.vapi.struct.VapiStruct or None) – subtree for this type within policy tree containing nested elements. When clients pass a value of this class as a parameter, the attribute must contain all the attributes defined in ChildPolicyConfigResource. When methods return a value of this class as a return value, the attribute will contain all the attributes defined in ChildPolicyConfigResource.
marked_for_delete (bool or None) – Intent objects are not directly deleted from the system when a delete is invoked on them. They are marked for deletion and only when all the realized entities for that intent object gets deleted, the intent object is deleted. Objects that are marked for deletion are not returned in GET call. One can use the search API to get these objects. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
category (str or None) –
- Distributed Firewall - Policy framework provides five pre-defined
categories for classifying a security policy. They are “Ethernet”,”Emergency”, “Infrastructure” “Environment” and “Application”. There is a pre-determined order in which the policy framework manages the priority of these security policies. Ethernet category is for supporting layer 2 firewall rules. The other four categories are applicable for layer 3 rules. Amongst them, the Emergency category has the highest priority followed by Infrastructure, Environment and then Application rules. Administrator can choose to categorize a security policy into the above categories or can choose to leave it empty. If empty it will have the least precedence w.r.t the above four categories. - Edge Firewall - Policy Framework for Edge Firewall provides six pre-defined categories “Emergency”, “SystemRules”, “SharedPreRules”, “LocalGatewayRules”, “AutoServiceRules” and “Default”, in order of priority of rules. All categories are allowed for Gatetway Policies that belong to ‘default’ Domain. However, for user created domains, category is restricted to “SharedPreRules” or “LocalGatewayRules” only. Also, the users can add/modify/delete rules from only the “SharedPreRules” and “LocalGatewayRules” categories. If user doesn’t specify the category then defaulted to “Rules”. System generated category is used by NSX created rules, for example BFD rules. Autoplumbed category used by NSX verticals to autoplumb data path rules. Finally, “Default” category is the placeholder default rules with lowest in the order of priority.
comments (str or None) – Comments for security policy lock/unlock.
lock_modified_by (str or None) – ID of the user who last modified the lock for the secruity policy. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
lock_modified_time (long or None) – SecurityPolicy locked/unlocked time in epoch milliseconds. format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
locked (bool or None) – Indicates whether a security policy should be locked. If the security policy is locked by a user, then no other user would be able to modify this security policy. Once the user releases the lock, other users can update this security policy.
scope (list of str or None) – The list of group paths where the rules in this policy will get applied. This scope will take precedence over rule level scope. Supported only for security policies.
sequence_number (long or None) – This field is used to resolve conflicts between security policies across domains. In order to change the sequence number of a policy one can fire a POST request on the policy entity with a query parameter action=revise The sequence number field will reflect the value of the computed sequence number upon execution of the above mentioned POST request. For scenarios where the administrator is using a template to update several security policies, the only way to set the sequence number is to explicitly specify the sequence number for each security policy. If no sequence number is specified in the payload, a value of 0 is assigned by default. If there are multiple policies with the same sequence number then their order is not deterministic. If a specific order of policies is desired, then one has to specify unique sequence numbers or use the POST request on the policy entity with a query parameter action=revise to let the framework assign a sequence number format: int32
stateful (bool or None) – Stateful or Stateless nature of security policy is enforced on all rules in this security policy. When it is stateful, the state of the network connects are tracked and a stateful packet inspection is performed. Layer3 security policies can be stateful or stateless. By default, they are stateful. Layer2 security policies can only be stateless.
tcp_strict (bool or None) – Ensures that a 3 way TCP handshake is done before the data packets are sent. tcp_strict=true is supported only for stateful security policies.
rules (list of Rule or None) – Rules that are a part of this SecurityPolicy

class com.vmware.nsx_policy.model_client.GatewayPolicyListResult(links=None, schema=None, self_=None, cursor=None, result_count=None, sort_ascending=None, sort_by=None, results=None)¶

Bases: vmware.vapi.bindings.struct.VapiStruct

Paged Collection of gateway policies

Tip

The arguments are used to initialize data attributes with the same names.

Parameters

links (list of ResourceLink or None) – The server will populate this field when returing the resource. Ignored on PUT and POST. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
schema (str or None) – Schema for this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
self (SelfResourceLink or None) – Link to this resource
cursor (str or None) – Opaque cursor to be used for getting next page of records (supplied by current result page) This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
result_count (long or None) – Count of results found (across all pages), set only on first page format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
sort_ascending (bool or None) – If true, results are sorted in ascending order This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
sort_by (str or None) – Field by which records are sorted This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
results (list of GatewayPolicy) – GatewayPolicy list results

class com.vmware.nsx_policy.model_client.GenericPolicyRealizedResource(links=None, schema=None, self_=None, revision=None, create_time=None, create_user=None, last_modified_time=None, last_modified_user=None, protection=None, system_owned=None, description=None, display_name=None, id=None, resource_type=None, tags=None, parent_path=None, path=None, relative_path=None, alarms=None, intent_reference=None, realization_api=None, realization_specific_identifier=None, runtime_error=None, runtime_status=None, state=None, entity_type=None, extended_attributes=None, intent_paths=None)¶

Bases: vmware.vapi.bindings.struct.VapiStruct

Represents realized entity

Tip

The arguments are used to initialize data attributes with the same names.

Parameters

links (list of ResourceLink or None) – The server will populate this field when returing the resource. Ignored on PUT and POST. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
schema (str or None) – Schema for this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
self (SelfResourceLink or None) – Link to this resource
revision (long or None) – The _revision property describes the current revision of the resource. To prevent clients from overwriting each other’s changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected. format: int32
create_time (long or None) – Timestamp of resource creation format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
create_user (str or None) – ID of the user who created this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
last_modified_time (long or None) – Timestamp of last modification format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
last_modified_user (str or None) – ID of the user who last modified this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
protection (str or None) – Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super user and can modify it, but only when providing the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this entity. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
system_owned (bool or None) – Indicates system owned resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
description (str or None) – Description of this resource
display_name (str or None) – Defaults to ID if not set
id (str or None) – Unique identifier of this resource
resource_type (str or None) – The type of this resource.
tags (list of Tag or None) – Opaque identifiers meaningful to the API user
parent_path (str or None) – Path of its parent This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
path (str or None) – Absolute path of this object This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
relative_path (str or None) – Path relative from its parent This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
alarms (list of PolicyAlarmResource or None) – Alarm info detail
intent_reference (list of str or None) – Desire state paths of this object
realization_api (str or None) – Realization API of this object on enforcement point
realization_specific_identifier (str or None) – Realization id of this object
runtime_error (str or None) – It define the root cause for runtime error.
runtime_status (str or None) – Possible values could be UP, DOWN, UNKNOWN, DEGRADED This list is not exhaustive.
state (str) –
Possible values are:
- GenericPolicyRealizedResource.STATE_UNAVAILABLE
- GenericPolicyRealizedResource.STATE_UNREALIZED
- GenericPolicyRealizedResource.STATE_REALIZED
- GenericPolicyRealizedResource.STATE_ERROR
Realization state of this object
entity_type (str or None) – Type of realized entity This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
extended_attributes (list of AttributeVal or None) – Collection of type specific properties This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
intent_paths (list of str or None) – Collection of intent paths This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.

STATE_ERROR = 'ERROR'¶

STATE_REALIZED = 'REALIZED'¶

STATE_UNAVAILABLE = 'UNAVAILABLE'¶

STATE_UNREALIZED = 'UNREALIZED'¶

class com.vmware.nsx_policy.model_client.GenericPolicyRealizedResourceListResult(links=None, schema=None, self_=None, cursor=None, result_count=None, sort_ascending=None, sort_by=None, results=None)¶

Bases: vmware.vapi.bindings.struct.VapiStruct

GenericPolicyRealizedResource list result

Tip

The arguments are used to initialize data attributes with the same names.

Parameters

links (list of ResourceLink or None) – The server will populate this field when returing the resource. Ignored on PUT and POST. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
schema (str or None) – Schema for this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
self (SelfResourceLink or None) – Link to this resource
cursor (str or None) – Opaque cursor to be used for getting next page of records (supplied by current result page) This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
result_count (long or None) – Count of results found (across all pages), set only on first page format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
sort_ascending (bool or None) – If true, results are sorted in ascending order This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
sort_by (str or None) – Field by which records are sorted This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
results (list of GenericPolicyRealizedResource or None) – List of realized resources

class com.vmware.nsx_policy.model_client.GlobalConfig(links=None, schema=None, self_=None, revision=None, create_time=None, create_user=None, last_modified_time=None, last_modified_user=None, protection=None, system_owned=None, description=None, display_name=None, id=None, resource_type=None, tags=None, parent_path=None, path=None, relative_path=None, children=None, marked_for_delete=None, fips=None, mtu=None)¶

Bases: vmware.vapi.bindings.struct.VapiStruct

Global configuration

Tip

The arguments are used to initialize data attributes with the same names.

Parameters

links (list of ResourceLink or None) – The server will populate this field when returing the resource. Ignored on PUT and POST. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
schema (str or None) – Schema for this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
self (SelfResourceLink or None) – Link to this resource
revision (long or None) – The _revision property describes the current revision of the resource. To prevent clients from overwriting each other’s changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected. format: int32
create_time (long or None) – Timestamp of resource creation format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
create_user (str or None) – ID of the user who created this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
last_modified_time (long or None) – Timestamp of last modification format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
last_modified_user (str or None) – ID of the user who last modified this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
protection (str or None) – Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super user and can modify it, but only when providing the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this entity. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
system_owned (bool or None) – Indicates system owned resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
description (str or None) – Description of this resource
display_name (str or None) – Defaults to ID if not set
id (str or None) – Unique identifier of this resource
resource_type (str or None) – The type of this resource.
tags (list of Tag or None) – Opaque identifiers meaningful to the API user
parent_path (str or None) – Path of its parent This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
path (str or None) – Absolute path of this object This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
relative_path (str or None) – Path relative from its parent This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
children (list of vmware.vapi.struct.VapiStruct or None) – subtree for this type within policy tree containing nested elements. When clients pass a value of this class as a parameter, the attribute must contain all the attributes defined in ChildPolicyConfigResource. When methods return a value of this class as a return value, the attribute will contain all the attributes defined in ChildPolicyConfigResource.
marked_for_delete (bool or None) – Intent objects are not directly deleted from the system when a delete is invoked on them. They are marked for deletion and only when all the realized entities for that intent object gets deleted, the intent object is deleted. Objects that are marked for deletion are not returned in GET call. One can use the search API to get these objects. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
fips (FIPSGlobalConfig or None) – Contains the FIPSGlobalConfig object.
mtu (long or None) – Maximum transmission unit (MTU) specifies the size of the largest packet that a network protocol can transmit. format: int32

class com.vmware.nsx_policy.model_client.GraphConfiguration(axes=None, displayx_value=None, graphs=None, navigation=None, sub_type=None, links=None, schema=None, self_=None, revision=None, create_time=None, create_user=None, last_modified_time=None, last_modified_user=None, protection=None, system_owned=None, description=None, display_name=None, id=None, resource_type='GraphConfiguration', tags=None, datasources=None, drilldown_id=None, footer=None, icons=None, is_drilldown=None, legend=None, shared=None, weight=None)¶

Bases: vmware.vapi.bindings.struct.VapiStruct

Represents configuration of a graph widget

Tip

The arguments are used to initialize data attributes with the same names.

Parameters

axes (Axes or None) – Axes of a graph
displayx_value (bool or None) – If true, value of a point is shown as label on X axis. If false, value of point is not shown as label on X axis. false can be useful in situations where there are too many points and showing the X value as label can clutter the X axis.
graphs (list of GraphDefinition) – Graphs
navigation (str or None) – Hyperlink of the specified UI page that provides details.
sub_type (str or None) –
Possible values are:
- GraphConfiguration.SUB_TYPE_LINE_GRAPH
- GraphConfiguration.SUB_TYPE_BAR_GRAPH
- GraphConfiguration.SUB_TYPE_STACKED_BAR_GRAPH
Describes the the type of graph. LINE_GRAPH shows a line graph chart BAR_GRAPH shows a simple bar graph chart STACKED_BAR_GRAPH shows a stacked bar graph chart
links (list of ResourceLink or None) – The server will populate this field when returing the resource. Ignored on PUT and POST. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
schema (str or None) – Schema for this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
self (SelfResourceLink or None) – Link to this resource
revision (long or None) – The _revision property describes the current revision of the resource. To prevent clients from overwriting each other’s changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected. format: int32
create_time (long or None) – Timestamp of resource creation format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
create_user (str or None) – ID of the user who created this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
last_modified_time (long or None) – Timestamp of last modification format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
last_modified_user (str or None) – ID of the user who last modified this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
protection (str or None) – Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super user and can modify it, but only when providing the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this entity. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
system_owned (bool or None) – Indicates system owned resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
description (str or None) – Description of this resource
display_name (str or None) – Title of the widget. If display_name is omitted, the widget will be shown without a title.
id (str or None) – Unique identifier of this resource
resource_type (str) –
Possible values are:
- WidgetConfiguration.RESOURCE_TYPE_LABELVALUECONFIGURATION
- WidgetConfiguration.RESOURCE_TYPE_DONUTCONFIGURATION
- WidgetConfiguration.RESOURCE_TYPE_MULTIWIDGETCONFIGURATION
- WidgetConfiguration.RESOURCE_TYPE_CONTAINERCONFIGURATION
- WidgetConfiguration.RESOURCE_TYPE_STATSCONFIGURATION
- WidgetConfiguration.RESOURCE_TYPE_GRIDCONFIGURATION
- WidgetConfiguration.RESOURCE_TYPE_GRAPHCONFIGURATION
Supported visualization types are LabelValueConfiguration, DonutConfiguration, GridConfiguration, StatsConfiguration, MultiWidgetConfiguration, GraphConfiguration and ContainerConfiguration.
tags (list of Tag or None) – Opaque identifiers meaningful to the API user
datasources (list of Datasource or None) – The ‘datasources’ represent the sources from which data will be fetched. Currently, only NSX-API is supported as a ‘default’ datasource. An example of specifying ‘default’ datasource along with the urls to fetch data from is given at ‘example_request’ section of ‘CreateWidgetConfiguration’ API.
drilldown_id (str or None) – Id of drilldown widget, if any. Id should be a valid id of an existing widget. A widget is considered as drilldown widget when it is associated with any other widget and provides more detailed information about any data item from the parent widget.
footer (Footer or None) –
icons (list of Icon or None) – Icons to be applied at dashboard for widgets and UI elements.
is_drilldown (bool or None) – Set to true if this widget should be used as a drilldown.
legend (Legend or None) – Legend to be displayed. If legend is not needed, do not include it.
shared (bool or None) – Please use the property ‘shared’ of View instead of this. The widgets of a shared view are visible to other users.
weight (long or None) – Specify relavite weight in WidgetItem for placement in a view. Please see WidgetItem for details. format: int32

SUB_TYPE_BAR_GRAPH = 'BAR_GRAPH'¶

SUB_TYPE_LINE_GRAPH = 'LINE_GRAPH'¶

SUB_TYPE_STACKED_BAR_GRAPH = 'STACKED_BAR_GRAPH'¶

property resource_type¶: Return the discriminator value

class com.vmware.nsx_policy.model_client.GraphDefinition(label=None, point_definition=None, render_configuration=None)¶

Bases: vmware.vapi.bindings.struct.VapiStruct

Defines a graph

Tip

The arguments are used to initialize data attributes with the same names.

Parameters

label (Label or None) – Describes the graph. It labels the entities of graph. If the label is not provided then it is not shown for a graph. For example, for a single graph, the title of widget can describe the graph and a label may not be necessary to be shown.
point_definition (PointDefinition) – Defines the points of a graph.
render_configuration (list of RenderConfiguration or None) – Additional rendering or conditional evaluation of the field values to be performed, if any.

class com.vmware.nsx_policy.model_client.GridConfiguration(columns=None, page_size=None, row_list_fields=None, span=None, links=None, schema=None, self_=None, revision=None, create_time=None, create_user=None, last_modified_time=None, last_modified_user=None, protection=None, system_owned=None, description=None, display_name=None, id=None, resource_type='GridConfiguration', tags=None, datasources=None, drilldown_id=None, footer=None, icons=None, is_drilldown=None, legend=None, shared=None, weight=None)¶

Bases: vmware.vapi.bindings.struct.VapiStruct

Represents configuration of a Grid or Table widget.

Tip

The arguments are used to initialize data attributes with the same names.

Parameters

columns (list of ColumnItem) – Array of columns of a Grid widget
page_size (long or None) – Number of records per page. page_size will be effective only when the urls provided in the datasource support paging. format: int32
row_list_fields (list of RowListField) – Rows of grid or table are formed from the list of objects returned by a row list field.
span (long or None) – Represents the horizontal span of the Grid. format: int32
links (list of ResourceLink or None) – The server will populate this field when returing the resource. Ignored on PUT and POST. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
schema (str or None) – Schema for this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
self (SelfResourceLink or None) – Link to this resource
revision (long or None) – The _revision property describes the current revision of the resource. To prevent clients from overwriting each other’s changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected. format: int32
create_time (long or None) – Timestamp of resource creation format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
create_user (str or None) – ID of the user who created this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
last_modified_time (long or None) – Timestamp of last modification format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
last_modified_user (str or None) – ID of the user who last modified this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
protection (str or None) – Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super user and can modify it, but only when providing the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this entity. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
system_owned (bool or None) – Indicates system owned resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
description (str or None) – Description of this resource
display_name (str or None) – Title of the widget. If display_name is omitted, the widget will be shown without a title.
id (str or None) – Unique identifier of this resource
resource_type (str) –
Possible values are:
- WidgetConfiguration.RESOURCE_TYPE_LABELVALUECONFIGURATION
- WidgetConfiguration.RESOURCE_TYPE_DONUTCONFIGURATION
- WidgetConfiguration.RESOURCE_TYPE_MULTIWIDGETCONFIGURATION
- WidgetConfiguration.RESOURCE_TYPE_CONTAINERCONFIGURATION
- WidgetConfiguration.RESOURCE_TYPE_STATSCONFIGURATION
- WidgetConfiguration.RESOURCE_TYPE_GRIDCONFIGURATION
- WidgetConfiguration.RESOURCE_TYPE_GRAPHCONFIGURATION
Supported visualization types are LabelValueConfiguration, DonutConfiguration, GridConfiguration, StatsConfiguration, MultiWidgetConfiguration, GraphConfiguration and ContainerConfiguration.
tags (list of Tag or None) – Opaque identifiers meaningful to the API user
datasources (list of Datasource or None) – The ‘datasources’ represent the sources from which data will be fetched. Currently, only NSX-API is supported as a ‘default’ datasource. An example of specifying ‘default’ datasource along with the urls to fetch data from is given at ‘example_request’ section of ‘CreateWidgetConfiguration’ API.
drilldown_id (str or None) – Id of drilldown widget, if any. Id should be a valid id of an existing widget. A widget is considered as drilldown widget when it is associated with any other widget and provides more detailed information about any data item from the parent widget.
footer (Footer or None) –
icons (list of Icon or None) – Icons to be applied at dashboard for widgets and UI elements.
is_drilldown (bool or None) – Set to true if this widget should be used as a drilldown.
legend (Legend or None) – Legend to be displayed. If legend is not needed, do not include it.
shared (bool or None) – Please use the property ‘shared’ of View instead of this. The widgets of a shared view are visible to other users.
weight (long or None) – Specify relavite weight in WidgetItem for placement in a view. Please see WidgetItem for details. format: int32

property resource_type¶: Return the discriminator value

class com.vmware.nsx_policy.model_client.Group(links=None, schema=None, self_=None, revision=None, create_time=None, create_user=None, last_modified_time=None, last_modified_user=None, protection=None, system_owned=None, description=None, display_name=None, id=None, resource_type=None, tags=None, parent_path=None, path=None, relative_path=None, children=None, marked_for_delete=None, expression=None, extended_expression=None, state=None)¶

Bases: vmware.vapi.bindings.struct.VapiStruct

Group.

Tip

The arguments are used to initialize data attributes with the same names.

Parameters

links (list of ResourceLink or None) – The server will populate this field when returing the resource. Ignored on PUT and POST. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
schema (str or None) – Schema for this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
self (SelfResourceLink or None) – Link to this resource
revision (long or None) – The _revision property describes the current revision of the resource. To prevent clients from overwriting each other’s changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected. format: int32
create_time (long or None) – Timestamp of resource creation format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
create_user (str or None) – ID of the user who created this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
last_modified_time (long or None) – Timestamp of last modification format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
last_modified_user (str or None) – ID of the user who last modified this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
protection (str or None) – Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super user and can modify it, but only when providing the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this entity. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
system_owned (bool or None) – Indicates system owned resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
description (str or None) – Description of this resource
display_name (str or None) – Defaults to ID if not set
id (str or None) – Unique identifier of this resource
resource_type (str or None) – The type of this resource.
tags (list of Tag or None) – Opaque identifiers meaningful to the API user
parent_path (str or None) – Path of its parent This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
path (str or None) – Absolute path of this object This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
relative_path (str or None) – Path relative from its parent This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
children (list of vmware.vapi.struct.VapiStruct or None) – subtree for this type within policy tree containing nested elements. When clients pass a value of this class as a parameter, the attribute must contain all the attributes defined in ChildPolicyConfigResource. When methods return a value of this class as a return value, the attribute will contain all the attributes defined in ChildPolicyConfigResource.
marked_for_delete (bool or None) – Intent objects are not directly deleted from the system when a delete is invoked on them. They are marked for deletion and only when all the realized entities for that intent object gets deleted, the intent object is deleted. Objects that are marked for deletion are not returned in GET call. One can use the search API to get these objects. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
expression (list of vmware.vapi.struct.VapiStruct or None) – The expression list must follow below criteria: 1. A non-empty expression list, must be of odd size. In a list, with indices starting from 0, all non-conjunction expressions must be at even indices, separated by a conjunction expression at odd indices. 2. The total of ConditionExpression and NestedExpression in a list should not exceed 5. 3. The total of IPAddressExpression, MACAddressExpression, external IDs in an ExternalIDExpression and paths in a PathExpression must not exceed 500. 4. Each expression must be a valid Expression. See the definition of the Expression type for more information. When clients pass a value of this class as a parameter, the attribute must contain all the attributes defined in Expression. When methods return a value of this class as a return value, the attribute will contain all the attributes defined in Expression.
extended_expression (list of vmware.vapi.struct.VapiStruct or None) – Extended Expression allows additional higher level context to be specified for grouping criteria. (e.g. user AD group) This field allow users to specified user context as the source of a firewall rule for IDFW feature. Current version only support a single IdentityGroupExpression. In the future, this might expand to support other conjunction and non-conjunction expression. The extended expression list must follow below criteria: 1. Contains a single IdentityGroupExpression. No conjunction expression is supported. 2. No other non-conjunction expression is supported, except for IdentityGroupExpression. 3. Each expression must be a valid Expression. See the definition of the Expression type for more information. 4. Extended expression are implicitly AND with expression. 5. No nesting can be supported if this value is used. 6. If a Group is using extended expression, this group must be the only member in the source field of an communication map. When clients pass a value of this class as a parameter, the attribute must contain all the attributes defined in Expression. When methods return a value of this class as a return value, the attribute will contain all the attributes defined in Expression.
state (str or None) –
Possible values are:
- Group.STATE_IN_PROGRESS
- Group.STATE_SUCCESS
- Group.STATE_FAILURE
Realization state of this group

STATE_FAILURE = 'FAILURE'¶

STATE_IN_PROGRESS = 'IN_PROGRESS'¶

STATE_SUCCESS = 'SUCCESS'¶

class com.vmware.nsx_policy.model_client.GroupInfo(group=None, group_policy_path=None)¶

Bases: vmware.vapi.bindings.struct.VapiStruct

GroupInfo contains information about a particular Group used in Redirection Rules. It also contains information about policy path, if the group is created from Policy.

Tip

The arguments are used to initialize data attributes with the same names.

Parameters

group (ResourceReference or None) – Group Data.
group_policy_path (str or None) – Policy path of a particular Group. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.

class com.vmware.nsx_policy.model_client.GroupListResult(links=None, schema=None, self_=None, cursor=None, result_count=None, sort_ascending=None, sort_by=None, results=None)¶

Bases: vmware.vapi.bindings.struct.VapiStruct

Paged Collection of Groups

Tip

The arguments are used to initialize data attributes with the same names.

Parameters

links (list of ResourceLink or None) – The server will populate this field when returing the resource. Ignored on PUT and POST. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
schema (str or None) – Schema for this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
self (SelfResourceLink or None) – Link to this resource
cursor (str or None) – Opaque cursor to be used for getting next page of records (supplied by current result page) This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
result_count (long or None) – Count of results found (across all pages), set only on first page format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
sort_ascending (bool or None) – If true, results are sorted in ascending order This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
sort_by (str or None) – Field by which records are sorted This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
results (list of Group) – Group list results

class com.vmware.nsx_policy.model_client.GroupMemberTagsList(member_type=None, tags=None)¶

Bases: vmware.vapi.bindings.struct.VapiStruct

Collection of tags used in a policy group for a particular member type

Tip

The arguments are used to initialize data attributes with the same names.

Parameters

member_type (str) – Member type for which we will list the tags
tags (list of str) – List of tags for the member type

class com.vmware.nsx_policy.model_client.GroupMonitoringProfileBindingMap(links=None, schema=None, self_=None, revision=None, create_time=None, create_user=None, last_modified_time=None, last_modified_user=None, protection=None, system_owned=None, description=None, display_name=None, id=None, resource_type=None, tags=None, parent_path=None, path=None, relative_path=None, children=None, marked_for_delete=None, ipfix_dfw_profile_path=None, ipfix_l2_profile_path=None, port_mirroring_profile_path=None)¶

Bases: vmware.vapi.bindings.struct.VapiStruct

This entity will be used to establish association between monitoring profile and Group. Using this entity, you can specify intent for applying monitoring profile to particular Group. Group with membership criteria vm only supported as source group. Port mirroring is only supported on group with five vms.

Tip

The arguments are used to initialize data attributes with the same names.

Parameters

links (list of ResourceLink or None) – The server will populate this field when returing the resource. Ignored on PUT and POST. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
schema (str or None) – Schema for this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
self (SelfResourceLink or None) – Link to this resource
revision (long or None) – The _revision property describes the current revision of the resource. To prevent clients from overwriting each other’s changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected. format: int32
create_time (long or None) – Timestamp of resource creation format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
create_user (str or None) – ID of the user who created this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
last_modified_time (long or None) – Timestamp of last modification format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
last_modified_user (str or None) – ID of the user who last modified this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
protection (str or None) – Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super user and can modify it, but only when providing the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this entity. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
system_owned (bool or None) – Indicates system owned resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
description (str or None) – Description of this resource
display_name (str or None) – Defaults to ID if not set
id (str or None) – Unique identifier of this resource
resource_type (str or None) – The type of this resource.
tags (list of Tag or None) – Opaque identifiers meaningful to the API user
parent_path (str or None) – Path of its parent This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
path (str or None) – Absolute path of this object This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
relative_path (str or None) – Path relative from its parent This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
children (list of vmware.vapi.struct.VapiStruct or None) – subtree for this type within policy tree containing nested elements. When clients pass a value of this class as a parameter, the attribute must contain all the attributes defined in ChildPolicyConfigResource. When methods return a value of this class as a return value, the attribute will contain all the attributes defined in ChildPolicyConfigResource.
marked_for_delete (bool or None) – Intent objects are not directly deleted from the system when a delete is invoked on them. They are marked for deletion and only when all the realized entities for that intent object gets deleted, the intent object is deleted. Objects that are marked for deletion are not returned in GET call. One can use the search API to get these objects. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
ipfix_dfw_profile_path (str or None) – PolicyPath of associated IPFIX DFW Profile
ipfix_l2_profile_path (str or None) – PolicyPath of associated IPFIX L2 Profile
port_mirroring_profile_path (str or None) – PolicyPath of associated Port Mirroring Profile

class com.vmware.nsx_policy.model_client.GroupMonitoringProfileBindingMapListResult(links=None, schema=None, self_=None, cursor=None, result_count=None, sort_ascending=None, sort_by=None, results=None)¶

Bases: vmware.vapi.bindings.struct.VapiStruct

Paged collection of Group Monitoring Profile Binding Maps

Tip

The arguments are used to initialize data attributes with the same names.

Parameters

links (list of ResourceLink or None) – The server will populate this field when returing the resource. Ignored on PUT and POST. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
schema (str or None) – Schema for this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
self (SelfResourceLink or None) – Link to this resource
cursor (str or None) – Opaque cursor to be used for getting next page of records (supplied by current result page) This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
result_count (long or None) – Count of results found (across all pages), set only on first page format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
sort_ascending (bool or None) – If true, results are sorted in ascending order This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
sort_by (str or None) – Field by which records are sorted This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
results (list of GroupMonitoringProfileBindingMap) – Group Monitoring Profile Binding Map list results

class com.vmware.nsx_policy.model_client.GroupTagsList(results=None)¶

Bases: vmware.vapi.bindings.struct.VapiStruct

Collection of tags used in a policy group listed per member type

Tip

The arguments are used to initialize data attributes with the same names.

Parameters: results (list of GroupMemberTagsList) – Collection of tags used in a policy group listed per member type

class com.vmware.nsx_policy.model_client.GuestInfo(computer_name=None, os_name=None)¶

Bases: vmware.vapi.bindings.struct.VapiStruct

Guest virtual machine details include OS name and computer name of guest VM.

Tip

The arguments are used to initialize data attributes with the same names.

Parameters

computer_name (str or None) – Computer name of guest virtual machine, which is set inside guest OS. Currently this is supported for guests on ESXi that have VMware Tools installed. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
os_name (str or None) – OS name of guest virtual machine. Currently this is supported for guests on ESXi that have VMware Tools installed. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.

class com.vmware.nsx_policy.model_client.HttpPolicyLbMonitorProfile(url=None, links=None, schema=None, self_=None, revision=None, create_time=None, create_user=None, last_modified_time=None, last_modified_user=None, protection=None, system_owned=None, description=None, display_name=None, id=None, resource_type='HttpPolicyLbMonitorProfile', tags=None, parent_path=None, path=None, relative_path=None, children=None, marked_for_delete=None, fall_count=None, interval=None, monitor_port=None, rise_count=None, timeout=None)¶

Bases: vmware.vapi.bindings.struct.VapiStruct

Active healthchecks are disabled by default and can be enabled for a server pool by binding a health monitor to the Group through the PolicyLbRule object. This represents active health monitoring over HTTP. Active healthchecks are initiated periodically, at a configurable interval, to each member of the Group. Only if a healthcheck fails consecutively for a specified number of times (fall_count) to a member will the member status be marked DOWN. Once a member is DOWN, a specified number of consecutive successful healthchecks (rise_count) will bring the member back to UP state. After a healthcheck is initiated, if it does not complete within a certain period, then also the healthcheck is considered to be unsuccessful. Completing a healthcheck within timeout means establishing a connection (TCP or SSL), if applicable, sending the request and receiving the response, all within the configured timeout.

Tip

The arguments are used to initialize data attributes with the same names.

Parameters

url (str or None) – For HTTP active healthchecks, the HTTP request url sent can be customized and can include query parameters.
links (list of ResourceLink or None) – The server will populate this field when returing the resource. Ignored on PUT and POST. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
schema (str or None) – Schema for this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
self (SelfResourceLink or None) – Link to this resource
revision (long or None) – The _revision property describes the current revision of the resource. To prevent clients from overwriting each other’s changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected. format: int32
create_time (long or None) – Timestamp of resource creation format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
create_user (str or None) – ID of the user who created this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
last_modified_time (long or None) – Timestamp of last modification format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
last_modified_user (str or None) – ID of the user who last modified this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
protection (str or None) – Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super user and can modify it, but only when providing the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this entity. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
system_owned (bool or None) – Indicates system owned resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
description (str or None) – Description of this resource
display_name (str or None) – Defaults to ID if not set
id (str or None) – Unique identifier of this resource
resource_type (str) –
Possible values are:
- PolicyLbMonitorProfile.RESOURCE_TYPE_TCPPOLICYLBMONITORPROFILE
- PolicyLbMonitorProfile.RESOURCE_TYPE_UDPPOLICYLBMONITORPROFILE
- PolicyLbMonitorProfile.RESOURCE_TYPE_ICMPPOLICYLBMONITORPROFILE
- PolicyLbMonitorProfile.RESOURCE_TYPE_HTTPPOLICYLBMONITORPROFILE
- PolicyLbMonitorProfile.RESOURCE_TYPE_HTTPSPOLICYLBMONITORPROFILE
tags (list of Tag or None) – Opaque identifiers meaningful to the API user
parent_path (str or None) – Path of its parent This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
path (str or None) – Absolute path of this object This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
relative_path (str or None) – Path relative from its parent This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
children (list of vmware.vapi.struct.VapiStruct or None) – subtree for this type within policy tree containing nested elements. When clients pass a value of this class as a parameter, the attribute must contain all the attributes defined in ChildPolicyConfigResource. When methods return a value of this class as a return value, the attribute will contain all the attributes defined in ChildPolicyConfigResource.
marked_for_delete (bool or None) – Intent objects are not directly deleted from the system when a delete is invoked on them. They are marked for deletion and only when all the realized entities for that intent object gets deleted, the intent object is deleted. Objects that are marked for deletion are not returned in GET call. One can use the search API to get these objects. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
fall_count (long or None) – Only if a healthcheck fails consecutively for a specified number of times, given with fall_count, to a member will the member status be marked DOWN. format: int64
interval (long or None) – Active healthchecks are initiated periodically, at a configurable interval (in seconds), to each member of the Group. format: int64
monitor_port (long or None) – Typically, monitors perform healthchecks to Group members using the member IP address and pool_port. However, in some cases, customers prefer to run healthchecks against a different port than the pool member port which handles actual application traffic. In such cases, the port to run healthchecks against can be specified in the monitor_port value. format: int32
rise_count (long or None) – Once a member is DOWN, a specified number of consecutive successful healthchecks specified by rise_count will bring the member back to UP state. format: int64
timeout (long or None) – Timeout specified in seconds. After a healthcheck is initiated, if it does not complete within a certain period, then also the healthcheck is considered to be unsuccessful. Completing a healthcheck within timeout means establishing a connection (TCP or SSL), if applicable, sending the request and receiving the response, all within the configured timeout. format: int64

property resource_type¶: Return the discriminator value

class com.vmware.nsx_policy.model_client.HttpPolicyLbVirtualServer(insert_client_ip_header=None, links=None, schema=None, self_=None, revision=None, create_time=None, create_user=None, last_modified_time=None, last_modified_user=None, protection=None, system_owned=None, description=None, display_name=None, id=None, resource_type='HttpPolicyLbVirtualServer', tags=None, parent_path=None, path=None, relative_path=None, children=None, marked_for_delete=None, access_log_enabled=None, ip_address=None, lb_persistence_profile=None, ports=None, router_path=None, traffic_source=None)¶

Bases: vmware.vapi.bindings.struct.VapiStruct

Virtual server acts as a facade to an application, receives all client connections over HTTP and distributes them among the backend servers.

Tip

The arguments are used to initialize data attributes with the same names.

Parameters

insert_client_ip_header (bool or None) – Backend web servers typically log each request they handle along with the requesting client IP address. These logs are used for debugging, analytics and other such purposes. If the deployment topology requires enabling SNAT on the load balancer, then server will see the client as the SNAT IP which defeats the purpose of logging. To work around this issue, load balancer can be configured to insert XFF HTTP header with the original client IP address. Backend servers can then be configured to log the IP address in XFF header instead of the source IP address of the connection. If XFF header is not present in the incoming request, load balancer inserts a new XFF header with the client IP address.
links (list of ResourceLink or None) – The server will populate this field when returing the resource. Ignored on PUT and POST. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
schema (str or None) – Schema for this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
self (SelfResourceLink or None) – Link to this resource
revision (long or None) – The _revision property describes the current revision of the resource. To prevent clients from overwriting each other’s changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected. format: int32
create_time (long or None) – Timestamp of resource creation format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
create_user (str or None) – ID of the user who created this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
last_modified_time (long or None) – Timestamp of last modification format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
last_modified_user (str or None) – ID of the user who last modified this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
protection (str or None) – Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super user and can modify it, but only when providing the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this entity. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
system_owned (bool or None) – Indicates system owned resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
description (str or None) – Description of this resource
display_name (str or None) – Defaults to ID if not set
id (str or None) – Unique identifier of this resource
resource_type (str) –
Possible values are:
- PolicyLbVirtualServer.RESOURCE_TYPE_TCPPOLICYLBVIRTUALSERVER
- PolicyLbVirtualServer.RESOURCE_TYPE_UDPPOLICYLBVIRTUALSERVER
- PolicyLbVirtualServer.RESOURCE_TYPE_HTTPPOLICYLBVIRTUALSERVER
- PolicyLbVirtualServer.RESOURCE_TYPE_HTTPSPOLICYLBVIRTUALSERVER
- PolicyLbVirtualServer.RESOURCE_TYPE_CUSTOMPOLICYLBVIRTUALSERVER
tags (list of Tag or None) – Opaque identifiers meaningful to the API user
parent_path (str or None) – Path of its parent This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
path (str or None) – Absolute path of this object This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
relative_path (str or None) – Path relative from its parent This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
children (list of vmware.vapi.struct.VapiStruct or None) – subtree for this type within policy tree containing nested elements. When clients pass a value of this class as a parameter, the attribute must contain all the attributes defined in ChildPolicyConfigResource. When methods return a value of this class as a return value, the attribute will contain all the attributes defined in ChildPolicyConfigResource.
marked_for_delete (bool or None) – Intent objects are not directly deleted from the system when a delete is invoked on them. They are marked for deletion and only when all the realized entities for that intent object gets deleted, the intent object is deleted. Objects that are marked for deletion are not returned in GET call. One can use the search API to get these objects. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
access_log_enabled (bool or None) – If access log is enabled, all HTTP requests sent to an L7 virtual server are logged to the access log file. Both successful requests (backend server returns 2xx) and unsuccessful requests (backend server returns 4xx or 5xx) are logged to access log, if enabled.
ip_address (str) – Configures the IP address of the PolicyLbVirtualServer where it receives all client connections and distributes them among the backend servers. format: ip
lb_persistence_profile (str or None) – Path to optional object that enables persistence on a virtual server allowing related client connections to be sent to the same backend server. Persistence is disabled by default.
ports (list of str) – Ports contains a list of at least one port or port range such as “80”, “1234-1236”. Each port element in the list should be a single port or a single port range. format: port-or-range
router_path (str) – Path to router type object that PolicyLbVirtualServer connects to. The only supported router object is Network.
traffic_source (str or None) –

property resource_type¶: Return the discriminator value

class com.vmware.nsx_policy.model_client.HttpsPolicyLbMonitorProfile(url=None, links=None, schema=None, self_=None, revision=None, create_time=None, create_user=None, last_modified_time=None, last_modified_user=None, protection=None, system_owned=None, description=None, display_name=None, id=None, resource_type=None, tags=None, parent_path=None, path=None, relative_path=None, children=None, marked_for_delete=None, fall_count=None, interval=None, monitor_port=None, rise_count=None, timeout=None)¶

Bases: vmware.vapi.bindings.struct.VapiStruct

Active healthchecks are disabled by default and can be enabled for a server pool by binding a health monitor to the Group through the PolicyLbRule object. This represents active health monitoring over HTTPS. Active healthchecks are initiated periodically, at a configurable interval, to each member of the Group. Only if a healthcheck fails consecutively for a specified number of times (fall_count) to a member will the member status be marked DOWN. Once a member is DOWN, a specified number of consecutive successful healthchecks (rise_count) will bring the member back to UP state. After a healthcheck is initiated, if it does not complete within a certain period, then also the healthcheck is considered to be unsuccessful. Completing a healthcheck within timeout means establishing a connection (TCP or SSL), if applicable, sending the request and receiving the response, all within the configured timeout.

Tip

The arguments are used to initialize data attributes with the same names.

Parameters

url (str or None) – For HTTP active healthchecks, the HTTP request url sent can be customized and can include query parameters.
links (list of ResourceLink or None) – The server will populate this field when returing the resource. Ignored on PUT and POST. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
schema (str or None) – Schema for this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
self (SelfResourceLink or None) – Link to this resource
revision (long or None) – The _revision property describes the current revision of the resource. To prevent clients from overwriting each other’s changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected. format: int32
create_time (long or None) – Timestamp of resource creation format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
create_user (str or None) – ID of the user who created this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
last_modified_time (long or None) – Timestamp of last modification format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
last_modified_user (str or None) – ID of the user who last modified this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
protection (str or None) – Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super user and can modify it, but only when providing the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this entity. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
system_owned (bool or None) – Indicates system owned resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
description (str or None) – Description of this resource
display_name (str or None) – Defaults to ID if not set
id (str or None) – Unique identifier of this resource
resource_type (str) –
Possible values are:
- PolicyLbMonitorProfile.RESOURCE_TYPE_TCPPOLICYLBMONITORPROFILE
- PolicyLbMonitorProfile.RESOURCE_TYPE_UDPPOLICYLBMONITORPROFILE
- PolicyLbMonitorProfile.RESOURCE_TYPE_ICMPPOLICYLBMONITORPROFILE
- PolicyLbMonitorProfile.RESOURCE_TYPE_HTTPPOLICYLBMONITORPROFILE
- PolicyLbMonitorProfile.RESOURCE_TYPE_HTTPSPOLICYLBMONITORPROFILE
tags (list of Tag or None) – Opaque identifiers meaningful to the API user
parent_path (str or None) – Path of its parent This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
path (str or None) – Absolute path of this object This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
relative_path (str or None) – Path relative from its parent This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
children (list of vmware.vapi.struct.VapiStruct or None) – subtree for this type within policy tree containing nested elements. When clients pass a value of this class as a parameter, the attribute must contain all the attributes defined in ChildPolicyConfigResource. When methods return a value of this class as a return value, the attribute will contain all the attributes defined in ChildPolicyConfigResource.
marked_for_delete (bool or None) – Intent objects are not directly deleted from the system when a delete is invoked on them. They are marked for deletion and only when all the realized entities for that intent object gets deleted, the intent object is deleted. Objects that are marked for deletion are not returned in GET call. One can use the search API to get these objects. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
fall_count (long or None) – Only if a healthcheck fails consecutively for a specified number of times, given with fall_count, to a member will the member status be marked DOWN. format: int64
interval (long or None) – Active healthchecks are initiated periodically, at a configurable interval (in seconds), to each member of the Group. format: int64
monitor_port (long or None) – Typically, monitors perform healthchecks to Group members using the member IP address and pool_port. However, in some cases, customers prefer to run healthchecks against a different port than the pool member port which handles actual application traffic. In such cases, the port to run healthchecks against can be specified in the monitor_port value. format: int32
rise_count (long or None) – Once a member is DOWN, a specified number of consecutive successful healthchecks specified by rise_count will bring the member back to UP state. format: int64
timeout (long or None) – Timeout specified in seconds. After a healthcheck is initiated, if it does not complete within a certain period, then also the healthcheck is considered to be unsuccessful. Completing a healthcheck within timeout means establishing a connection (TCP or SSL), if applicable, sending the request and receiving the response, all within the configured timeout. format: int64

property resource_type¶: Return the discriminator value

class com.vmware.nsx_policy.model_client.HttpsPolicyLbVirtualServer(client_ssl_certificate_ids=None, client_ssl_settings=None, default_client_ssl_certificate_id=None, insert_client_ip_header=None, links=None, schema=None, self_=None, revision=None, create_time=None, create_user=None, last_modified_time=None, last_modified_user=None, protection=None, system_owned=None, description=None, display_name=None, id=None, resource_type=None, tags=None, parent_path=None, path=None, relative_path=None, children=None, marked_for_delete=None, access_log_enabled=None, ip_address=None, lb_persistence_profile=None, ports=None, router_path=None, traffic_source=None)¶

Bases: vmware.vapi.bindings.struct.VapiStruct

Virtual server acts as a facade to an application, receives all client connections over HTTPS and distributes them among the backend servers.

Tip

The arguments are used to initialize data attributes with the same names.

Parameters

client_ssl_certificate_ids (list of str or None) – Client-side SSL profile binding allows multiple certificates, for different hostnames, to be bound to the same virtual server. The setting is used when load balancer acts as an SSL server and terminating the client SSL connection
client_ssl_settings (str or None) –
Possible values are:
- HttpsPolicyLbVirtualServer.CLIENT_SSL_SETTINGS_BASE_SECURE_111317
- HttpsPolicyLbVirtualServer.CLIENT_SSL_SETTINGS_MODERATE_SECURE_111317
- HttpsPolicyLbVirtualServer.CLIENT_SSL_SETTINGS_HIGH_SECURE_111317
Security settings representing various security settings when the VirtualServer acts as an SSL server - BASE_SECURE_111317 - MODERATE_SECURE_111317 - HIGH_SECURE_111317
default_client_ssl_certificate_id (str) – The setting is used when load balancer acts as an SSL server and terminating the client SSL connection. A default certificate should be specified which will be used if the server does not host multiple hostnames on the same IP address or if the client does not support SNI extension.
insert_client_ip_header (bool or None) – Backend web servers typically log each request they handle along with the requesting client IP address. These logs are used for debugging, analytics and other such purposes. If the deployment topology requires enabling SNAT on the load balancer, then server will see the client as the SNAT IP which defeats the purpose of logging. To work around this issue, load balancer can be configured to insert XFF HTTP header with the original client IP address. Backend servers can then be configured to log the IP address in XFF header instead of the source IP address of the connection. If XFF header is not present in the incoming request, load balancer inserts a new XFF header with the client IP address.
links (list of ResourceLink or None) – The server will populate this field when returing the resource. Ignored on PUT and POST. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
schema (str or None) – Schema for this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
self (SelfResourceLink or None) – Link to this resource
revision (long or None) – The _revision property describes the current revision of the resource. To prevent clients from overwriting each other’s changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected. format: int32
create_time (long or None) – Timestamp of resource creation format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
create_user (str or None) – ID of the user who created this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
last_modified_time (long or None) – Timestamp of last modification format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
last_modified_user (str or None) – ID of the user who last modified this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
protection (str or None) – Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super user and can modify it, but only when providing the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this entity. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
system_owned (bool or None) – Indicates system owned resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
description (str or None) – Description of this resource
display_name (str or None) – Defaults to ID if not set
id (str or None) – Unique identifier of this resource
resource_type (str) –
Possible values are:
- PolicyLbVirtualServer.RESOURCE_TYPE_TCPPOLICYLBVIRTUALSERVER
- PolicyLbVirtualServer.RESOURCE_TYPE_UDPPOLICYLBVIRTUALSERVER
- PolicyLbVirtualServer.RESOURCE_TYPE_HTTPPOLICYLBVIRTUALSERVER
- PolicyLbVirtualServer.RESOURCE_TYPE_HTTPSPOLICYLBVIRTUALSERVER
- PolicyLbVirtualServer.RESOURCE_TYPE_CUSTOMPOLICYLBVIRTUALSERVER
tags (list of Tag or None) – Opaque identifiers meaningful to the API user
parent_path (str or None) – Path of its parent This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
path (str or None) – Absolute path of this object This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
relative_path (str or None) – Path relative from its parent This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
children (list of vmware.vapi.struct.VapiStruct or None) – subtree for this type within policy tree containing nested elements. When clients pass a value of this class as a parameter, the attribute must contain all the attributes defined in ChildPolicyConfigResource. When methods return a value of this class as a return value, the attribute will contain all the attributes defined in ChildPolicyConfigResource.
marked_for_delete (bool or None) – Intent objects are not directly deleted from the system when a delete is invoked on them. They are marked for deletion and only when all the realized entities for that intent object gets deleted, the intent object is deleted. Objects that are marked for deletion are not returned in GET call. One can use the search API to get these objects. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
access_log_enabled (bool or None) – If access log is enabled, all HTTP requests sent to an L7 virtual server are logged to the access log file. Both successful requests (backend server returns 2xx) and unsuccessful requests (backend server returns 4xx or 5xx) are logged to access log, if enabled.
ip_address (str) – Configures the IP address of the PolicyLbVirtualServer where it receives all client connections and distributes them among the backend servers. format: ip
lb_persistence_profile (str or None) – Path to optional object that enables persistence on a virtual server allowing related client connections to be sent to the same backend server. Persistence is disabled by default.
ports (list of str) – Ports contains a list of at least one port or port range such as “80”, “1234-1236”. Each port element in the list should be a single port or a single port range. format: port-or-range
router_path (str) – Path to router type object that PolicyLbVirtualServer connects to. The only supported router object is Network.
traffic_source (str or None) –

CLIENT_SSL_SETTINGS_BASE_SECURE_111317 = 'BASE_SECURE_111317'¶

CLIENT_SSL_SETTINGS_HIGH_SECURE_111317 = 'HIGH_SECURE_111317'¶

CLIENT_SSL_SETTINGS_MODERATE_SECURE_111317 = 'MODERATE_SECURE_111317'¶

property resource_type¶: Return the discriminator value

class com.vmware.nsx_policy.model_client.ICMPTypeServiceEntry(icmp_code=None, icmp_type=None, protocol=None, links=None, schema=None, self_=None, revision=None, create_time=None, create_user=None, last_modified_time=None, last_modified_user=None, protection=None, system_owned=None, description=None, display_name=None, id=None, resource_type='ICMPTypeServiceEntry', tags=None, parent_path=None, path=None, relative_path=None, children=None, marked_for_delete=None)¶

Bases: vmware.vapi.bindings.struct.VapiStruct

A ServiceEntry that represents IPv4 or IPv6 ICMP protocol

Tip

The arguments are used to initialize data attributes with the same names.

Parameters

icmp_code (long or None) – ICMP message code format: int64
icmp_type (long or None) – ICMP message type format: int64
protocol (str) –
Possible values are:
- ICMPTypeServiceEntry.PROTOCOL_ICMPV4
- ICMPTypeServiceEntry.PROTOCOL_ICMPV6
links (list of ResourceLink or None) – The server will populate this field when returing the resource. Ignored on PUT and POST. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
schema (str or None) – Schema for this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
self (SelfResourceLink or None) – Link to this resource
revision (long or None) – The _revision property describes the current revision of the resource. To prevent clients from overwriting each other’s changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected. format: int32
create_time (long or None) – Timestamp of resource creation format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
create_user (str or None) – ID of the user who created this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
last_modified_time (long or None) – Timestamp of last modification format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
last_modified_user (str or None) – ID of the user who last modified this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
protection (str or None) – Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super user and can modify it, but only when providing the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this entity. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
system_owned (bool or None) – Indicates system owned resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
description (str or None) – Description of this resource
display_name (str or None) – Defaults to ID if not set
id (str or None) – Unique identifier of this resource
resource_type (str) –
Possible values are:
- ServiceEntry.RESOURCE_TYPE_IPPROTOCOLSERVICEENTRY
- ServiceEntry.RESOURCE_TYPE_IGMPTYPESERVICEENTRY
- ServiceEntry.RESOURCE_TYPE_ICMPTYPESERVICEENTRY
- ServiceEntry.RESOURCE_TYPE_ALGTYPESERVICEENTRY
- ServiceEntry.RESOURCE_TYPE_L4PORTSETSERVICEENTRY
- ServiceEntry.RESOURCE_TYPE_ETHERTYPESERVICEENTRY
tags (list of Tag or None) – Opaque identifiers meaningful to the API user
parent_path (str or None) – Path of its parent This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
path (str or None) – Absolute path of this object This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
relative_path (str or None) – Path relative from its parent This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
children (list of vmware.vapi.struct.VapiStruct or None) – subtree for this type within policy tree containing nested elements. When clients pass a value of this class as a parameter, the attribute must contain all the attributes defined in ChildPolicyConfigResource. When methods return a value of this class as a return value, the attribute will contain all the attributes defined in ChildPolicyConfigResource.
marked_for_delete (bool or None) – Intent objects are not directly deleted from the system when a delete is invoked on them. They are marked for deletion and only when all the realized entities for that intent object gets deleted, the intent object is deleted. Objects that are marked for deletion are not returned in GET call. One can use the search API to get these objects. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.

PROTOCOL_ICMPV4 = 'ICMPv4'¶

PROTOCOL_ICMPV6 = 'ICMPv6'¶

property resource_type¶: Return the discriminator value

class com.vmware.nsx_policy.model_client.IGMPTypeServiceEntry(links=None, schema=None, self_=None, revision=None, create_time=None, create_user=None, last_modified_time=None, last_modified_user=None, protection=None, system_owned=None, description=None, display_name=None, id=None, resource_type='IGMPTypeServiceEntry', tags=None, parent_path=None, path=None, relative_path=None, children=None, marked_for_delete=None)¶

Bases: vmware.vapi.bindings.struct.VapiStruct

A ServiceEntry that represents IGMP protocol

Tip

The arguments are used to initialize data attributes with the same names.

Parameters

links (list of ResourceLink or None) – The server will populate this field when returing the resource. Ignored on PUT and POST. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
schema (str or None) – Schema for this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
self (SelfResourceLink or None) – Link to this resource
revision (long or None) – The _revision property describes the current revision of the resource. To prevent clients from overwriting each other’s changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected. format: int32
create_time (long or None) – Timestamp of resource creation format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
create_user (str or None) – ID of the user who created this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
last_modified_time (long or None) – Timestamp of last modification format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
last_modified_user (str or None) – ID of the user who last modified this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
protection (str or None) – Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super user and can modify it, but only when providing the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this entity. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
system_owned (bool or None) – Indicates system owned resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
description (str or None) – Description of this resource
display_name (str or None) – Defaults to ID if not set
id (str or None) – Unique identifier of this resource
resource_type (str) –
Possible values are:
- ServiceEntry.RESOURCE_TYPE_IPPROTOCOLSERVICEENTRY
- ServiceEntry.RESOURCE_TYPE_IGMPTYPESERVICEENTRY
- ServiceEntry.RESOURCE_TYPE_ICMPTYPESERVICEENTRY
- ServiceEntry.RESOURCE_TYPE_ALGTYPESERVICEENTRY
- ServiceEntry.RESOURCE_TYPE_L4PORTSETSERVICEENTRY
- ServiceEntry.RESOURCE_TYPE_ETHERTYPESERVICEENTRY
tags (list of Tag or None) – Opaque identifiers meaningful to the API user
parent_path (str or None) – Path of its parent This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
path (str or None) – Absolute path of this object This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
relative_path (str or None) – Path relative from its parent This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
children (list of vmware.vapi.struct.VapiStruct or None) – subtree for this type within policy tree containing nested elements. When clients pass a value of this class as a parameter, the attribute must contain all the attributes defined in ChildPolicyConfigResource. When methods return a value of this class as a return value, the attribute will contain all the attributes defined in ChildPolicyConfigResource.
marked_for_delete (bool or None) – Intent objects are not directly deleted from the system when a delete is invoked on them. They are marked for deletion and only when all the realized entities for that intent object gets deleted, the intent object is deleted. Objects that are marked for deletion are not returned in GET call. One can use the search API to get these objects. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.

property resource_type¶: Return the discriminator value

class com.vmware.nsx_policy.model_client.IPAddressExpression(ip_addresses=None, links=None, schema=None, self_=None, revision=None, create_time=None, create_user=None, last_modified_time=None, last_modified_user=None, protection=None, system_owned=None, description=None, display_name=None, id=None, resource_type='IPAddressExpression', tags=None, parent_path=None, path=None, relative_path=None, children=None, marked_for_delete=None)¶

Bases: vmware.vapi.bindings.struct.VapiStruct

Represents IP address expressions in the form of an array, to support addition of IP addresses in a group.

Tip

The arguments are used to initialize data attributes with the same names.

Parameters

ip_addresses (list of str) – This array can consist of a single IP address, IP address range or a subnet. Its type can be of either IPv4 or IPv6. Both IPv4 and IPv6 addresses within one expression is not allowed. Supported list of formats are, “192.168.1.1”, “192.168.1.1-192.168.1.100”, “192.168.0.0/24”, “fe80::250:56ff:fe83:318c”, “fe80::250:56ff:fe83:3181-fe80::250:56ff:fe83:318c”, “fe80::250:56ff:fe83:318c/64”. format: address-or-block-or-range
links (list of ResourceLink or None) – The server will populate this field when returing the resource. Ignored on PUT and POST. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
schema (str or None) – Schema for this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
self (SelfResourceLink or None) – Link to this resource
revision (long or None) – The _revision property describes the current revision of the resource. To prevent clients from overwriting each other’s changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected. format: int32
create_time (long or None) – Timestamp of resource creation format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
create_user (str or None) – ID of the user who created this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
last_modified_time (long or None) – Timestamp of last modification format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
last_modified_user (str or None) – ID of the user who last modified this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
protection (str or None) – Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super user and can modify it, but only when providing the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this entity. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
system_owned (bool or None) – Indicates system owned resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
description (str or None) – Description of this resource
display_name (str or None) – Defaults to ID if not set
id (str or None) – Unique identifier of this resource
resource_type (str) –
Possible values are:
- Expression.RESOURCE_TYPE_CONDITION
- Expression.RESOURCE_TYPE_CONJUNCTIONOPERATOR
- Expression.RESOURCE_TYPE_NESTEDEXPRESSION
- Expression.RESOURCE_TYPE_IPADDRESSEXPRESSION
- Expression.RESOURCE_TYPE_MACADDRESSEXPRESSION
- Expression.RESOURCE_TYPE_EXTERNALIDEXPRESSION
- Expression.RESOURCE_TYPE_PATHEXPRESSION
- Expression.RESOURCE_TYPE_IDENTITYGROUPEXPRESSION
tags (list of Tag or None) – Opaque identifiers meaningful to the API user
parent_path (str or None) – Path of its parent This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
path (str or None) – Absolute path of this object This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
relative_path (str or None) – Path relative from its parent This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
children (list of vmware.vapi.struct.VapiStruct or None) – subtree for this type within policy tree containing nested elements. When clients pass a value of this class as a parameter, the attribute must contain all the attributes defined in ChildPolicyConfigResource. When methods return a value of this class as a return value, the attribute will contain all the attributes defined in ChildPolicyConfigResource.
marked_for_delete (bool or None) – Intent objects are not directly deleted from the system when a delete is invoked on them. They are marked for deletion and only when all the realized entities for that intent object gets deleted, the intent object is deleted. Objects that are marked for deletion are not returned in GET call. One can use the search API to get these objects. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.

property resource_type¶: Return the discriminator value

class com.vmware.nsx_policy.model_client.IPAddressPortPair(ip_address=None, port=None)¶

Bases: vmware.vapi.bindings.struct.VapiStruct

IP Address and Port information

Tip

The arguments are used to initialize data attributes with the same names.

Parameters

ip_address (str) – The IPAddress to be combined with Port for defining specific access point. format: ip
port (long or None) – The port to be combined with IPAddress for defining a specific access point. format: int32

class com.vmware.nsx_policy.model_client.IPDiscoveryProfile(links=None, schema=None, self_=None, revision=None, create_time=None, create_user=None, last_modified_time=None, last_modified_user=None, protection=None, system_owned=None, description=None, display_name=None, id=None, resource_type=None, tags=None, parent_path=None, path=None, relative_path=None, children=None, marked_for_delete=None, arp_nd_binding_timeout=None, duplicate_ip_detection=None, ip_v4_discovery_options=None, ip_v6_discovery_options=None, tofu_enabled=None)¶

Bases: vmware.vapi.bindings.struct.VapiStruct

Using this profile to configure different options of IP Discovery

Tip

The arguments are used to initialize data attributes with the same names.

Parameters

links (list of ResourceLink or None) – The server will populate this field when returing the resource. Ignored on PUT and POST. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
schema (str or None) – Schema for this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
self (SelfResourceLink or None) – Link to this resource
revision (long or None) – The _revision property describes the current revision of the resource. To prevent clients from overwriting each other’s changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected. format: int32
create_time (long or None) – Timestamp of resource creation format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
create_user (str or None) – ID of the user who created this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
last_modified_time (long or None) – Timestamp of last modification format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
last_modified_user (str or None) – ID of the user who last modified this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
protection (str or None) – Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super user and can modify it, but only when providing the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this entity. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
system_owned (bool or None) – Indicates system owned resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
description (str or None) – Description of this resource
display_name (str or None) – Defaults to ID if not set
id (str or None) – Unique identifier of this resource
resource_type (str or None) – The type of this resource.
tags (list of Tag or None) – Opaque identifiers meaningful to the API user
parent_path (str or None) – Path of its parent This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
path (str or None) – Absolute path of this object This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
relative_path (str or None) – Path relative from its parent This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
children (list of vmware.vapi.struct.VapiStruct or None) – subtree for this type within policy tree containing nested elements. When clients pass a value of this class as a parameter, the attribute must contain all the attributes defined in ChildPolicyConfigResource. When methods return a value of this class as a return value, the attribute will contain all the attributes defined in ChildPolicyConfigResource.
marked_for_delete (bool or None) – Intent objects are not directly deleted from the system when a delete is invoked on them. They are marked for deletion and only when all the realized entities for that intent object gets deleted, the intent object is deleted. Objects that are marked for deletion are not returned in GET call. One can use the search API to get these objects. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
arp_nd_binding_timeout (long or None) – This property controls the ARP and ND cache timeout period. It is recommended that this property be greater than the ARP/ND cache timeout on the VM. format: int32
duplicate_ip_detection (DuplicateIPDetectionOptions or None) – Duplicate IP detection is used to determine if there is any IP conflict with any other port on the same logical switch. If a conflict is detected, then the IP is marked as a duplicate on the port where the IP was discovered last. The duplicate IP will not be added to the realized address binings for the port and hence will not be used in DFW rules or other security configurations for the port.rt.
ip_v4_discovery_options (IPv4DiscoveryOptions or None) – Indicates IPv4 Discovery options
ip_v6_discovery_options (IPv6DiscoveryOptions or None) – Indicates IPv6 Discovery options
tofu_enabled (bool or None) – Indicates whether “Trust on First Use(TOFU)” paradigm is enabled.

class com.vmware.nsx_policy.model_client.IPDiscoveryProfileListResult(links=None, schema=None, self_=None, cursor=None, result_count=None, sort_ascending=None, sort_by=None, results=None)¶

Bases: vmware.vapi.bindings.struct.VapiStruct

Paged collection of IP Discovery Profiles

Tip

The arguments are used to initialize data attributes with the same names.

Parameters

links (list of ResourceLink or None) – The server will populate this field when returing the resource. Ignored on PUT and POST. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
schema (str or None) – Schema for this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
self (SelfResourceLink or None) – Link to this resource
cursor (str or None) – Opaque cursor to be used for getting next page of records (supplied by current result page) This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
result_count (long or None) – Count of results found (across all pages), set only on first page format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
sort_ascending (bool or None) – If true, results are sorted in ascending order This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
sort_by (str or None) – Field by which records are sorted This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
results (list of IPDiscoveryProfile) – IP Discovery profile list results

class com.vmware.nsx_policy.model_client.IPFIXCollectorProfile(links=None, schema=None, self_=None, revision=None, create_time=None, create_user=None, last_modified_time=None, last_modified_user=None, protection=None, system_owned=None, description=None, display_name=None, id=None, resource_type=None, tags=None, parent_path=None, path=None, relative_path=None, children=None, marked_for_delete=None, ipaddress=None, port=None)¶

Bases: vmware.vapi.bindings.struct.VapiStruct

IPFIX data will be collected on collector Host ip and port address should be provided for collector.

Tip

The arguments are used to initialize data attributes with the same names.

Parameters

links (list of ResourceLink or None) – The server will populate this field when returing the resource. Ignored on PUT and POST. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
schema (str or None) – Schema for this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
self (SelfResourceLink or None) – Link to this resource
revision (long or None) – The _revision property describes the current revision of the resource. To prevent clients from overwriting each other’s changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected. format: int32
create_time (long or None) – Timestamp of resource creation format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
create_user (str or None) – ID of the user who created this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
last_modified_time (long or None) – Timestamp of last modification format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
last_modified_user (str or None) – ID of the user who last modified this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
protection (str or None) – Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super user and can modify it, but only when providing the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this entity. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
system_owned (bool or None) – Indicates system owned resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
description (str or None) – Description of this resource
display_name (str or None) – Defaults to ID if not set
id (str or None) – Unique identifier of this resource
resource_type (str or None) – The type of this resource.
tags (list of Tag or None) – Opaque identifiers meaningful to the API user
parent_path (str or None) – Path of its parent This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
path (str or None) – Absolute path of this object This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
relative_path (str or None) – Path relative from its parent This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
children (list of vmware.vapi.struct.VapiStruct or None) – subtree for this type within policy tree containing nested elements. When clients pass a value of this class as a parameter, the attribute must contain all the attributes defined in ChildPolicyConfigResource. When methods return a value of this class as a return value, the attribute will contain all the attributes defined in ChildPolicyConfigResource.
marked_for_delete (bool or None) – Intent objects are not directly deleted from the system when a delete is invoked on them. They are marked for deletion and only when all the realized entities for that intent object gets deleted, the intent object is deleted. Objects that are marked for deletion are not returned in GET call. One can use the search API to get these objects. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
ipaddress (str) – IP address for the IPFIX collector. format: ip
port (long) – Port for the IPFIX collector. format: int32

class com.vmware.nsx_policy.model_client.IPFIXCollectorProfileListResult(links=None, schema=None, self_=None, cursor=None, result_count=None, sort_ascending=None, sort_by=None, results=None)¶

Bases: vmware.vapi.bindings.struct.VapiStruct

Paged collection of IPFIX collector profiles.

Tip

The arguments are used to initialize data attributes with the same names.

Parameters

links (list of ResourceLink or None) – The server will populate this field when returing the resource. Ignored on PUT and POST. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
schema (str or None) – Schema for this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
self (SelfResourceLink or None) – Link to this resource
cursor (str or None) – Opaque cursor to be used for getting next page of records (supplied by current result page) This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
result_count (long or None) – Count of results found (across all pages), set only on first page format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
sort_ascending (bool or None) – If true, results are sorted in ascending order This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
sort_by (str or None) – Field by which records are sorted This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
results (list of IPFIXCollectorProfile) – IPFIX collector Instances list results

class com.vmware.nsx_policy.model_client.IPFIXDFWCollector(links=None, schema=None, self_=None, revision=None, create_time=None, create_user=None, last_modified_time=None, last_modified_user=None, protection=None, system_owned=None, description=None, display_name=None, id=None, resource_type=None, tags=None, parent_path=None, path=None, relative_path=None, children=None, marked_for_delete=None, collector_ip_address=None, collector_port=None)¶

Bases: vmware.vapi.bindings.struct.VapiStruct

IPFIX DFW data will be collected on collector Host IP and Port address should be provided for collector.

Tip

The arguments are used to initialize data attributes with the same names.

Parameters

links (list of ResourceLink or None) – The server will populate this field when returing the resource. Ignored on PUT and POST. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
schema (str or None) – Schema for this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
self (SelfResourceLink or None) – Link to this resource
revision (long or None) – The _revision property describes the current revision of the resource. To prevent clients from overwriting each other’s changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected. format: int32
create_time (long or None) – Timestamp of resource creation format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
create_user (str or None) – ID of the user who created this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
last_modified_time (long or None) – Timestamp of last modification format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
last_modified_user (str or None) – ID of the user who last modified this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
protection (str or None) – Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super user and can modify it, but only when providing the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this entity. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
system_owned (bool or None) – Indicates system owned resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
description (str or None) – Description of this resource
display_name (str or None) – Defaults to ID if not set
id (str or None) – Unique identifier of this resource
resource_type (str or None) – The type of this resource.
tags (list of Tag or None) – Opaque identifiers meaningful to the API user
parent_path (str or None) – Path of its parent This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
path (str or None) – Absolute path of this object This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
relative_path (str or None) – Path relative from its parent This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
children (list of vmware.vapi.struct.VapiStruct or None) – subtree for this type within policy tree containing nested elements. When clients pass a value of this class as a parameter, the attribute must contain all the attributes defined in ChildPolicyConfigResource. When methods return a value of this class as a return value, the attribute will contain all the attributes defined in ChildPolicyConfigResource.
marked_for_delete (bool or None) – Intent objects are not directly deleted from the system when a delete is invoked on them. They are marked for deletion and only when all the realized entities for that intent object gets deleted, the intent object is deleted. Objects that are marked for deletion are not returned in GET call. One can use the search API to get these objects. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
collector_ip_address (str) – IP address for the IPFIX DFW collector. IP addresses such as 0.0.0.0, 127.0.0.1, 255.255.255.255 are invalid. format: ip
collector_port (long) – Port for the IPFIX DFW collector. format: int32

class com.vmware.nsx_policy.model_client.IPFIXDFWCollectorProfile(links=None, schema=None, self_=None, revision=None, create_time=None, create_user=None, last_modified_time=None, last_modified_user=None, protection=None, system_owned=None, description=None, display_name=None, id=None, resource_type=None, tags=None, parent_path=None, path=None, relative_path=None, children=None, marked_for_delete=None, ipfix_dfw_collectors=None)¶

Bases: vmware.vapi.bindings.struct.VapiStruct

IPFIX data for the NSX distributed firewall will be sent to the specified IPFIX collectors.

Tip

The arguments are used to initialize data attributes with the same names.

Parameters

links (list of ResourceLink or None) – The server will populate this field when returing the resource. Ignored on PUT and POST. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
schema (str or None) – Schema for this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
self (SelfResourceLink or None) – Link to this resource
revision (long or None) – The _revision property describes the current revision of the resource. To prevent clients from overwriting each other’s changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected. format: int32
create_time (long or None) – Timestamp of resource creation format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
create_user (str or None) – ID of the user who created this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
last_modified_time (long or None) – Timestamp of last modification format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
last_modified_user (str or None) – ID of the user who last modified this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
protection (str or None) – Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super user and can modify it, but only when providing the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this entity. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
system_owned (bool or None) – Indicates system owned resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
description (str or None) – Description of this resource
display_name (str or None) – Defaults to ID if not set
id (str or None) – Unique identifier of this resource
resource_type (str or None) – The type of this resource.
tags (list of Tag or None) – Opaque identifiers meaningful to the API user
parent_path (str or None) – Path of its parent This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
path (str or None) – Absolute path of this object This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
relative_path (str or None) – Path relative from its parent This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
children (list of vmware.vapi.struct.VapiStruct or None) – subtree for this type within policy tree containing nested elements. When clients pass a value of this class as a parameter, the attribute must contain all the attributes defined in ChildPolicyConfigResource. When methods return a value of this class as a return value, the attribute will contain all the attributes defined in ChildPolicyConfigResource.
marked_for_delete (bool or None) – Intent objects are not directly deleted from the system when a delete is invoked on them. They are marked for deletion and only when all the realized entities for that intent object gets deleted, the intent object is deleted. Objects that are marked for deletion are not returned in GET call. One can use the search API to get these objects. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
ipfix_dfw_collectors (list of IPFIXDFWCollector) – It accepts Multiple Collectors.

class com.vmware.nsx_policy.model_client.IPFIXDFWCollectorProfileListResult(links=None, schema=None, self_=None, cursor=None, result_count=None, sort_ascending=None, sort_by=None, results=None)¶

Bases: vmware.vapi.bindings.struct.VapiStruct

Paged Collection of IPFIX DFW Collector Profile

Tip

The arguments are used to initialize data attributes with the same names.

Parameters

links (list of ResourceLink or None) – The server will populate this field when returing the resource. Ignored on PUT and POST. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
schema (str or None) – Schema for this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
self (SelfResourceLink or None) – Link to this resource
cursor (str or None) – Opaque cursor to be used for getting next page of records (supplied by current result page) This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
result_count (long or None) – Count of results found (across all pages), set only on first page format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
sort_ascending (bool or None) – If true, results are sorted in ascending order This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
sort_by (str or None) – Field by which records are sorted This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
results (list of IPFIXDFWCollectorProfile) – IPFIX DFW Collection Instances list results

class com.vmware.nsx_policy.model_client.IPFIXDFWProfile(links=None, schema=None, self_=None, revision=None, create_time=None, create_user=None, last_modified_time=None, last_modified_user=None, protection=None, system_owned=None, description=None, display_name=None, id=None, resource_type=None, tags=None, parent_path=None, path=None, relative_path=None, children=None, marked_for_delete=None, active_flow_export_timeout=None, ipfix_dfw_collector_profile_path=None, observation_domain_id=None, priority=None)¶

Bases: vmware.vapi.bindings.struct.VapiStruct

IPFIX packets from source will be sent to IPFIX DFW collector.

Tip

The arguments are used to initialize data attributes with the same names.

Parameters

links (list of ResourceLink or None) – The server will populate this field when returing the resource. Ignored on PUT and POST. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
schema (str or None) – Schema for this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
self (SelfResourceLink or None) – Link to this resource
revision (long or None) – The _revision property describes the current revision of the resource. To prevent clients from overwriting each other’s changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected. format: int32
create_time (long or None) – Timestamp of resource creation format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
create_user (str or None) – ID of the user who created this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
last_modified_time (long or None) – Timestamp of last modification format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
last_modified_user (str or None) – ID of the user who last modified this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
protection (str or None) – Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super user and can modify it, but only when providing the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this entity. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
system_owned (bool or None) – Indicates system owned resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
description (str or None) – Description of this resource
display_name (str or None) – Defaults to ID if not set
id (str or None) – Unique identifier of this resource
resource_type (str or None) – The type of this resource.
tags (list of Tag or None) – Opaque identifiers meaningful to the API user
parent_path (str or None) – Path of its parent This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
path (str or None) – Absolute path of this object This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
relative_path (str or None) – Path relative from its parent This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
children (list of vmware.vapi.struct.VapiStruct or None) – subtree for this type within policy tree containing nested elements. When clients pass a value of this class as a parameter, the attribute must contain all the attributes defined in ChildPolicyConfigResource. When methods return a value of this class as a return value, the attribute will contain all the attributes defined in ChildPolicyConfigResource.
marked_for_delete (bool or None) – Intent objects are not directly deleted from the system when a delete is invoked on them. They are marked for deletion and only when all the realized entities for that intent object gets deleted, the intent object is deleted. Objects that are marked for deletion are not returned in GET call. One can use the search API to get these objects. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
active_flow_export_timeout (long) – For long standing active flows, IPFIX records will be sent per timeout period in minutes. format: int32
ipfix_dfw_collector_profile_path (str) – Policy path for IPFIX collector profiles. IPFIX data from these logical segments will be sent to all specified IPFIX collectors.
observation_domain_id (long or None) – An identifier that is unique to the exporting process and used to meter the flows. format: int32
priority (long or None) – This priority field is used to resolve conflicts in Segment Ports which are covered by more than one IPFIX profiles. The IPFIX exporter will send records to Collectors in highest priority profile (lowest number) only. format: int32

class com.vmware.nsx_policy.model_client.IPFIXDFWProfileListResult(links=None, schema=None, self_=None, cursor=None, result_count=None, sort_ascending=None, sort_by=None, results=None)¶

Bases: vmware.vapi.bindings.struct.VapiStruct

Paged Collection of IPFIX DFW Profile

Tip

The arguments are used to initialize data attributes with the same names.

Parameters

links (list of ResourceLink or None) – The server will populate this field when returing the resource. Ignored on PUT and POST. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
schema (str or None) – Schema for this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
self (SelfResourceLink or None) – Link to this resource
cursor (str or None) – Opaque cursor to be used for getting next page of records (supplied by current result page) This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
result_count (long or None) – Count of results found (across all pages), set only on first page format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
sort_ascending (bool or None) – If true, results are sorted in ascending order This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
sort_by (str or None) – Field by which records are sorted This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
results (list of IPFIXDFWProfile) – IPFIX DFW Profile list results

class com.vmware.nsx_policy.model_client.IPFIXL2Collector(links=None, schema=None, self_=None, revision=None, create_time=None, create_user=None, last_modified_time=None, last_modified_user=None, protection=None, system_owned=None, description=None, display_name=None, id=None, resource_type=None, tags=None, parent_path=None, path=None, relative_path=None, children=None, marked_for_delete=None, collector_ip_address=None, collector_port=None)¶

Bases: vmware.vapi.bindings.struct.VapiStruct

IPFIX packets will be collected on collector. IP and port address should be provided for collector.

Tip

The arguments are used to initialize data attributes with the same names.

Parameters

links (list of ResourceLink or None) – The server will populate this field when returing the resource. Ignored on PUT and POST. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
schema (str or None) – Schema for this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
self (SelfResourceLink or None) – Link to this resource
revision (long or None) – The _revision property describes the current revision of the resource. To prevent clients from overwriting each other’s changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected. format: int32
create_time (long or None) – Timestamp of resource creation format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
create_user (str or None) – ID of the user who created this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
last_modified_time (long or None) – Timestamp of last modification format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
last_modified_user (str or None) – ID of the user who last modified this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
protection (str or None) – Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super user and can modify it, but only when providing the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this entity. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
system_owned (bool or None) – Indicates system owned resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
description (str or None) – Description of this resource
display_name (str or None) – Defaults to ID if not set
id (str or None) – Unique identifier of this resource
resource_type (str or None) – The type of this resource.
tags (list of Tag or None) – Opaque identifiers meaningful to the API user
parent_path (str or None) – Path of its parent This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
path (str or None) – Absolute path of this object This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
relative_path (str or None) – Path relative from its parent This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
children (list of vmware.vapi.struct.VapiStruct or None) – subtree for this type within policy tree containing nested elements. When clients pass a value of this class as a parameter, the attribute must contain all the attributes defined in ChildPolicyConfigResource. When methods return a value of this class as a return value, the attribute will contain all the attributes defined in ChildPolicyConfigResource.
marked_for_delete (bool or None) – Intent objects are not directly deleted from the system when a delete is invoked on them. They are marked for deletion and only when all the realized entities for that intent object gets deleted, the intent object is deleted. Objects that are marked for deletion are not returned in GET call. One can use the search API to get these objects. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
collector_ip_address (str) – IP address for the IPFIX L2 collector. IP addresses such as 0.0.0.0, 127.0.0.1, 255.255.255.255 are invalid. format: ip
collector_port (long or None) – Port number for the IPFIX L2 collector. format: int32

class com.vmware.nsx_policy.model_client.IPFIXL2CollectorProfile(links=None, schema=None, self_=None, revision=None, create_time=None, create_user=None, last_modified_time=None, last_modified_user=None, protection=None, system_owned=None, description=None, display_name=None, id=None, resource_type=None, tags=None, parent_path=None, path=None, relative_path=None, children=None, marked_for_delete=None, ipfix_l2_collectors=None)¶

Bases: vmware.vapi.bindings.struct.VapiStruct

IPFIX L2 data will be collected on collectors.

Tip

The arguments are used to initialize data attributes with the same names.

Parameters

links (list of ResourceLink or None) – The server will populate this field when returing the resource. Ignored on PUT and POST. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
schema (str or None) – Schema for this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
self (SelfResourceLink or None) – Link to this resource
revision (long or None) – The _revision property describes the current revision of the resource. To prevent clients from overwriting each other’s changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected. format: int32
create_time (long or None) – Timestamp of resource creation format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
create_user (str or None) – ID of the user who created this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
last_modified_time (long or None) – Timestamp of last modification format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
last_modified_user (str or None) – ID of the user who last modified this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
protection (str or None) – Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super user and can modify it, but only when providing the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this entity. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
system_owned (bool or None) – Indicates system owned resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
description (str or None) – Description of this resource
display_name (str or None) – Defaults to ID if not set
id (str or None) – Unique identifier of this resource
resource_type (str or None) – The type of this resource.
tags (list of Tag or None) – Opaque identifiers meaningful to the API user
parent_path (str or None) – Path of its parent This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
path (str or None) – Absolute path of this object This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
relative_path (str or None) – Path relative from its parent This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
children (list of vmware.vapi.struct.VapiStruct or None) – subtree for this type within policy tree containing nested elements. When clients pass a value of this class as a parameter, the attribute must contain all the attributes defined in ChildPolicyConfigResource. When methods return a value of this class as a return value, the attribute will contain all the attributes defined in ChildPolicyConfigResource.
marked_for_delete (bool or None) – Intent objects are not directly deleted from the system when a delete is invoked on them. They are marked for deletion and only when all the realized entities for that intent object gets deleted, the intent object is deleted. Objects that are marked for deletion are not returned in GET call. One can use the search API to get these objects. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
ipfix_l2_collectors (list of IPFIXL2Collector) – It accepts Multiple Collector objects.

class com.vmware.nsx_policy.model_client.IPFIXL2CollectorProfileListResult(links=None, schema=None, self_=None, cursor=None, result_count=None, sort_ascending=None, sort_by=None, results=None)¶

Bases: vmware.vapi.bindings.struct.VapiStruct

Paged list of IPFIX collector profiles.

Tip

The arguments are used to initialize data attributes with the same names.

Parameters

links (list of ResourceLink or None) – The server will populate this field when returing the resource. Ignored on PUT and POST. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
schema (str or None) – Schema for this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
self (SelfResourceLink or None) – Link to this resource
cursor (str or None) – Opaque cursor to be used for getting next page of records (supplied by current result page) This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
result_count (long or None) – Count of results found (across all pages), set only on first page format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
sort_ascending (bool or None) – If true, results are sorted in ascending order This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
sort_by (str or None) – Field by which records are sorted This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
results (list of IPFIXL2CollectorProfile) – IPFIX collector Profile list results

class com.vmware.nsx_policy.model_client.IPFIXL2Profile(links=None, schema=None, self_=None, revision=None, create_time=None, create_user=None, last_modified_time=None, last_modified_user=None, protection=None, system_owned=None, description=None, display_name=None, id=None, resource_type=None, tags=None, parent_path=None, path=None, relative_path=None, children=None, marked_for_delete=None, active_timeout=None, export_overlay_flow=None, idle_timeout=None, ipfix_collector_profile_path=None, max_flows=None, observation_domain_id=None, packet_sample_probability=None, priority=None)¶

Bases: vmware.vapi.bindings.struct.VapiStruct

IPFIX data from source logical segment, port, group will be forwarded to IPFIX collector.

Tip

The arguments are used to initialize data attributes with the same names.

Parameters

links (list of ResourceLink or None) – The server will populate this field when returing the resource. Ignored on PUT and POST. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
schema (str or None) – Schema for this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
self (SelfResourceLink or None) – Link to this resource
revision (long or None) – The _revision property describes the current revision of the resource. To prevent clients from overwriting each other’s changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected. format: int32
create_time (long or None) – Timestamp of resource creation format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
create_user (str or None) – ID of the user who created this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
last_modified_time (long or None) – Timestamp of last modification format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
last_modified_user (str or None) – ID of the user who last modified this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
protection (str or None) – Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super user and can modify it, but only when providing the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this entity. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
system_owned (bool or None) – Indicates system owned resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
description (str or None) – Description of this resource
display_name (str or None) – Defaults to ID if not set
id (str or None) – Unique identifier of this resource
resource_type (str or None) – The type of this resource.
tags (list of Tag or None) – Opaque identifiers meaningful to the API user
parent_path (str or None) – Path of its parent This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
path (str or None) – Absolute path of this object This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
relative_path (str or None) – Path relative from its parent This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
children (list of vmware.vapi.struct.VapiStruct or None) – subtree for this type within policy tree containing nested elements. When clients pass a value of this class as a parameter, the attribute must contain all the attributes defined in ChildPolicyConfigResource. When methods return a value of this class as a return value, the attribute will contain all the attributes defined in ChildPolicyConfigResource.
marked_for_delete (bool or None) – Intent objects are not directly deleted from the system when a delete is invoked on them. They are marked for deletion and only when all the realized entities for that intent object gets deleted, the intent object is deleted. Objects that are marked for deletion are not returned in GET call. One can use the search API to get these objects. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
active_timeout (long or None) – The time in seconds after a flow is expired even if more packets matching this flow are received by the cache. format: int32
export_overlay_flow (bool or None) – This property controls whether overlay flow info is included in the sample result.
idle_timeout (long or None) – The time in seconds after a flow is expired if no more packets matching this flow are received by the cache. format: int32
ipfix_collector_profile_path (str) – Policy path for IPFIX collector profile. User can specify only one IPFIX collector.
max_flows (long or None) – The maximum number of flow entries in each exporter flow cache. format: int64
observation_domain_id (long or None) – An identifier that is unique to the exporting process and used to meter the flows. format: int64
packet_sample_probability (float) – The probability in percentage that a packet is sampled, in range 0-100. The probability is equal for every packet.
priority (long or None) – This priority field is used to resolve conflicts in Segment Ports which are covered by more than one IPFIX profiles. The IPFIX exporter will send records to Collectors in highest priority profile (lowest number) only. format: int32

class com.vmware.nsx_policy.model_client.IPFIXL2ProfileListResult(links=None, schema=None, self_=None, cursor=None, result_count=None, sort_ascending=None, sort_by=None, results=None)¶

Bases: vmware.vapi.bindings.struct.VapiStruct

Paged Collection of IPFIX L2 Profile

Tip

The arguments are used to initialize data attributes with the same names.

Parameters

links (list of ResourceLink or None) – The server will populate this field when returing the resource. Ignored on PUT and POST. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
schema (str or None) – Schema for this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
self (SelfResourceLink or None) – Link to this resource
cursor (str or None) – Opaque cursor to be used for getting next page of records (supplied by current result page) This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
result_count (long or None) – Count of results found (across all pages), set only on first page format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
sort_ascending (bool or None) – If true, results are sorted in ascending order This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
sort_by (str or None) – Field by which records are sorted This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
results (list of IPFIXL2Profile) – IPFIX L2 Profile list results

class com.vmware.nsx_policy.model_client.IPFIXSwitchCollectionInstance(links=None, schema=None, self_=None, revision=None, create_time=None, create_user=None, last_modified_time=None, last_modified_user=None, protection=None, system_owned=None, description=None, display_name=None, id=None, resource_type=None, tags=None, parent_path=None, path=None, relative_path=None, children=None, marked_for_delete=None, active_timeout=None, idle_timeout=None, ipfix_collector_profile_paths=None, max_flows=None, observation_domain_id=None, packet_sample_probability=None, source_logical_segment_paths=None)¶

Bases: vmware.vapi.bindings.struct.VapiStruct

IPFIX data from source logical segment will be copied to IPFIX collector.

Tip

The arguments are used to initialize data attributes with the same names.

Parameters

links (list of ResourceLink or None) – The server will populate this field when returing the resource. Ignored on PUT and POST. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
schema (str or None) – Schema for this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
self (SelfResourceLink or None) – Link to this resource
revision (long or None) – The _revision property describes the current revision of the resource. To prevent clients from overwriting each other’s changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected. format: int32
create_time (long or None) – Timestamp of resource creation format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
create_user (str or None) – ID of the user who created this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
last_modified_time (long or None) – Timestamp of last modification format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
last_modified_user (str or None) – ID of the user who last modified this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
protection (str or None) – Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super user and can modify it, but only when providing the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this entity. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
system_owned (bool or None) – Indicates system owned resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
description (str or None) – Description of this resource
display_name (str or None) – Defaults to ID if not set
id (str or None) – Unique identifier of this resource
resource_type (str or None) – The type of this resource.
tags (list of Tag or None) – Opaque identifiers meaningful to the API user
parent_path (str or None) – Path of its parent This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
path (str or None) – Absolute path of this object This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
relative_path (str or None) – Path relative from its parent This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
children (list of vmware.vapi.struct.VapiStruct or None) – subtree for this type within policy tree containing nested elements. When clients pass a value of this class as a parameter, the attribute must contain all the attributes defined in ChildPolicyConfigResource. When methods return a value of this class as a return value, the attribute will contain all the attributes defined in ChildPolicyConfigResource.
marked_for_delete (bool or None) – Intent objects are not directly deleted from the system when a delete is invoked on them. They are marked for deletion and only when all the realized entities for that intent object gets deleted, the intent object is deleted. Objects that are marked for deletion are not returned in GET call. One can use the search API to get these objects. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
active_timeout (long) – The time in seconds after a flow is expired even if more packets matching this flow are received by the cache. format: int32
idle_timeout (long) – The time in seconds after a Flow is expired if no more packets matching this Flow are received by the cache. format: int32
ipfix_collector_profile_paths (list of str) – Policy path for IPFIX collector profiles. IPFIX data from these logical segments will be sent to all specified IPFIX collectors.
max_flows (long or None) – The maximum number of flow entries in each exporter flow cache. format: int64
observation_domain_id (long or None) – An identifier that is unique to the exporting process and used to meter the Flows. format: int32
packet_sample_probability (float) – The probability in percentage that a packet is sampled, in range 0-100. The probability is equal for every packet.
source_logical_segment_paths (list of str) – Policy path for source tier-1 segment. IPFIX data from these logical segments will be sent IPFIX collector.

class com.vmware.nsx_policy.model_client.IPFIXSwitchCollectionInstanceListResult(links=None, schema=None, self_=None, cursor=None, result_count=None, sort_ascending=None, sort_by=None, results=None)¶

Bases: vmware.vapi.bindings.struct.VapiStruct

Paged Collection of IPFIX Switch Collection Instances

Tip

The arguments are used to initialize data attributes with the same names.

Parameters

links (list of ResourceLink or None) – The server will populate this field when returing the resource. Ignored on PUT and POST. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
schema (str or None) – Schema for this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
self (SelfResourceLink or None) – Link to this resource
cursor (str or None) – Opaque cursor to be used for getting next page of records (supplied by current result page) This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
result_count (long or None) – Count of results found (across all pages), set only on first page format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
sort_ascending (bool or None) – If true, results are sorted in ascending order This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
sort_by (str or None) – Field by which records are sorted This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
results (list of IPFIXSwitchCollectionInstance) – IPFIX Switch Collection Instances list results

class com.vmware.nsx_policy.model_client.IPInfo(ip_addresses=None, prefix_length=None)¶

Bases: vmware.vapi.bindings.struct.VapiStruct

Tip

The arguments are used to initialize data attributes with the same names.

Parameters

ip_addresses (list of str) – IPv4 Addresses format: ipv4
prefix_length (long) – Subnet Prefix Length format: int64

class com.vmware.nsx_policy.model_client.IPProtocolServiceEntry(protocol_number=None, links=None, schema=None, self_=None, revision=None, create_time=None, create_user=None, last_modified_time=None, last_modified_user=None, protection=None, system_owned=None, description=None, display_name=None, id=None, resource_type='IPProtocolServiceEntry', tags=None, parent_path=None, path=None, relative_path=None, children=None, marked_for_delete=None)¶

Bases: vmware.vapi.bindings.struct.VapiStruct

A ServiceEntry that represents an IP protocol

Tip

The arguments are used to initialize data attributes with the same names.

Parameters

protocol_number (long) –
links (list of ResourceLink or None) – The server will populate this field when returing the resource. Ignored on PUT and POST. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
schema (str or None) – Schema for this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
self (SelfResourceLink or None) – Link to this resource
revision (long or None) – The _revision property describes the current revision of the resource. To prevent clients from overwriting each other’s changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected. format: int32
create_time (long or None) – Timestamp of resource creation format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
create_user (str or None) – ID of the user who created this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
last_modified_time (long or None) – Timestamp of last modification format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
last_modified_user (str or None) – ID of the user who last modified this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
protection (str or None) – Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super user and can modify it, but only when providing the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this entity. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
system_owned (bool or None) – Indicates system owned resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
description (str or None) – Description of this resource
display_name (str or None) – Defaults to ID if not set
id (str or None) – Unique identifier of this resource
resource_type (str) –
Possible values are:
- ServiceEntry.RESOURCE_TYPE_IPPROTOCOLSERVICEENTRY
- ServiceEntry.RESOURCE_TYPE_IGMPTYPESERVICEENTRY
- ServiceEntry.RESOURCE_TYPE_ICMPTYPESERVICEENTRY
- ServiceEntry.RESOURCE_TYPE_ALGTYPESERVICEENTRY
- ServiceEntry.RESOURCE_TYPE_L4PORTSETSERVICEENTRY
- ServiceEntry.RESOURCE_TYPE_ETHERTYPESERVICEENTRY
tags (list of Tag or None) – Opaque identifiers meaningful to the API user
parent_path (str or None) – Path of its parent This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
path (str or None) – Absolute path of this object This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
relative_path (str or None) – Path relative from its parent This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
children (list of vmware.vapi.struct.VapiStruct or None) – subtree for this type within policy tree containing nested elements. When clients pass a value of this class as a parameter, the attribute must contain all the attributes defined in ChildPolicyConfigResource. When methods return a value of this class as a return value, the attribute will contain all the attributes defined in ChildPolicyConfigResource.
marked_for_delete (bool or None) – Intent objects are not directly deleted from the system when a delete is invoked on them. They are marked for deletion and only when all the realized entities for that intent object gets deleted, the intent object is deleted. Objects that are marked for deletion are not returned in GET call. One can use the search API to get these objects. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.

property resource_type¶: Return the discriminator value

class com.vmware.nsx_policy.model_client.IPSecVpnDpdProfile(links=None, schema=None, self_=None, revision=None, create_time=None, create_user=None, last_modified_time=None, last_modified_user=None, protection=None, system_owned=None, description=None, display_name=None, id=None, resource_type=None, tags=None, parent_path=None, path=None, relative_path=None, children=None, marked_for_delete=None, dpd_probe_interval=None, enabled=None)¶

Bases: vmware.vapi.bindings.struct.VapiStruct

Dead peer detection (DPD) is a method that allows detection of unreachable internet key excahnge (IKE) peers. Any changes affects all IPSec VPN sessions consuming this profile.

Tip

The arguments are used to initialize data attributes with the same names.

Parameters

links (list of ResourceLink or None) – The server will populate this field when returing the resource. Ignored on PUT and POST. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
schema (str or None) – Schema for this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
self (SelfResourceLink or None) – Link to this resource
revision (long or None) – The _revision property describes the current revision of the resource. To prevent clients from overwriting each other’s changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected. format: int32
create_time (long or None) – Timestamp of resource creation format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
create_user (str or None) – ID of the user who created this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
last_modified_time (long or None) – Timestamp of last modification format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
last_modified_user (str or None) – ID of the user who last modified this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
protection (str or None) – Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super user and can modify it, but only when providing the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this entity. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
system_owned (bool or None) – Indicates system owned resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
description (str or None) – Description of this resource
display_name (str or None) – Defaults to ID if not set
id (str or None) – Unique identifier of this resource
resource_type (str or None) – The type of this resource.
tags (list of Tag or None) – Opaque identifiers meaningful to the API user
parent_path (str or None) – Path of its parent This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
path (str or None) – Absolute path of this object This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
relative_path (str or None) – Path relative from its parent This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
children (list of vmware.vapi.struct.VapiStruct or None) – subtree for this type within policy tree containing nested elements. When clients pass a value of this class as a parameter, the attribute must contain all the attributes defined in ChildPolicyConfigResource. When methods return a value of this class as a return value, the attribute will contain all the attributes defined in ChildPolicyConfigResource.
marked_for_delete (bool or None) – Intent objects are not directly deleted from the system when a delete is invoked on them. They are marked for deletion and only when all the realized entities for that intent object gets deleted, the intent object is deleted. Objects that are marked for deletion are not returned in GET call. One can use the search API to get these objects. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
dpd_probe_interval (long or None) – DPD probe interval defines a periodic interval for DPD probes. format: int64
enabled (bool or None) – If true, enable dead peer detection.

class com.vmware.nsx_policy.model_client.IPSecVpnDpdProfileListResult(links=None, schema=None, self_=None, cursor=None, result_count=None, sort_ascending=None, sort_by=None, results=None)¶

Bases: vmware.vapi.bindings.struct.VapiStruct

Paged Collection of IPSecVpnDpdProfile.

Tip

The arguments are used to initialize data attributes with the same names.

Parameters

links (list of ResourceLink or None) – The server will populate this field when returing the resource. Ignored on PUT and POST. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
schema (str or None) – Schema for this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
self (SelfResourceLink or None) – Link to this resource
cursor (str or None) – Opaque cursor to be used for getting next page of records (supplied by current result page) This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
result_count (long or None) – Count of results found (across all pages), set only on first page format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
sort_ascending (bool or None) – If true, results are sorted in ascending order This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
sort_by (str or None) – Field by which records are sorted This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
results (list of IPSecVpnDpdProfile) – IPSecVpnDpdProfile list results.

class com.vmware.nsx_policy.model_client.IPSecVpnIkeProfile(links=None, schema=None, self_=None, revision=None, create_time=None, create_user=None, last_modified_time=None, last_modified_user=None, protection=None, system_owned=None, description=None, display_name=None, id=None, resource_type=None, tags=None, parent_path=None, path=None, relative_path=None, children=None, marked_for_delete=None, dh_groups=None, digest_algorithms=None, encryption_algorithms=None, ike_version=None, sa_life_time=None)¶

Bases: vmware.vapi.bindings.struct.VapiStruct

IKE Profile is a reusable profile that captures IKE phase one negotiation parameters. Any changes affects all IPSec VPN sessions consuming this profile.

Tip

The arguments are used to initialize data attributes with the same names.

Parameters

links (list of ResourceLink or None) – The server will populate this field when returing the resource. Ignored on PUT and POST. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
schema (str or None) – Schema for this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
self (SelfResourceLink or None) – Link to this resource
revision (long or None) – The _revision property describes the current revision of the resource. To prevent clients from overwriting each other’s changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected. format: int32
create_time (long or None) – Timestamp of resource creation format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
create_user (str or None) – ID of the user who created this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
last_modified_time (long or None) – Timestamp of last modification format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
last_modified_user (str or None) – ID of the user who last modified this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
protection (str or None) – Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super user and can modify it, but only when providing the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this entity. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
system_owned (bool or None) – Indicates system owned resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
description (str or None) – Description of this resource
display_name (str or None) – Defaults to ID if not set
id (str or None) – Unique identifier of this resource
resource_type (str or None) – The type of this resource.
tags (list of Tag or None) – Opaque identifiers meaningful to the API user
parent_path (str or None) – Path of its parent This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
path (str or None) – Absolute path of this object This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
relative_path (str or None) – Path relative from its parent This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
children (list of vmware.vapi.struct.VapiStruct or None) – subtree for this type within policy tree containing nested elements. When clients pass a value of this class as a parameter, the attribute must contain all the attributes defined in ChildPolicyConfigResource. When methods return a value of this class as a return value, the attribute will contain all the attributes defined in ChildPolicyConfigResource.
marked_for_delete (bool or None) – Intent objects are not directly deleted from the system when a delete is invoked on them. They are marked for deletion and only when all the realized entities for that intent object gets deleted, the intent object is deleted. Objects that are marked for deletion are not returned in GET call. One can use the search API to get these objects. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
dh_groups (list of str or None) –
Possible values are:
- IPSecVpnIkeProfile.DH_GROUPS_GROUP2
- IPSecVpnIkeProfile.DH_GROUPS_GROUP5
- IPSecVpnIkeProfile.DH_GROUPS_GROUP14
- IPSecVpnIkeProfile.DH_GROUPS_GROUP15
- IPSecVpnIkeProfile.DH_GROUPS_GROUP16
- IPSecVpnIkeProfile.DH_GROUPS_GROUP19
- IPSecVpnIkeProfile.DH_GROUPS_GROUP20
- IPSecVpnIkeProfile.DH_GROUPS_GROUP21
Diffie-Hellman group to be used if PFS is enabled. Default is GROUP14.
digest_algorithms (list of str or None) –
Possible values are:
- IPSecVpnIkeProfile.DIGEST_ALGORITHMS_SHA1
- IPSecVpnIkeProfile.DIGEST_ALGORITHMS_SHA2_256
- IPSecVpnIkeProfile.DIGEST_ALGORITHMS_SHA2_384
- IPSecVpnIkeProfile.DIGEST_ALGORITHMS_SHA2_512
Algorithm to be used for message digest during Internet Key Exchange(IKE) negotiation. Default is SHA2_256.
encryption_algorithms (list of str or None) –
Possible values are:
- IPSecVpnIkeProfile.ENCRYPTION_ALGORITHMS__128
- IPSecVpnIkeProfile.ENCRYPTION_ALGORITHMS__256
- IPSecVpnIkeProfile.ENCRYPTION_ALGORITHMS_GCM_128
- IPSecVpnIkeProfile.ENCRYPTION_ALGORITHMS_GCM_192
- IPSecVpnIkeProfile.ENCRYPTION_ALGORITHMS_GCM_256
Encryption algorithm is used during Internet Key Exchange(IKE) negotiation. Default is AES_128.
ike_version (str or None) –
Possible values are:
- IPSecVpnIkeProfile.IKE_VERSION_V1
- IPSecVpnIkeProfile.IKE_VERSION_V2
- IPSecVpnIkeProfile.IKE_VERSION_FLEX
IKE protocol version to be used. IKE-Flex will initiate IKE-V2 and responds to both IKE-V1 and IKE-V2.
sa_life_time (long or None) – Life time for security association. Default is 86400 seconds (1 day). format: int64

DH_GROUPS_GROUP14 = 'GROUP14'¶

DH_GROUPS_GROUP15 = 'GROUP15'¶

DH_GROUPS_GROUP16 = 'GROUP16'¶

DH_GROUPS_GROUP19 = 'GROUP19'¶

DH_GROUPS_GROUP2 = 'GROUP2'¶

DH_GROUPS_GROUP20 = 'GROUP20'¶

DH_GROUPS_GROUP21 = 'GROUP21'¶

DH_GROUPS_GROUP5 = 'GROUP5'¶

DIGEST_ALGORITHMS_SHA1 = 'SHA1'¶

DIGEST_ALGORITHMS_SHA2_256 = 'SHA2_256'¶

DIGEST_ALGORITHMS_SHA2_384 = 'SHA2_384'¶

DIGEST_ALGORITHMS_SHA2_512 = 'SHA2_512'¶

ENCRYPTION_ALGORITHMS_128 = 'AES_128'¶

ENCRYPTION_ALGORITHMS_256 = 'AES_256'¶

ENCRYPTION_ALGORITHMS_GCM_128 = 'AES_GCM_128'¶

ENCRYPTION_ALGORITHMS_GCM_192 = 'AES_GCM_192'¶

ENCRYPTION_ALGORITHMS_GCM_256 = 'AES_GCM_256'¶

IKE_VERSION_FLEX = 'IKE_FLEX'¶

IKE_VERSION_V1 = 'IKE_V1'¶

IKE_VERSION_V2 = 'IKE_V2'¶

class com.vmware.nsx_policy.model_client.IPSecVpnIkeProfileListResult(links=None, schema=None, self_=None, cursor=None, result_count=None, sort_ascending=None, sort_by=None, results=None)¶

Bases: vmware.vapi.bindings.struct.VapiStruct

Paged Collection of IPSecVpnIkeProfile.

Tip

The arguments are used to initialize data attributes with the same names.

Parameters

links (list of ResourceLink or None) – The server will populate this field when returing the resource. Ignored on PUT and POST. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
schema (str or None) – Schema for this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
self (SelfResourceLink or None) – Link to this resource
cursor (str or None) – Opaque cursor to be used for getting next page of records (supplied by current result page) This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
result_count (long or None) – Count of results found (across all pages), set only on first page format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
sort_ascending (bool or None) – If true, results are sorted in ascending order This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
sort_by (str or None) – Field by which records are sorted This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
results (list of IPSecVpnIkeProfile) – IPSecVpnIkeProfile list results.

class com.vmware.nsx_policy.model_client.IPSecVpnIkeSessionStatus(fail_reason=None, ike_session_state=None)¶

Bases: vmware.vapi.bindings.struct.VapiStruct

Status for IPSec VPN Ike session UP, DOWN, NEGOTIATING and fail reason if Ike session is down.

Tip

The arguments are used to initialize data attributes with the same names.

Parameters

fail_reason (str or None) – Reason for failure. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
ike_session_state (str or None) –
Possible values are:
Ike session service status UP, DOWN and NEGOTIATING.

This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.

IKE_SESSION_STATE_DOWN = 'DOWN'¶

IKE_SESSION_STATE_NEGOTIATING = 'NEGOTIATING'¶

IKE_SESSION_STATE_UP = 'UP'¶

class com.vmware.nsx_policy.model_client.IPSecVpnIkeTrafficStatistics(bytes_in=None, bytes_out=None, fail_count=None, packets_in=None, packets_out=None)¶

Bases: vmware.vapi.bindings.struct.VapiStruct

Traffic statistics for IPSec VPN Ike session. Note - Not supported in this release.

Tip

The arguments are used to initialize data attributes with the same names.

Parameters

bytes_in (long or None) – Number of bytes in. format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
bytes_out (long or None) – Number of bytes out. format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
fail_count (long or None) – Fail count. format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
packets_in (long or None) – Number of packets in. format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
packets_out (long or None) – Number of packets out. format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.

class com.vmware.nsx_policy.model_client.IPSecVpnLocalEndpoint(links=None, schema=None, self_=None, revision=None, create_time=None, create_user=None, last_modified_time=None, last_modified_user=None, protection=None, system_owned=None, description=None, display_name=None, id=None, resource_type=None, tags=None, parent_path=None, path=None, relative_path=None, children=None, marked_for_delete=None, certificate_path=None, local_address=None, local_id=None, trust_ca_paths=None, trust_crl_paths=None)¶

Bases: vmware.vapi.bindings.struct.VapiStruct

Local endpoint represents a tier-0/tier-1 on which tunnel needs to be terminated.

Tip

The arguments are used to initialize data attributes with the same names.

Parameters

links (list of ResourceLink or None) – The server will populate this field when returing the resource. Ignored on PUT and POST. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
schema (str or None) – Schema for this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
self (SelfResourceLink or None) – Link to this resource
revision (long or None) – The _revision property describes the current revision of the resource. To prevent clients from overwriting each other’s changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected. format: int32
create_time (long or None) – Timestamp of resource creation format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
create_user (str or None) – ID of the user who created this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
last_modified_time (long or None) – Timestamp of last modification format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
last_modified_user (str or None) – ID of the user who last modified this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
protection (str or None) – Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super user and can modify it, but only when providing the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this entity. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
system_owned (bool or None) – Indicates system owned resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
description (str or None) – Description of this resource
display_name (str or None) – Defaults to ID if not set
id (str or None) – Unique identifier of this resource
resource_type (str or None) – The type of this resource.
tags (list of Tag or None) – Opaque identifiers meaningful to the API user
parent_path (str or None) – Path of its parent This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
path (str or None) – Absolute path of this object This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
relative_path (str or None) – Path relative from its parent This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
children (list of vmware.vapi.struct.VapiStruct or None) – subtree for this type within policy tree containing nested elements. When clients pass a value of this class as a parameter, the attribute must contain all the attributes defined in ChildPolicyConfigResource. When methods return a value of this class as a return value, the attribute will contain all the attributes defined in ChildPolicyConfigResource.
marked_for_delete (bool or None) – Intent objects are not directly deleted from the system when a delete is invoked on them. They are marked for deletion and only when all the realized entities for that intent object gets deleted, the intent object is deleted. Objects that are marked for deletion are not returned in GET call. One can use the search API to get these objects. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
certificate_path (str or None) – Policy path referencing site certificate.
local_address (str) – IPV4 Address of local endpoint. format: ipv4
local_id (str or None) – Local identifier.
trust_ca_paths (list of str or None) – List of policy paths referencing certificate authority (CA) to verify peer certificates.
trust_crl_paths (list of str or None) – List of policy paths referencing certificate revocation list (CRL) to peer certificates.

class com.vmware.nsx_policy.model_client.IPSecVpnLocalEndpointListResult(links=None, schema=None, self_=None, cursor=None, result_count=None, sort_ascending=None, sort_by=None, results=None)¶

Bases: vmware.vapi.bindings.struct.VapiStruct

Paged Collection of IPSecVpnLocalEndpoint.

Tip

The arguments are used to initialize data attributes with the same names.

Parameters

links (list of ResourceLink or None) – The server will populate this field when returing the resource. Ignored on PUT and POST. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
schema (str or None) – Schema for this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
self (SelfResourceLink or None) – Link to this resource
cursor (str or None) – Opaque cursor to be used for getting next page of records (supplied by current result page) This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
result_count (long or None) – Count of results found (across all pages), set only on first page format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
sort_ascending (bool or None) – If true, results are sorted in ascending order This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
sort_by (str or None) – Field by which records are sorted This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
results (list of IPSecVpnLocalEndpoint) – IPSecVpnLocalEndpoint list results.

class com.vmware.nsx_policy.model_client.IPSecVpnPolicyTrafficStatistics(aggregate_traffic_counters=None, rule_path=None, tunnel_statistics=None)¶

Bases: vmware.vapi.bindings.struct.VapiStruct

IPSec VPN policy traffic statistics.

Tip

The arguments are used to initialize data attributes with the same names.

Parameters

aggregate_traffic_counters (IPSecVpnTrafficCounters or None) – Aggregate traffic statistics across all ipsec tunnels.
rule_path (str or None) – L3Vpn rule path. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
tunnel_statistics (list of IPSecVpnTunnelTrafficStatistics or None) – Tunnel statistics. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.

class com.vmware.nsx_policy.model_client.IPSecVpnRule(links=None, schema=None, self_=None, revision=None, create_time=None, create_user=None, last_modified_time=None, last_modified_user=None, protection=None, system_owned=None, description=None, display_name=None, id=None, resource_type=None, tags=None, parent_path=None, path=None, relative_path=None, children=None, marked_for_delete=None, action=None, destinations=None, enabled=None, logged=None, sequence_number=None, sources=None)¶

Bases: vmware.vapi.bindings.struct.VapiStruct

For policy-based IPsec VPNs, a security policy specifies as its action the VPN tunnel to be used for transit traffic that meets the policy’s match criteria.

Tip

The arguments are used to initialize data attributes with the same names.

Parameters

links (list of ResourceLink or None) – The server will populate this field when returing the resource. Ignored on PUT and POST. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
schema (str or None) – Schema for this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
self (SelfResourceLink or None) – Link to this resource
revision (long or None) – The _revision property describes the current revision of the resource. To prevent clients from overwriting each other’s changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected. format: int32
create_time (long or None) – Timestamp of resource creation format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
create_user (str or None) – ID of the user who created this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
last_modified_time (long or None) – Timestamp of last modification format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
last_modified_user (str or None) – ID of the user who last modified this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
protection (str or None) – Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super user and can modify it, but only when providing the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this entity. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
system_owned (bool or None) – Indicates system owned resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
description (str or None) – Description of this resource
display_name (str or None) – Defaults to ID if not set
id (str or None) – Unique identifier of this resource
resource_type (str or None) – The type of this resource.
tags (list of Tag or None) – Opaque identifiers meaningful to the API user
parent_path (str or None) – Path of its parent This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
path (str or None) – Absolute path of this object This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
relative_path (str or None) – Path relative from its parent This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
children (list of vmware.vapi.struct.VapiStruct or None) – subtree for this type within policy tree containing nested elements. When clients pass a value of this class as a parameter, the attribute must contain all the attributes defined in ChildPolicyConfigResource. When methods return a value of this class as a return value, the attribute will contain all the attributes defined in ChildPolicyConfigResource.
marked_for_delete (bool or None) – Intent objects are not directly deleted from the system when a delete is invoked on them. They are marked for deletion and only when all the realized entities for that intent object gets deleted, the intent object is deleted. Objects that are marked for deletion are not returned in GET call. One can use the search API to get these objects. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
action (str or None) –
Possible values are:
- IPSecVpnRule.ACTION_PROTECT
- IPSecVpnRule.ACTION_BYPASS
PROTECT - Protect rules are defined per policy based IPSec VPN session. BYPASS - Bypass rules are defined per IPSec VPN service and affects all policy based IPSec VPN sessions. Bypass rules are prioritized over protect rules. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
destinations (list of IPSecVpnSubnet or None) – List of peer subnets. Specifying no value is interpreted as 0.0.0.0/0.
enabled (bool or None) – A flag to enable/disable the rule.
logged (bool or None) – A flag to enable/disable the logging for the rule.
sequence_number (long or None) – A sequence number is used to give a priority to an IPSecVpnRule. format: int32
sources (list of IPSecVpnSubnet or None) – List of local subnets. Specifying no value is interpreted as 0.0.0.0/0.

ACTION_BYPASS = 'BYPASS'¶

ACTION_PROTECT = 'PROTECT'¶

class com.vmware.nsx_policy.model_client.IPSecVpnService(links=None, schema=None, self_=None, revision=None, create_time=None, create_user=None, last_modified_time=None, last_modified_user=None, protection=None, system_owned=None, description=None, display_name=None, id=None, resource_type=None, tags=None, parent_path=None, path=None, relative_path=None, children=None, marked_for_delete=None, bypass_rules=None, enabled=None, ike_log_level=None)¶

Bases: vmware.vapi.bindings.struct.VapiStruct

Create and manage IPSec VPN service for given locale service.

Tip

The arguments are used to initialize data attributes with the same names.

Parameters

links (list of ResourceLink or None) – The server will populate this field when returing the resource. Ignored on PUT and POST. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
schema (str or None) – Schema for this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
self (SelfResourceLink or None) – Link to this resource
revision (long or None) – The _revision property describes the current revision of the resource. To prevent clients from overwriting each other’s changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected. format: int32
create_time (long or None) – Timestamp of resource creation format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
create_user (str or None) – ID of the user who created this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
last_modified_time (long or None) – Timestamp of last modification format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
last_modified_user (str or None) – ID of the user who last modified this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
protection (str or None) – Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super user and can modify it, but only when providing the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this entity. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
system_owned (bool or None) – Indicates system owned resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
description (str or None) – Description of this resource
display_name (str or None) – Defaults to ID if not set
id (str or None) – Unique identifier of this resource
resource_type (str or None) – The type of this resource.
tags (list of Tag or None) – Opaque identifiers meaningful to the API user
parent_path (str or None) – Path of its parent This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
path (str or None) – Absolute path of this object This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
relative_path (str or None) – Path relative from its parent This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
children (list of vmware.vapi.struct.VapiStruct or None) – subtree for this type within policy tree containing nested elements. When clients pass a value of this class as a parameter, the attribute must contain all the attributes defined in ChildPolicyConfigResource. When methods return a value of this class as a return value, the attribute will contain all the attributes defined in ChildPolicyConfigResource.
marked_for_delete (bool or None) – Intent objects are not directly deleted from the system when a delete is invoked on them. They are marked for deletion and only when all the realized entities for that intent object gets deleted, the intent object is deleted. Objects that are marked for deletion are not returned in GET call. One can use the search API to get these objects. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
bypass_rules (list of IPSecVpnRule or None) – Bypass policy rules are configured using VPN service. Bypass rules always have higher priority over protect rules and they affect all policy based vpn sessions associated with the IPSec VPN service. Protect rules are defined per policy based vpn session.
enabled (bool or None) – If true, enable VPN services for given locale service.
ike_log_level (str or None) –
Possible values are:
- IPSecVpnService.IKE_LOG_LEVEL_DEBUG
- IPSecVpnService.IKE_LOG_LEVEL_INFO
- IPSecVpnService.IKE_LOG_LEVEL_WARN
- IPSecVpnService.IKE_LOG_LEVEL_ERROR
- IPSecVpnService.IKE_LOG_LEVEL_EMERGENCY
Log level for internet key exchange (IKE).

IKE_LOG_LEVEL_DEBUG = 'DEBUG'¶

IKE_LOG_LEVEL_EMERGENCY = 'EMERGENCY'¶

IKE_LOG_LEVEL_ERROR = 'ERROR'¶

IKE_LOG_LEVEL_INFO = 'INFO'¶

IKE_LOG_LEVEL_WARN = 'WARN'¶

class com.vmware.nsx_policy.model_client.IPSecVpnServiceListResult(links=None, schema=None, self_=None, cursor=None, result_count=None, sort_ascending=None, sort_by=None, results=None)¶

Bases: vmware.vapi.bindings.struct.VapiStruct

Paged Collection of IPSecVpnService.

Tip

The arguments are used to initialize data attributes with the same names.

Parameters

links (list of ResourceLink or None) – The server will populate this field when returing the resource. Ignored on PUT and POST. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
schema (str or None) – Schema for this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
self (SelfResourceLink or None) – Link to this resource
cursor (str or None) – Opaque cursor to be used for getting next page of records (supplied by current result page) This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
result_count (long or None) – Count of results found (across all pages), set only on first page format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
sort_ascending (bool or None) – If true, results are sorted in ascending order This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
sort_by (str or None) – Field by which records are sorted This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
results (list of IPSecVpnService) – IPSecVpnService list results.

class com.vmware.nsx_policy.model_client.IPSecVpnSession(links=None, schema=None, self_=None, revision=None, create_time=None, create_user=None, last_modified_time=None, last_modified_user=None, protection=None, system_owned=None, description=None, display_name=None, id=None, resource_type='IPSecVpnSession', tags=None, parent_path=None, path=None, relative_path=None, children=None, marked_for_delete=None, authentication_mode=None, compliance_suite=None, connection_initiation_mode=None, dpd_profile_path=None, enabled=None, ike_profile_path=None, local_endpoint_path=None, peer_address=None, peer_id=None, psk=None, tcp_mss_clamping=None, tunnel_profile_path=None)¶

Bases: vmware.vapi.bindings.struct.VapiStruct

VPN session defines connection between local and peer endpoint. Until VPN session is defined configuration is not realized.

Tip

The arguments are used to initialize data attributes with the same names.

Parameters

links (list of ResourceLink or None) – The server will populate this field when returing the resource. Ignored on PUT and POST. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
schema (str or None) – Schema for this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
self (SelfResourceLink or None) – Link to this resource
revision (long or None) – The _revision property describes the current revision of the resource. To prevent clients from overwriting each other’s changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected. format: int32
create_time (long or None) – Timestamp of resource creation format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
create_user (str or None) – ID of the user who created this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
last_modified_time (long or None) – Timestamp of last modification format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
last_modified_user (str or None) – ID of the user who last modified this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
protection (str or None) – Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super user and can modify it, but only when providing the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this entity. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
system_owned (bool or None) – Indicates system owned resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
description (str or None) – Description of this resource
display_name (str or None) – Defaults to ID if not set
id (str or None) – Unique identifier of this resource
resource_type (str) –
Possible values are:
- IPSecVpnSession.RESOURCE_TYPE_POLICYBASEDIPSECVPNSESSION
- IPSecVpnSession.RESOURCE_TYPE_ROUTEBASEDIPSECVPNSESSION
A Policy Based VPN requires to define protect rules that match local and peer subnets. IPSec security associations is negotiated for each pair of local and peer subnet. A Route Based VPN is more flexible, more powerful and recommended over policy based VPN. IP Tunnel port is created and all traffic routed via tunnel port is protected. Routes can be configured statically or can be learned through BGP. A route based VPN is must for establishing redundant VPN session to remote site.
tags (list of Tag or None) – Opaque identifiers meaningful to the API user
parent_path (str or None) – Path of its parent This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
path (str or None) – Absolute path of this object This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
relative_path (str or None) – Path relative from its parent This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
children (list of vmware.vapi.struct.VapiStruct or None) – subtree for this type within policy tree containing nested elements. When clients pass a value of this class as a parameter, the attribute must contain all the attributes defined in ChildPolicyConfigResource. When methods return a value of this class as a return value, the attribute will contain all the attributes defined in ChildPolicyConfigResource.
marked_for_delete (bool or None) – Intent objects are not directly deleted from the system when a delete is invoked on them. They are marked for deletion and only when all the realized entities for that intent object gets deleted, the intent object is deleted. Objects that are marked for deletion are not returned in GET call. One can use the search API to get these objects. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
authentication_mode (str or None) –
Possible values are:
- IPSecVpnSession.AUTHENTICATION_MODE_PSK
- IPSecVpnSession.AUTHENTICATION_MODE_CERTIFICATE
Peer authentication mode. PSK - In this mode a secret key shared between local and peer sites is to be used for authentication. The secret key can be a string with a maximum length of 128 characters. CERTIFICATE - In this mode a certificate defined at the global level is to be used for authentication.
compliance_suite (str or None) –
Possible values are:
- IPSecVpnSession.COMPLIANCE_SUITE_CNSA
- IPSecVpnSession.COMPLIANCE_SUITE_SUITE_B_GCM_128
- IPSecVpnSession.COMPLIANCE_SUITE_SUITE_B_GCM_256
- IPSecVpnSession.COMPLIANCE_SUITE_PRIME
- IPSecVpnSession.COMPLIANCE_SUITE_FOUNDATION
- IPSecVpnSession.COMPLIANCE_SUITE_FIPS
- IPSecVpnSession.COMPLIANCE_SUITE_NONE
Compliance suite.
connection_initiation_mode (str or None) –
Possible values are:
- IPSecVpnSession.CONNECTION_INITIATION_MODE_INITIATOR
- IPSecVpnSession.CONNECTION_INITIATION_MODE_RESPOND_ONLY
- IPSecVpnSession.CONNECTION_INITIATION_MODE_ON_DEMAND
Connection initiation mode used by local endpoint to establish ike connection with peer site. INITIATOR - In this mode local endpoint initiates tunnel setup and will also respond to incoming tunnel setup requests from peer gateway. RESPOND_ONLY - In this mode, local endpoint shall only respond to incoming tunnel setup requests. It shall not initiate the tunnel setup. ON_DEMAND - In this mode local endpoint will initiate tunnel creation once first packet matching the policy rule is received and will also respond to incoming initiation request.
dpd_profile_path (str or None) – Policy path referencing Dead Peer Detection (DPD) profile. Default is set to system default profile.
enabled (bool or None) – Enable/Disable IPSec VPN session.
ike_profile_path (str or None) – Policy path referencing IKE profile to be used. Default is set according to system default profile.
local_endpoint_path (str) – Policy path referencing Local endpoint.
peer_address (str) – Public IPV4 address of the remote device terminating the VPN connection.
peer_id (str) – Peer ID to uniquely identify the peer site. The peer ID is the public IP address of the remote device terminating the VPN tunnel. When NAT is configured for the peer, enter the private IP address of the peer.
psk (str or None) – IPSec Pre-shared key. Maximum length of this field is 128 characters.
tcp_mss_clamping (TcpMaximumSegmentSizeClamping or None) – TCP Maximum Segment Size Clamping Direction and Value.
tunnel_profile_path (str or None) – Policy path referencing Tunnel profile to be used. Default is set to system default profile.

AUTHENTICATION_MODE_CERTIFICATE = 'CERTIFICATE'¶

AUTHENTICATION_MODE_PSK = 'PSK'¶

COMPLIANCE_SUITE_CNSA = 'CNSA'¶

COMPLIANCE_SUITE_FIPS = 'FIPS'¶

COMPLIANCE_SUITE_FOUNDATION = 'FOUNDATION'¶

COMPLIANCE_SUITE_NONE = 'NONE'¶

COMPLIANCE_SUITE_PRIME = 'PRIME'¶

COMPLIANCE_SUITE_SUITE_B_GCM_128 = 'SUITE_B_GCM_128'¶

COMPLIANCE_SUITE_SUITE_B_GCM_256 = 'SUITE_B_GCM_256'¶

CONNECTION_INITIATION_MODE_INITIATOR = 'INITIATOR'¶

CONNECTION_INITIATION_MODE_ON_DEMAND = 'ON_DEMAND'¶

CONNECTION_INITIATION_MODE_RESPOND_ONLY = 'RESPOND_ONLY'¶

RESOURCE_TYPE_POLICYBASEDIPSECVPNSESSION = 'PolicyBasedIPSecVpnSession'¶

RESOURCE_TYPE_ROUTEBASEDIPSECVPNSESSION = 'RouteBasedIPSecVpnSession'¶

property resource_type¶: Return the discriminator value

class com.vmware.nsx_policy.model_client.IPSecVpnSessionListResult(links=None, schema=None, self_=None, cursor=None, result_count=None, sort_ascending=None, sort_by=None, results=None)¶

Bases: vmware.vapi.bindings.struct.VapiStruct

Paged Collection of IPSecVpnSession.

Tip

The arguments are used to initialize data attributes with the same names.

Parameters

links (list of ResourceLink or None) – The server will populate this field when returing the resource. Ignored on PUT and POST. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
schema (str or None) – Schema for this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
self (SelfResourceLink or None) – Link to this resource
cursor (str or None) – Opaque cursor to be used for getting next page of records (supplied by current result page) This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
result_count (long or None) – Count of results found (across all pages), set only on first page format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
sort_ascending (bool or None) – If true, results are sorted in ascending order This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
sort_by (str or None) – Field by which records are sorted This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
results (list of vmware.vapi.struct.VapiStruct) – IPSecVpnSession list results. When clients pass a value of this class as a parameter, the attribute must contain all the attributes defined in IPSecVpnSession. When methods return a value of this class as a return value, the attribute will contain all the attributes defined in IPSecVpnSession.

class com.vmware.nsx_policy.model_client.IPSecVpnSessionStatistics(aggregate_traffic_counters=None, ike_status=None, ike_traffic_statistics=None, last_update_timestamp=None, policy_statistics=None, enforcement_point_path=None, resource_type='IPSecVpnSessionStatistics')¶

Bases: vmware.vapi.bindings.struct.VapiStruct

IPSec VPN session statistics represents statistics on an NSX-T type of enforcement point. It gives aggregated statistics of all policies for all the tunnels.

Tip

The arguments are used to initialize data attributes with the same names.

Parameters

aggregate_traffic_counters (IPSecVpnTrafficCounters or None) – Aggregate traffic statistics across all ipsec tunnels.
ike_status (IPSecVpnIkeSessionStatus or None) – Status for IPSec VPN Ike session UP/DOWN and fail reason if Ike session is down.
ike_traffic_statistics (IPSecVpnIkeTrafficStatistics or None) – Traffic statistics for IPSec VPN Ike session. Note - Not supported in this release.
last_update_timestamp (long or None) – Timestamp when the data was last updated. format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
policy_statistics (list of IPSecVpnPolicyTrafficStatistics or None) – Gives aggregate traffic statistics across all ipsec tunnels and individual tunnel statistics. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
enforcement_point_path (str or None) – Policy Path referencing the enforcement point wehere the statistics are fetched. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
resource_type (str) –
Possible values are:
- L3VpnStatisticsPerEnforcementPoint.RESOURCE_TYPE_IPSECVPNSESSIONSTATISTICS

property resource_type¶: Return the discriminator value

class com.vmware.nsx_policy.model_client.IPSecVpnSessionStatisticsNsxt(aggregate_traffic_counters=None, ike_status=None, ike_traffic_statistics=None, last_update_timestamp=None, policy_statistics=None, alarm=None, enforcement_point_path=None, resource_type='IPSecVpnSessionStatisticsNsxT')¶

Bases: vmware.vapi.bindings.struct.VapiStruct

IPSec VPN session statistics represents statistics on an NSX-T type of enforcement point. It gives aggregated statistics of all policies for all the tunnels.

Tip

The arguments are used to initialize data attributes with the same names.

Parameters

aggregate_traffic_counters (IPSecVpnTrafficCounters or None) – Aggregate traffic statistics across all ipsec tunnels.
ike_status (IPSecVpnIkeSessionStatus or None) – Status for IPSec VPN Ike session UP/DOWN and fail reason if Ike session is down.
ike_traffic_statistics (IPSecVpnIkeTrafficStatistics or None) – Traffic statistics for IPSec VPN Ike session.
last_update_timestamp (long or None) – Timestamp when the data was last updated. format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
policy_statistics (list of IpSecVpnPolicyTrafficStatistics or None) – Gives aggregate traffic statistics across all ipsec tunnels and individual tunnel statistics. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
alarm (PolicyRuntimeAlarm or None) – Alarm information details.
enforcement_point_path (str or None) – Policy Path referencing the enforcement point where the info is fetched. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
resource_type (str) –
Possible values are:
- IPSecVpnSessionStatisticsPerEP.RESOURCE_TYPE_IPSECVPNSESSIONSTATISTICSNSXT

property resource_type¶: Return the discriminator value

class com.vmware.nsx_policy.model_client.IPSecVpnSessionStatisticsPerEP(alarm=None, enforcement_point_path=None, resource_type='IPSecVpnSessionStatisticsPerEP')¶

Bases: vmware.vapi.bindings.struct.VapiStruct

IPSec VPN Session Statistics Per Enforcement Point.

Tip

The arguments are used to initialize data attributes with the same names.

Parameters

alarm (PolicyRuntimeAlarm or None) – Alarm information details.
enforcement_point_path (str or None) – Policy Path referencing the enforcement point where the info is fetched. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
resource_type (str) –
Possible values are:
- IPSecVpnSessionStatisticsPerEP.RESOURCE_TYPE_IPSECVPNSESSIONSTATISTICSNSXT

RESOURCE_TYPE_IPSECVPNSESSIONSTATISTICSNSXT = 'IPSecVpnSessionStatisticsNsxT'¶

property resource_type¶: Return the discriminator value

class com.vmware.nsx_policy.model_client.IPSecVpnSessionStatusNsxt(aggregate_traffic_counters=None, failed_tunnels=None, ike_status=None, last_update_timestamp=None, negotiated_tunnels=None, runtime_status=None, total_tunnels=None, alarm=None, enforcement_point_path=None, resource_type='IPSecVpnSessionStatusNsxT')¶

Bases: vmware.vapi.bindings.struct.VapiStruct

IPSec VPN Session Status represents status on an NSX-T type of enforcement point.

Tip

The arguments are used to initialize data attributes with the same names.

Parameters

aggregate_traffic_counters (IPSecVpnTrafficCounters or None) – Aggregate traffic statistics across all ipsec tunnels.
failed_tunnels (long or None) – Number of failed tunnels. format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
ike_status (IPSecVpnIkeSessionStatus or None) – Status for IPSec VPN IKE session UP/DOWN and fail reason if IKE session is down.
last_update_timestamp (long or None) – Timestamp when the data was last updated. format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
negotiated_tunnels (long or None) – Number of negotiated tunnels. format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
runtime_status (str or None) –
Possible values are:
Gives session status consolidated using IKE status and tunnel status. It can be UP, DOWN, DEGRADED. If IKE and all tunnels are UP status will be UP, if all down it will be DOWN, otherwise it will be DEGRADED. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
total_tunnels (long or None) – Total number of tunnels. format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
alarm (PolicyRuntimeAlarm or None) – Alarm information details.
enforcement_point_path (str or None) – Policy Path referencing the enforcement point where the info is fetched. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
resource_type (str) –
Possible values are:
- IPSecVpnSessionStatusPerEP.RESOURCE_TYPE_IPSECVPNSESSIONSTATUSNSXT

RUNTIME_STATUS_DEGRADED = 'DEGRADED'¶

RUNTIME_STATUS_DOWN = 'DOWN'¶

RUNTIME_STATUS_UP = 'UP'¶

property resource_type¶: Return the discriminator value

class com.vmware.nsx_policy.model_client.IPSecVpnSessionStatusPerEP(alarm=None, enforcement_point_path=None, resource_type='IPSecVpnSessionStatusPerEP')¶

Bases: vmware.vapi.bindings.struct.VapiStruct

IPSec VPN Session Status Per Enforcement Point.

Tip

The arguments are used to initialize data attributes with the same names.

Parameters

alarm (PolicyRuntimeAlarm or None) – Alarm information details.
enforcement_point_path (str or None) – Policy Path referencing the enforcement point where the info is fetched. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
resource_type (str) –
Possible values are:
- IPSecVpnSessionStatusPerEP.RESOURCE_TYPE_IPSECVPNSESSIONSTATUSNSXT

RESOURCE_TYPE_IPSECVPNSESSIONSTATUSNSXT = 'IPSecVpnSessionStatusNsxT'¶

property resource_type¶: Return the discriminator value

class com.vmware.nsx_policy.model_client.IPSecVpnSubnet(subnet=None)¶

Bases: vmware.vapi.bindings.struct.VapiStruct

Used to specify the local/peer subnets in IPSec VPN rule.

Tip

The arguments are used to initialize data attributes with the same names.

Parameters: subnet (str) – Subnet used in policy rule. format: ipv4-cidr-block

class com.vmware.nsx_policy.model_client.IPSecVpnTrafficCounters(bytes_in=None, bytes_out=None, dropped_packets_in=None, dropped_packets_out=None, packets_in=None, packets_out=None)¶

Bases: vmware.vapi.bindings.struct.VapiStruct

Traffic counters for IPSec VPN session.

Tip

The arguments are used to initialize data attributes with the same names.

Parameters

bytes_in (long or None) – Total number of bytes recevied. format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
bytes_out (long or None) – Total number of bytes sent. format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
dropped_packets_in (long or None) – Total number of incoming packets dropped on inbound security association. format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
dropped_packets_out (long or None) – Total number of outgoing packets dropped on outbound security association. format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
packets_in (long or None) – Total number of packets received. format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
packets_out (long or None) – Total number of packets sent. format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.

class com.vmware.nsx_policy.model_client.IPSecVpnTransportStatus(session_status=None, resource_type='IPSecVpnTransportStatus', transport_tunnel_path=None)¶

Bases: vmware.vapi.bindings.struct.VapiStruct

Provides IPSec VPN session status.

Tip

The arguments are used to initialize data attributes with the same names.

Parameters

session_status (IPSecVpnSessionStatusNsxt or None) – IPSec VPN Session status
resource_type (str) –
Possible values are:
- L2VPNSessionTransportTunnelStatus.RESOURCE_TYPE_IPSECVPNTRANSPORTSTATUS
transport_tunnel_path (str or None) – Policy path referencing Transport Tunnel. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.

property resource_type¶: Return the discriminator value

class com.vmware.nsx_policy.model_client.IPSecVpnTunnelInterface(links=None, schema=None, self_=None, revision=None, create_time=None, create_user=None, last_modified_time=None, last_modified_user=None, protection=None, system_owned=None, description=None, display_name=None, id=None, resource_type=None, tags=None, parent_path=None, path=None, relative_path=None, children=None, marked_for_delete=None, ip_subnets=None)¶

Bases: vmware.vapi.bindings.struct.VapiStruct

IP tunnel interface configuration.

Tip

The arguments are used to initialize data attributes with the same names.

Parameters

links (list of ResourceLink or None) – The server will populate this field when returing the resource. Ignored on PUT and POST. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
schema (str or None) – Schema for this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
self (SelfResourceLink or None) – Link to this resource
revision (long or None) – The _revision property describes the current revision of the resource. To prevent clients from overwriting each other’s changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected. format: int32
create_time (long or None) – Timestamp of resource creation format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
create_user (str or None) – ID of the user who created this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
last_modified_time (long or None) – Timestamp of last modification format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
last_modified_user (str or None) – ID of the user who last modified this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
protection (str or None) – Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super user and can modify it, but only when providing the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this entity. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
system_owned (bool or None) – Indicates system owned resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
description (str or None) – Description of this resource
display_name (str or None) – Defaults to ID if not set
id (str or None) – Unique identifier of this resource
resource_type (str or None) – The type of this resource.
tags (list of Tag or None) – Opaque identifiers meaningful to the API user
parent_path (str or None) – Path of its parent This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
path (str or None) – Absolute path of this object This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
relative_path (str or None) – Path relative from its parent This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
children (list of vmware.vapi.struct.VapiStruct or None) – subtree for this type within policy tree containing nested elements. When clients pass a value of this class as a parameter, the attribute must contain all the attributes defined in ChildPolicyConfigResource. When methods return a value of this class as a return value, the attribute will contain all the attributes defined in ChildPolicyConfigResource.
marked_for_delete (bool or None) – Intent objects are not directly deleted from the system when a delete is invoked on them. They are marked for deletion and only when all the realized entities for that intent object gets deleted, the intent object is deleted. Objects that are marked for deletion are not returned in GET call. One can use the search API to get these objects. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
ip_subnets (list of TunnelInterfaceIPSubnet) – IP Tunnel interface (commonly referred as VTI) subnet.

class com.vmware.nsx_policy.model_client.IPSecVpnTunnelProfile(links=None, schema=None, self_=None, revision=None, create_time=None, create_user=None, last_modified_time=None, last_modified_user=None, protection=None, system_owned=None, description=None, display_name=None, id=None, resource_type=None, tags=None, parent_path=None, path=None, relative_path=None, children=None, marked_for_delete=None, df_policy=None, dh_groups=None, digest_algorithms=None, enable_perfect_forward_secrecy=None, encryption_algorithms=None, sa_life_time=None)¶

Bases: vmware.vapi.bindings.struct.VapiStruct

IPSec VPN tunnel profile is a reusable profile that captures phase two negotiation parameters and IPSec tunnel properties. Any changes affects all IPSec VPN sessions consuming this profile.

Tip

The arguments are used to initialize data attributes with the same names.

Parameters

links (list of ResourceLink or None) – The server will populate this field when returing the resource. Ignored on PUT and POST. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
schema (str or None) – Schema for this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
self (SelfResourceLink or None) – Link to this resource
revision (long or None) – The _revision property describes the current revision of the resource. To prevent clients from overwriting each other’s changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected. format: int32
create_time (long or None) – Timestamp of resource creation format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
create_user (str or None) – ID of the user who created this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
last_modified_time (long or None) – Timestamp of last modification format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
last_modified_user (str or None) – ID of the user who last modified this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
protection (str or None) – Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super user and can modify it, but only when providing the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this entity. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
system_owned (bool or None) – Indicates system owned resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
description (str or None) – Description of this resource
display_name (str or None) – Defaults to ID if not set
id (str or None) – Unique identifier of this resource
resource_type (str or None) – The type of this resource.
tags (list of Tag or None) – Opaque identifiers meaningful to the API user
parent_path (str or None) – Path of its parent This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
path (str or None) – Absolute path of this object This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
relative_path (str or None) – Path relative from its parent This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
children (list of vmware.vapi.struct.VapiStruct or None) – subtree for this type within policy tree containing nested elements. When clients pass a value of this class as a parameter, the attribute must contain all the attributes defined in ChildPolicyConfigResource. When methods return a value of this class as a return value, the attribute will contain all the attributes defined in ChildPolicyConfigResource.
marked_for_delete (bool or None) – Intent objects are not directly deleted from the system when a delete is invoked on them. They are marked for deletion and only when all the realized entities for that intent object gets deleted, the intent object is deleted. Objects that are marked for deletion are not returned in GET call. One can use the search API to get these objects. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
df_policy (str or None) –
Possible values are:
- IPSecVpnTunnelProfile.DF_POLICY_COPY
- IPSecVpnTunnelProfile.DF_POLICY_CLEAR
Defragmentation policy helps to handle defragmentation bit present in the inner packet. COPY copies the defragmentation bit from the inner IP packet into the outer packet. CLEAR ignores the defragmentation bit present in the inner packet.
dh_groups (list of str or None) –
Possible values are:
- IPSecVpnTunnelProfile.DH_GROUPS_GROUP2
- IPSecVpnTunnelProfile.DH_GROUPS_GROUP5
- IPSecVpnTunnelProfile.DH_GROUPS_GROUP14
- IPSecVpnTunnelProfile.DH_GROUPS_GROUP15
- IPSecVpnTunnelProfile.DH_GROUPS_GROUP16
- IPSecVpnTunnelProfile.DH_GROUPS_GROUP19
- IPSecVpnTunnelProfile.DH_GROUPS_GROUP20
- IPSecVpnTunnelProfile.DH_GROUPS_GROUP21
Diffie-Hellman group to be used if PFS is enabled. Default is GROUP14.
digest_algorithms (list of str or None) –
Possible values are:
- IPSecVpnTunnelProfile.DIGEST_ALGORITHMS_SHA1
- IPSecVpnTunnelProfile.DIGEST_ALGORITHMS_SHA2_256
- IPSecVpnTunnelProfile.DIGEST_ALGORITHMS_SHA2_384
- IPSecVpnTunnelProfile.DIGEST_ALGORITHMS_SHA2_512
Algorithm to be used for message digest. Default digest algorithm is implicitly covered by default encryption algorithm “AES_GCM_128”.
enable_perfect_forward_secrecy (bool or None) – If true, perfect forward secrecy (PFS) is enabled.
encryption_algorithms (list of str or None) –
Possible values are:
- IPSecVpnTunnelProfile.ENCRYPTION_ALGORITHMS_AES_128
- IPSecVpnTunnelProfile.ENCRYPTION_ALGORITHMS_AES_256
- IPSecVpnTunnelProfile.ENCRYPTION_ALGORITHMS_AES_GCM_128
- IPSecVpnTunnelProfile.ENCRYPTION_ALGORITHMS_AES_GCM_192
- IPSecVpnTunnelProfile.ENCRYPTION_ALGORITHMS_AES_GCM_256
- IPSecVpnTunnelProfile.ENCRYPTION_ALGORITHMS_NO_ENCRYPTION_AUTH_AES_GMAC_128
- IPSecVpnTunnelProfile.ENCRYPTION_ALGORITHMS_NO_ENCRYPTION_AUTH_AES_GMAC_192
- IPSecVpnTunnelProfile.ENCRYPTION_ALGORITHMS_NO_ENCRYPTION_AUTH_AES_GMAC_256
- IPSecVpnTunnelProfile.ENCRYPTION_ALGORITHMS_NO_ENCRYPTION
Encryption algorithm to encrypt/decrypt the messages exchanged between IPSec VPN initiator and responder during tunnel negotiation. Default is AES_GCM_128.
sa_life_time (long or None) – SA life time specifies the expiry time of security association. Default is 3600 seconds. format: int64

DF_POLICY_CLEAR = 'CLEAR'¶

DF_POLICY_COPY = 'COPY'¶

DH_GROUPS_GROUP14 = 'GROUP14'¶

DH_GROUPS_GROUP15 = 'GROUP15'¶

DH_GROUPS_GROUP16 = 'GROUP16'¶

DH_GROUPS_GROUP19 = 'GROUP19'¶

DH_GROUPS_GROUP2 = 'GROUP2'¶

DH_GROUPS_GROUP20 = 'GROUP20'¶

DH_GROUPS_GROUP21 = 'GROUP21'¶

DH_GROUPS_GROUP5 = 'GROUP5'¶

DIGEST_ALGORITHMS_SHA1 = 'SHA1'¶

DIGEST_ALGORITHMS_SHA2_256 = 'SHA2_256'¶

DIGEST_ALGORITHMS_SHA2_384 = 'SHA2_384'¶

DIGEST_ALGORITHMS_SHA2_512 = 'SHA2_512'¶

ENCRYPTION_ALGORITHMS_AES_128 = 'AES_128'¶

ENCRYPTION_ALGORITHMS_AES_256 = 'AES_256'¶

ENCRYPTION_ALGORITHMS_AES_GCM_128 = 'AES_GCM_128'¶

ENCRYPTION_ALGORITHMS_AES_GCM_192 = 'AES_GCM_192'¶

ENCRYPTION_ALGORITHMS_AES_GCM_256 = 'AES_GCM_256'¶

ENCRYPTION_ALGORITHMS_NO_ENCRYPTION = 'NO_ENCRYPTION'¶

ENCRYPTION_ALGORITHMS_NO_ENCRYPTION_AUTH_AES_GMAC_128 = 'NO_ENCRYPTION_AUTH_AES_GMAC_128'¶

ENCRYPTION_ALGORITHMS_NO_ENCRYPTION_AUTH_AES_GMAC_192 = 'NO_ENCRYPTION_AUTH_AES_GMAC_192'¶

ENCRYPTION_ALGORITHMS_NO_ENCRYPTION_AUTH_AES_GMAC_256 = 'NO_ENCRYPTION_AUTH_AES_GMAC_256'¶

class com.vmware.nsx_policy.model_client.IPSecVpnTunnelProfileListResult(links=None, schema=None, self_=None, cursor=None, result_count=None, sort_ascending=None, sort_by=None, results=None)¶

Bases: vmware.vapi.bindings.struct.VapiStruct

Paged Collection of IPSecVpnTunnelProfile.

Tip

The arguments are used to initialize data attributes with the same names.

Parameters

links (list of ResourceLink or None) – The server will populate this field when returing the resource. Ignored on PUT and POST. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
schema (str or None) – Schema for this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
self (SelfResourceLink or None) – Link to this resource
cursor (str or None) – Opaque cursor to be used for getting next page of records (supplied by current result page) This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
result_count (long or None) – Count of results found (across all pages), set only on first page format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
sort_ascending (bool or None) – If true, results are sorted in ascending order This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
sort_by (str or None) – Field by which records are sorted This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
results (list of IPSecVpnTunnelProfile) – IPSecVpnTunnelProfile list results.

class com.vmware.nsx_policy.model_client.IPSecVpnTunnelTrafficStatistics(bytes_in=None, bytes_out=None, decryption_failures=None, dropped_packets_in=None, dropped_packets_out=None, encryption_failures=None, integrity_failures=None, local_subnet=None, nomatching_policy_errors=None, packets_in=None, packets_out=None, packets_received_other_error=None, packets_sent_other_error=None, remote_subnet=None, replay_errors=None, sa_mismatch_errors_in=None, sa_mismatch_errors_out=None, seq_number_overflow_error=None, tunnel_down_reason=None, tunnel_status=None)¶

Bases: vmware.vapi.bindings.struct.VapiStruct

IPSec VPN tunnel traffic statistics.

Tip

The arguments are used to initialize data attributes with the same names.

Parameters

bytes_in (long or None) – Total number of incoming bytes on inbound Security association. format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
bytes_out (long or None) – Total number of outgoing bytes on outbound Security association. format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
decryption_failures (long or None) – Total number of packets dropped due to decryption failures. format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
dropped_packets_in (long or None) – Total number of incoming packets dropped on inbound security association. format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
dropped_packets_out (long or None) – Total number of outgoing packets dropped on outbound security association. format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
encryption_failures (long or None) – Total number of packets dropped because of failure in encryption. format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
integrity_failures (long or None) – Total number of packets dropped due to integrity failures. format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
local_subnet (str or None) – Local subnet to which a tunnel belongs. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
nomatching_policy_errors (long or None) – Number of packets dropped because of no matching policy is available. format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
packets_in (long or None) – Total number of incoming packets on inbound Security association. format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
packets_out (long or None) – Total number of outgoing packets on outbound Security association. format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
packets_received_other_error (long or None) – Total number of incoming packets dropped on inbound Security association. format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
packets_sent_other_error (long or None) – Total number of packets dropped while sending for any reason. format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
remote_subnet (str or None) – Peer subnet to which a tunnel belongs. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
replay_errors (long or None) – Total number of packets dropped due to replay check on that Security association. format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
sa_mismatch_errors_in (long or None) – Totoal number of security association mismatch errors on incoming packets. format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
sa_mismatch_errors_out (long or None) – Totoal number of security association mismatch errors on outgoing packets. format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
seq_number_overflow_error (long or None) – Total number of packets dropped while sending due to overflow in sequence number. format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
tunnel_down_reason (str or None) – Gives the detailed reason about the tunnel when it is down. If tunnel is UP tunnel down reason will be empty. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
tunnel_status (str or None) –
Possible values are:
- IPSecVpnTunnelTrafficStatistics.TUNNEL_STATUS_UP
- IPSecVpnTunnelTrafficStatistics.TUNNEL_STATUS_DOWN
Specifies the status of tunnel, if it is UP/DOWN.

This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.

TUNNEL_STATUS_DOWN = 'DOWN'¶

TUNNEL_STATUS_UP = 'UP'¶

class com.vmware.nsx_policy.model_client.IPv4DiscoveryOptions(arp_snooping_config=None, dhcp_snooping_enabled=None, vmtools_enabled=None)¶

Bases: vmware.vapi.bindings.struct.VapiStruct

Contains IPv4 related discovery options.

Tip

The arguments are used to initialize data attributes with the same names.

Parameters

arp_snooping_config (ArpSnoopingConfig or None) – Indicates ARP snooping options
dhcp_snooping_enabled (bool or None) – Indicates whether DHCP snooping is enabled
vmtools_enabled (bool or None) – Indicates whether fetching IP using vm-tools is enabled. This option is only supported on ESX where vm-tools is installed.

class com.vmware.nsx_policy.model_client.IPv6DADStatus(ip_address=None, status=None, transport_node=None)¶

Bases: vmware.vapi.bindings.struct.VapiStruct

IPv6 DAD status

Tip

The arguments are used to initialize data attributes with the same names.

Parameters

ip_address (str or None) – IP address on the port for which DAD status is reported. format: ip This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
status (str or None) –
Possible values are:
DAD status for IP address on the port.

This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
transport_node (list of ResourceReference or None) – Array of transport node id on which DAD status is reported for given IP address. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.

STATUS_ASSIGNED = 'ASSIGNED'¶

STATUS_DUPLICATED = 'DUPLICATED'¶

STATUS_NOT_APPLICABLE = 'NOT_APPLICABLE'¶

STATUS_TENTATIVE = 'TENTATIVE'¶

STATUS_UNKNOWN = 'UNKNOWN'¶

class com.vmware.nsx_policy.model_client.IPv6DiscoveryOptions(dhcp_snooping_v6_enabled=None, nd_snooping_config=None, vmtools_v6_enabled=None)¶

Bases: vmware.vapi.bindings.struct.VapiStruct

Contains IPv6 related discovery options.

Tip

The arguments are used to initialize data attributes with the same names.

Parameters

dhcp_snooping_v6_enabled (bool or None) – Enable this method will snoop the DHCPv6 message transaction which a VM makes with a DHCPv6 server. From the transaction, we learn the IPv6 addresses assigned by the DHCPv6 server to this VM along with its lease time.
nd_snooping_config (NdSnoopingConfig or None) – Indicates ND snooping options
vmtools_v6_enabled (bool or None) – Enable this method will learn the IPv6 addresses which are configured on interfaces of a VM with the help of the VMTools software.

class com.vmware.nsx_policy.model_client.IPv6Status(dad_statuses=None, interface_id=None)¶

Bases: vmware.vapi.bindings.struct.VapiStruct

IPv6 status

Tip

The arguments are used to initialize data attributes with the same names.

Parameters

dad_statuses (list of IPv6DADStatus or None) – Array of DAD status which contains DAD information for IP addresses on the interface. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
interface_id (str or None) – Policy path or realization ID of interface for which IPv6 DAD status is returned.

class com.vmware.nsx_policy.model_client.IcmpPolicyLbMonitorProfile(links=None, schema=None, self_=None, revision=None, create_time=None, create_user=None, last_modified_time=None, last_modified_user=None, protection=None, system_owned=None, description=None, display_name=None, id=None, resource_type='IcmpPolicyLbMonitorProfile', tags=None, parent_path=None, path=None, relative_path=None, children=None, marked_for_delete=None, fall_count=None, interval=None, monitor_port=None, rise_count=None, timeout=None)¶

Bases: vmware.vapi.bindings.struct.VapiStruct

Active healthchecks are disabled by default and can be enabled for a server pool by binding a health monitor to the Group through the PolicyLbRule object. This represents active health monitoring over ICMP. Active healthchecks are initiated periodically, at a configurable interval, to each member of the Group. Only if a healthcheck fails consecutively for a specified number of times (fall_count) to a member will the member status be marked DOWN. Once a member is DOWN, a specified number of consecutive successful healt hchecks (rise_count) will bring the member back to UP state. After a healthcheck is initiated, if it does not complete within a certain period, then also the healthcheck is considered to be unsuccessful. Completing a healthcheck within timeout means establishing a connection (TCP or SSL), if applicable, sending the request and receiving the response, all within the configured timeout.

Tip

The arguments are used to initialize data attributes with the same names.

Parameters

links (list of ResourceLink or None) – The server will populate this field when returing the resource. Ignored on PUT and POST. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
schema (str or None) – Schema for this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
self (SelfResourceLink or None) – Link to this resource
revision (long or None) – The _revision property describes the current revision of the resource. To prevent clients from overwriting each other’s changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected. format: int32
create_time (long or None) – Timestamp of resource creation format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
create_user (str or None) – ID of the user who created this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
last_modified_time (long or None) – Timestamp of last modification format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
last_modified_user (str or None) – ID of the user who last modified this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
protection (str or None) – Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super user and can modify it, but only when providing the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this entity. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
system_owned (bool or None) – Indicates system owned resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
description (str or None) – Description of this resource
display_name (str or None) – Defaults to ID if not set
id (str or None) – Unique identifier of this resource
resource_type (str) –
Possible values are:
- PolicyLbMonitorProfile.RESOURCE_TYPE_TCPPOLICYLBMONITORPROFILE
- PolicyLbMonitorProfile.RESOURCE_TYPE_UDPPOLICYLBMONITORPROFILE
- PolicyLbMonitorProfile.RESOURCE_TYPE_ICMPPOLICYLBMONITORPROFILE
- PolicyLbMonitorProfile.RESOURCE_TYPE_HTTPPOLICYLBMONITORPROFILE
- PolicyLbMonitorProfile.RESOURCE_TYPE_HTTPSPOLICYLBMONITORPROFILE
tags (list of Tag or None) – Opaque identifiers meaningful to the API user
parent_path (str or None) – Path of its parent This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
path (str or None) – Absolute path of this object This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
relative_path (str or None) – Path relative from its parent This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
children (list of vmware.vapi.struct.VapiStruct or None) – subtree for this type within policy tree containing nested elements. When clients pass a value of this class as a parameter, the attribute must contain all the attributes defined in ChildPolicyConfigResource. When methods return a value of this class as a return value, the attribute will contain all the attributes defined in ChildPolicyConfigResource.
marked_for_delete (bool or None) – Intent objects are not directly deleted from the system when a delete is invoked on them. They are marked for deletion and only when all the realized entities for that intent object gets deleted, the intent object is deleted. Objects that are marked for deletion are not returned in GET call. One can use the search API to get these objects. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
fall_count (long or None) – Only if a healthcheck fails consecutively for a specified number of times, given with fall_count, to a member will the member status be marked DOWN. format: int64
interval (long or None) – Active healthchecks are initiated periodically, at a configurable interval (in seconds), to each member of the Group. format: int64
monitor_port (long or None) – Typically, monitors perform healthchecks to Group members using the member IP address and pool_port. However, in some cases, customers prefer to run healthchecks against a different port than the pool member port which handles actual application traffic. In such cases, the port to run healthchecks against can be specified in the monitor_port value. format: int32
rise_count (long or None) – Once a member is DOWN, a specified number of consecutive successful healthchecks specified by rise_count will bring the member back to UP state. format: int64
timeout (long or None) – Timeout specified in seconds. After a healthcheck is initiated, if it does not complete within a certain period, then also the healthcheck is considered to be unsuccessful. Completing a healthcheck within timeout means establishing a connection (TCP or SSL), if applicable, sending the request and receiving the response, all within the configured timeout. format: int64

property resource_type¶: Return the discriminator value

class com.vmware.nsx_policy.model_client.Icon(placement=None, tooltip=None, type=None)¶

Bases: vmware.vapi.bindings.struct.VapiStruct

Icon to be applied at dashboard for widgets and UI elements.

Tip

The arguments are used to initialize data attributes with the same names.

Parameters

placement (str or None) –
Possible values are:
- Icon.PLACEMENT_PRE
- Icon.PLACEMENT_POST
If specified as PRE, the icon appears before the UI element. If set as POST, the icon appears after the UI element.
tooltip (list of Tooltip or None) – Multi-line text to be shown on tooltip while hovering over the icon.
type (str or None) –
Possible values are:
Icon will be rendered based on its type. For example, if ERROR is chosen, then icon representing error will be rendered.

PLACEMENT_POST = 'POST'¶

PLACEMENT_PRE = 'PRE'¶

TYPE_DETAIL = 'DETAIL'¶

TYPE_DISTRIBUTED_FIREWALL = 'DISTRIBUTED_FIREWALL'¶

TYPE_DOMAIN = 'DOMAIN'¶

TYPE_ERROR = 'ERROR'¶

TYPE_GROUP = 'GROUP'¶

TYPE_INFO = 'INFO'¶

TYPE_INPROGRESS = 'INPROGRESS'¶

TYPE_INVENTORY_GROUPS = 'INVENTORY_GROUPS'¶

TYPE_LOAD_BALANCER = 'LOAD_BALANCER'¶

TYPE_NETWORKING = 'NETWORKING'¶

TYPE_NETWORKING_TIER0 = 'NETWORKING_TIER0'¶

TYPE_NETWORKING_TIER1 = 'NETWORKING_TIER1'¶

TYPE_NOT_AVAILABLE = 'NOT_AVAILABLE'¶

TYPE_SECURITY = 'SECURITY'¶

TYPE_SECURITY_DFW = 'SECURITY_DFW'¶

TYPE_SEGMENT = 'SEGMENT'¶

TYPE_SUCCESS = 'SUCCESS'¶

TYPE_SYSTEM = 'SYSTEM'¶

TYPE_SYSTEM_BACKUPRESTORE = 'SYSTEM_BACKUPRESTORE'¶

TYPE_SYSTEM_FABRIC = 'SYSTEM_FABRIC'¶

TYPE_VPN = 'VPN'¶

TYPE_WARNING = 'WARNING'¶

class com.vmware.nsx_policy.model_client.IdentityGroupExpression(identity_groups=None, links=None, schema=None, self_=None, revision=None, create_time=None, create_user=None, last_modified_time=None, last_modified_user=None, protection=None, system_owned=None, description=None, display_name=None, id=None, resource_type='IdentityGroupExpression', tags=None, parent_path=None, path=None, relative_path=None, children=None, marked_for_delete=None)¶

Bases: vmware.vapi.bindings.struct.VapiStruct

Represents a list of identity group (Ad group SID) expressions.

Tip

The arguments are used to initialize data attributes with the same names.

Parameters

identity_groups (list of IdentityGroupInfo) – This array consists of set of identity group object. All members within this array are implicitly OR’ed together.
links (list of ResourceLink or None) – The server will populate this field when returing the resource. Ignored on PUT and POST. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
schema (str or None) – Schema for this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
self (SelfResourceLink or None) – Link to this resource
revision (long or None) – The _revision property describes the current revision of the resource. To prevent clients from overwriting each other’s changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected. format: int32
create_time (long or None) – Timestamp of resource creation format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
create_user (str or None) – ID of the user who created this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
last_modified_time (long or None) – Timestamp of last modification format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
last_modified_user (str or None) – ID of the user who last modified this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
protection (str or None) – Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super user and can modify it, but only when providing the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this entity. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
system_owned (bool or None) – Indicates system owned resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
description (str or None) – Description of this resource
display_name (str or None) – Defaults to ID if not set
id (str or None) – Unique identifier of this resource
resource_type (str) –
Possible values are:
- Expression.RESOURCE_TYPE_CONDITION
- Expression.RESOURCE_TYPE_CONJUNCTIONOPERATOR
- Expression.RESOURCE_TYPE_NESTEDEXPRESSION
- Expression.RESOURCE_TYPE_IPADDRESSEXPRESSION
- Expression.RESOURCE_TYPE_MACADDRESSEXPRESSION
- Expression.RESOURCE_TYPE_EXTERNALIDEXPRESSION
- Expression.RESOURCE_TYPE_PATHEXPRESSION
- Expression.RESOURCE_TYPE_IDENTITYGROUPEXPRESSION
tags (list of Tag or None) – Opaque identifiers meaningful to the API user
parent_path (str or None) – Path of its parent This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
path (str or None) – Absolute path of this object This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
relative_path (str or None) – Path relative from its parent This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
children (list of vmware.vapi.struct.VapiStruct or None) – subtree for this type within policy tree containing nested elements. When clients pass a value of this class as a parameter, the attribute must contain all the attributes defined in ChildPolicyConfigResource. When methods return a value of this class as a return value, the attribute will contain all the attributes defined in ChildPolicyConfigResource.
marked_for_delete (bool or None) – Intent objects are not directly deleted from the system when a delete is invoked on them. They are marked for deletion and only when all the realized entities for that intent object gets deleted, the intent object is deleted. Objects that are marked for deletion are not returned in GET call. One can use the search API to get these objects. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.

property resource_type¶: Return the discriminator value

class com.vmware.nsx_policy.model_client.IdentityGroupInfo(distinguished_name=None, domain_base_distinguished_name=None, sid=None)¶

Bases: vmware.vapi.bindings.struct.VapiStruct

Identity (Directory) group

Tip

The arguments are used to initialize data attributes with the same names.

Parameters

distinguished_name (str) – Each LDAP object is uniquely identified by its distinguished name (DN). A DN is a sequence of relative distinguished names (RDN) connected by commas. e.g. CN=Larry Cole,CN=admin,DC=corp,DC=acme,DC=com. A valid fully qualified distinguished name should be provided to include specific groups else the create / update realization of the Group containing an invalid/ partial DN will fail. This value is valid only if it matches to exactly 1 LDAP object on the LDAP server.
domain_base_distinguished_name (str) – This is the base distinguished name for the domain where this particular group resides. (e.g. dc=example,dc=com) Each active directory domain has a domain naming context (NC), which contains domain-specific data. The root of this naming context is represented by a domain’s distinguished name (DN) and is typically referred to as the NC head.
sid (str or None) – A security identifier (SID) is a unique value of variable length used to identify a trustee. A SID consists of the following components: The revision level of the SID structure; A 48-bit identifier authority value that identifies the authority that issued the SID; A variable number of subauthority or relative identifier (RID) values that uniquely identify the trustee relative to the authority that issued the SID. This field is only populated for Microsoft Active Directory identity store.

class com.vmware.nsx_policy.model_client.IncludedFieldsParameters(included_fields=None)¶

Bases: vmware.vapi.bindings.struct.VapiStruct

A list of fields to include in query results

Tip

The arguments are used to initialize data attributes with the same names.

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

class com.vmware.nsx_policy.model_client.Infra(links=None, schema=None, self_=None, revision=None, create_time=None, create_user=None, last_modified_time=None, last_modified_user=None, protection=None, system_owned=None, description=None, display_name=None, id=None, resource_type=None, tags=None, parent_path=None, path=None, relative_path=None, children=None, marked_for_delete=None, connectivity_strategy=None, domains=None)¶

Bases: vmware.vapi.bindings.struct.VapiStruct

Infra space related policy.

Tip

The arguments are used to initialize data attributes with the same names.

Parameters

links (list of ResourceLink or None) – The server will populate this field when returing the resource. Ignored on PUT and POST. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
schema (str or None) – Schema for this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
self (SelfResourceLink or None) – Link to this resource
revision (long or None) – The _revision property describes the current revision of the resource. To prevent clients from overwriting each other’s changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected. format: int32
create_time (long or None) – Timestamp of resource creation format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
create_user (str or None) – ID of the user who created this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
last_modified_time (long or None) – Timestamp of last modification format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
last_modified_user (str or None) – ID of the user who last modified this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
protection (str or None) – Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super user and can modify it, but only when providing the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this entity. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
system_owned (bool or None) – Indicates system owned resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
description (str or None) – Description of this resource
display_name (str or None) – Defaults to ID if not set
id (str or None) – Unique identifier of this resource
resource_type (str or None) – The type of this resource.
tags (list of Tag or None) – Opaque identifiers meaningful to the API user
parent_path (str or None) – Path of its parent This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
path (str or None) – Absolute path of this object This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
relative_path (str or None) – Path relative from its parent This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
children (list of vmware.vapi.struct.VapiStruct or None) – subtree for this type within policy tree containing nested elements. When clients pass a value of this class as a parameter, the attribute must contain all the attributes defined in ChildPolicyConfigResource. When methods return a value of this class as a return value, the attribute will contain all the attributes defined in ChildPolicyConfigResource.
marked_for_delete (bool or None) – Intent objects are not directly deleted from the system when a delete is invoked on them. They are marked for deletion and only when all the realized entities for that intent object gets deleted, the intent object is deleted. Objects that are marked for deletion are not returned in GET call. One can use the search API to get these objects. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
connectivity_strategy (str or None) –
Possible values are:
- Infra.CONNECTIVITY_STRATEGY_WHITELIST
- Infra.CONNECTIVITY_STRATEGY_BLACKLIST
- Infra.CONNECTIVITY_STRATEGY_WHITELIST_ENABLE_LOGGING
- Infra.CONNECTIVITY_STRATEGY_BLACKLIST_ENABLE_LOGGING
- Infra.CONNECTIVITY_STRATEGY_NONE
This field indicates the default connectivity policy for the infra or tenant space WHITELIST - Adds a default drop rule. Administrator can then use “allow” rules (aka whitelist) to allow traffic between groups BLACKLIST - Adds a default allow rule. Admin can then use “drop” rules (aka blacklist) to block traffic between groups WHITELIST_ENABLE_LOGGING - Whitelising with logging enabled BLACKLIST_ENABLE_LOGGING - Blacklisting with logging enabled NONE - No default rules are added.
domains (list of Domain or None) – This field is used while creating or updating the infra space.

CONNECTIVITY_STRATEGY_BLACKLIST = 'BLACKLIST'¶

CONNECTIVITY_STRATEGY_BLACKLIST_ENABLE_LOGGING = 'BLACKLIST_ENABLE_LOGGING'¶

CONNECTIVITY_STRATEGY_NONE = 'NONE'¶

CONNECTIVITY_STRATEGY_WHITELIST = 'WHITELIST'¶

CONNECTIVITY_STRATEGY_WHITELIST_ENABLE_LOGGING = 'WHITELIST_ENABLE_LOGGING'¶

class com.vmware.nsx_policy.model_client.IngressBroadcastRateLimiter(average_bandwidth=None, burst_size=None, peak_bandwidth=None, enabled=None, resource_type='IngressBroadcastRateLimiter')¶

Bases: vmware.vapi.bindings.struct.VapiStruct

A shaper that specifies ingress rate properties in kb/s

Tip

The arguments are used to initialize data attributes with the same names.

Parameters

average_bandwidth (long or None) – Average bandwidth in kb/s format: int32
burst_size (long or None) – Burst size in bytes format: int32
peak_bandwidth (long or None) – Peak bandwidth in kb/s format: int32
enabled (bool) –
resource_type (str) –
Possible values are:
Type rate limiter

property resource_type¶: Return the discriminator value

class com.vmware.nsx_policy.model_client.IngressRateLimiter(average_bandwidth=None, burst_size=None, peak_bandwidth=None, enabled=None, resource_type='IngressRateLimiter')¶

Bases: vmware.vapi.bindings.struct.VapiStruct

A shaper that specifies ingress rate properties in Mb/s

Tip

The arguments are used to initialize data attributes with the same names.

Parameters

average_bandwidth (long or None) – You can use the average bandwidth to reduce network congestion. format: int32
burst_size (long or None) – The burst duration is set in the burst size setting. format: int32
peak_bandwidth (long or None) – The peak bandwidth rate is used to support burst traffic. format: int32
enabled (bool) –
resource_type (str) –
Possible values are:
Type rate limiter

property resource_type¶: Return the discriminator value

class com.vmware.nsx_policy.model_client.Injection(key=None, value=None)¶

Bases: vmware.vapi.bindings.struct.VapiStruct

Injection holding a key and a corresponding value.

Tip

The arguments are used to initialize data attributes with the same names.

Parameters

key (str) – Injection key.
value (vmware.vapi.struct.VapiStruct) – Injection value. When clients pass a value of this class as a parameter, the attribute must contain all the attributes defined in InjectionValue. When methods return a value of this class as a return value, the attribute will contain all the attributes defined in InjectionValue.

class com.vmware.nsx_policy.model_client.InjectionValue(resource_type='InjectionValue')¶

Bases: vmware.vapi.bindings.struct.VapiStruct

Injection Value.

Tip

The arguments are used to initialize data attributes with the same names.

Parameters

resource_type (str) –

Possible values are:

InjectionValue.RESOURCE_TYPE_UNARYOPERATIONBASEDINJECTIONVALUE

Injection Value resource type.

RESOURCE_TYPE_UNARYOPERATIONBASEDINJECTIONVALUE = 'UnaryOperationBasedInjectionValue'¶

property resource_type¶: Return the discriminator value

class com.vmware.nsx_policy.model_client.InstanceRuntimeStatistic(interface_statistics=None, primary_runtime_stats=None, runtime_id=None, runtime_name=None)¶

Bases: vmware.vapi.bindings.struct.VapiStruct

Statistics for data NICs on an instance runtime

Tip

The arguments are used to initialize data attributes with the same names.

Parameters

interface_statistics (list of RuntimeInterfaceStatistics or None) – List of statistics for all data NICs on a runtime. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
primary_runtime_stats (bool or None) – Specifies whether statistics are for primary runtime. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
runtime_id (str or None) – Id of the instance runtime This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
runtime_name (str or None) – Name of the instance runtime This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.

class com.vmware.nsx_policy.model_client.IntentRuntimeRequestParameters(intent_path=None)¶

Bases: vmware.vapi.bindings.struct.VapiStruct

Request parameters that represents a an intent path.

Tip

The arguments are used to initialize data attributes with the same names.

Parameters: intent_path (str) – Policy Path referencing an intent object.

class com.vmware.nsx_policy.model_client.InterfaceSubnet(ip_addresses=None, prefix_len=None)¶

Bases: vmware.vapi.bindings.struct.VapiStruct

Subnet specification for interface connectivity

Tip

The arguments are used to initialize data attributes with the same names.

Parameters

ip_addresses (list of str) – IP addresses assigned to interface format: ip
prefix_len (long) – Subnet prefix length format: int32

class com.vmware.nsx_policy.model_client.IpAddressAllocation(links=None, schema=None, self_=None, revision=None, create_time=None, create_user=None, last_modified_time=None, last_modified_user=None, protection=None, system_owned=None, description=None, display_name=None, id=None, resource_type=None, tags=None, parent_path=None, path=None, relative_path=None, children=None, marked_for_delete=None, allocation_ip=None)¶

Bases: vmware.vapi.bindings.struct.VapiStruct

Allocation parameters for the IP address (e.g. specific IP address) can be specified. Tags, display_name and description attributes are not supported in this release.

Tip

The arguments are used to initialize data attributes with the same names.

Parameters

links (list of ResourceLink or None) – The server will populate this field when returing the resource. Ignored on PUT and POST. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
schema (str or None) – Schema for this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
self (SelfResourceLink or None) – Link to this resource
revision (long or None) – The _revision property describes the current revision of the resource. To prevent clients from overwriting each other’s changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected. format: int32
create_time (long or None) – Timestamp of resource creation format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
create_user (str or None) – ID of the user who created this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
last_modified_time (long or None) – Timestamp of last modification format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
last_modified_user (str or None) – ID of the user who last modified this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
protection (str or None) – Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super user and can modify it, but only when providing the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this entity. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
system_owned (bool or None) – Indicates system owned resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
description (str or None) – Description of this resource
display_name (str or None) – Defaults to ID if not set
id (str or None) – Unique identifier of this resource
resource_type (str or None) – The type of this resource.
tags (list of Tag or None) – Opaque identifiers meaningful to the API user
parent_path (str or None) – Path of its parent This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
path (str or None) – Absolute path of this object This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
relative_path (str or None) – Path relative from its parent This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
children (list of vmware.vapi.struct.VapiStruct or None) – subtree for this type within policy tree containing nested elements. When clients pass a value of this class as a parameter, the attribute must contain all the attributes defined in ChildPolicyConfigResource. When methods return a value of this class as a return value, the attribute will contain all the attributes defined in ChildPolicyConfigResource.
marked_for_delete (bool or None) – Intent objects are not directly deleted from the system when a delete is invoked on them. They are marked for deletion and only when all the realized entities for that intent object gets deleted, the intent object is deleted. Objects that are marked for deletion are not returned in GET call. One can use the search API to get these objects. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
allocation_ip (str or None) – Address that is allocated from pool format: ip This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.

class com.vmware.nsx_policy.model_client.IpAddressAllocationListResult(links=None, schema=None, self_=None, cursor=None, result_count=None, sort_ascending=None, sort_by=None, results=None)¶

Bases: vmware.vapi.bindings.struct.VapiStruct

List of IP address allocations

Tip

The arguments are used to initialize data attributes with the same names.

Parameters

links (list of ResourceLink or None) – The server will populate this field when returing the resource. Ignored on PUT and POST. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
schema (str or None) – Schema for this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
self (SelfResourceLink or None) – Link to this resource
cursor (str or None) – Opaque cursor to be used for getting next page of records (supplied by current result page) This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
result_count (long or None) – Count of results found (across all pages), set only on first page format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
sort_ascending (bool or None) – If true, results are sorted in ascending order This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
sort_by (str or None) – Field by which records are sorted This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
results (list of IpAddressAllocation or None) – List of IpAddressAllocations

class com.vmware.nsx_policy.model_client.IpAddressBlock(links=None, schema=None, self_=None, revision=None, create_time=None, create_user=None, last_modified_time=None, last_modified_user=None, protection=None, system_owned=None, description=None, display_name=None, id=None, resource_type=None, tags=None, parent_path=None, path=None, relative_path=None, children=None, marked_for_delete=None, cidr=None)¶

Bases: vmware.vapi.bindings.struct.VapiStruct

A block of IP addresses defined by a start address and a mask/prefix (network CIDR). An IP block is typically large & allocated to a tenant for automated consumption. An IP block is always a contiguous address space, for example 192.0.0.1/8. An IP block can be further subdivided into subnets called IP block subnets. These IP block subnets can be added to IP pools and used for IP allocation.

Tip

The arguments are used to initialize data attributes with the same names.

Parameters

links (list of ResourceLink or None) – The server will populate this field when returing the resource. Ignored on PUT and POST. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
schema (str or None) – Schema for this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
self (SelfResourceLink or None) – Link to this resource
revision (long or None) – The _revision property describes the current revision of the resource. To prevent clients from overwriting each other’s changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected. format: int32
create_time (long or None) – Timestamp of resource creation format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
create_user (str or None) – ID of the user who created this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
last_modified_time (long or None) – Timestamp of last modification format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
last_modified_user (str or None) – ID of the user who last modified this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
protection (str or None) – Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super user and can modify it, but only when providing the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this entity. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
system_owned (bool or None) – Indicates system owned resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
description (str or None) – Description of this resource
display_name (str or None) – Defaults to ID if not set
id (str or None) – Unique identifier of this resource
resource_type (str or None) – The type of this resource.
tags (list of Tag or None) – Opaque identifiers meaningful to the API user
parent_path (str or None) – Path of its parent This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
path (str or None) – Absolute path of this object This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
relative_path (str or None) – Path relative from its parent This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
children (list of vmware.vapi.struct.VapiStruct or None) – subtree for this type within policy tree containing nested elements. When clients pass a value of this class as a parameter, the attribute must contain all the attributes defined in ChildPolicyConfigResource. When methods return a value of this class as a return value, the attribute will contain all the attributes defined in ChildPolicyConfigResource.
marked_for_delete (bool or None) – Intent objects are not directly deleted from the system when a delete is invoked on them. They are marked for deletion and only when all the realized entities for that intent object gets deleted, the intent object is deleted. Objects that are marked for deletion are not returned in GET call. One can use the search API to get these objects. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
cidr (str) – Represents a network address and the prefix length which will be associated with a layer-2 broadcast domain. Support only IPv4 CIDR. format: ipv4-cidr-block

class com.vmware.nsx_policy.model_client.IpAddressBlockListResult(links=None, schema=None, self_=None, cursor=None, result_count=None, sort_ascending=None, sort_by=None, results=None)¶

Bases: vmware.vapi.bindings.struct.VapiStruct

Paged collection of IpAddressBlocks

Tip

The arguments are used to initialize data attributes with the same names.

Parameters

links (list of ResourceLink or None) – The server will populate this field when returing the resource. Ignored on PUT and POST. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
schema (str or None) – Schema for this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
self (SelfResourceLink or None) – Link to this resource
cursor (str or None) – Opaque cursor to be used for getting next page of records (supplied by current result page) This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
result_count (long or None) – Count of results found (across all pages), set only on first page format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
sort_ascending (bool or None) – If true, results are sorted in ascending order This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
sort_by (str or None) – Field by which records are sorted This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
results (list of IpAddressBlock) – IpAddressBlock list results

class com.vmware.nsx_policy.model_client.IpAddressInfo(ip_addresses=None, source=None)¶

Bases: vmware.vapi.bindings.struct.VapiStruct

Ipaddress information of the fabric node.

Tip

The arguments are used to initialize data attributes with the same names.

Parameters

ip_addresses (list of str or None) – IP Addresses of the the virtual network interface, as discovered in the source. format: ip This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
source (str or None) –
Possible values are:
- IpAddressInfo.SOURCE_TOOLS
Source of the ipaddress information.

This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.

SOURCE_TOOLS = 'VM_TOOLS'¶

class com.vmware.nsx_policy.model_client.IpAddressPool(links=None, schema=None, self_=None, revision=None, create_time=None, create_user=None, last_modified_time=None, last_modified_user=None, protection=None, system_owned=None, description=None, display_name=None, id=None, resource_type=None, tags=None, parent_path=None, path=None, relative_path=None, children=None, marked_for_delete=None)¶

Bases: vmware.vapi.bindings.struct.VapiStruct

IpAddressPool is a collection of subnets. The subnets can either be derived from an IpBlock or specified by the user. User can request for IP addresses to be allocated from a pool. When an IP is requested from a pool, the IP that is returned can come from any subnet that belongs to the pool.

Tip

The arguments are used to initialize data attributes with the same names.

Parameters

links (list of ResourceLink or None) – The server will populate this field when returing the resource. Ignored on PUT and POST. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
schema (str or None) – Schema for this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
self (SelfResourceLink or None) – Link to this resource
revision (long or None) – The _revision property describes the current revision of the resource. To prevent clients from overwriting each other’s changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected. format: int32
create_time (long or None) – Timestamp of resource creation format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
create_user (str or None) – ID of the user who created this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
last_modified_time (long or None) – Timestamp of last modification format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
last_modified_user (str or None) – ID of the user who last modified this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
protection (str or None) – Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super user and can modify it, but only when providing the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this entity. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
system_owned (bool or None) – Indicates system owned resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
description (str or None) – Description of this resource
display_name (str or None) – Defaults to ID if not set
id (str or None) – Unique identifier of this resource
resource_type (str or None) – The type of this resource.
tags (list of Tag or None) – Opaque identifiers meaningful to the API user
parent_path (str or None) – Path of its parent This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
path (str or None) – Absolute path of this object This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
relative_path (str or None) – Path relative from its parent This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
children (list of vmware.vapi.struct.VapiStruct or None) – subtree for this type within policy tree containing nested elements. When clients pass a value of this class as a parameter, the attribute must contain all the attributes defined in ChildPolicyConfigResource. When methods return a value of this class as a return value, the attribute will contain all the attributes defined in ChildPolicyConfigResource.
marked_for_delete (bool or None) – Intent objects are not directly deleted from the system when a delete is invoked on them. They are marked for deletion and only when all the realized entities for that intent object gets deleted, the intent object is deleted. Objects that are marked for deletion are not returned in GET call. One can use the search API to get these objects. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.

class com.vmware.nsx_policy.model_client.IpAddressPoolBlockSubnet(auto_assign_gateway=None, ip_block_path=None, size=None, links=None, schema=None, self_=None, revision=None, create_time=None, create_user=None, last_modified_time=None, last_modified_user=None, protection=None, system_owned=None, description=None, display_name=None, id=None, resource_type='IpAddressPoolBlockSubnet', tags=None, parent_path=None, path=None, relative_path=None, children=None, marked_for_delete=None)¶

Bases: vmware.vapi.bindings.struct.VapiStruct

This type of subnet allows user to dynamically carve a subnet out of a preconfigured IpAddressBlock. The user must specify the size of the subnet and the IpAddressBlock from which the subnet is to be derived. If the required amount of IP adress space is available in the specified IpAddressBlock, the system automatically configures subnet range.

Tip

The arguments are used to initialize data attributes with the same names.

Parameters

auto_assign_gateway (bool or None) – If this property is set to true, the first IP in the range will be reserved for gateway.
ip_block_path (str) – The path of the IpAddressBlock from which the subnet is to be created.
size (long) – The size parameter is required for subnet creation. It must be specified during creation but cannot be changed later. format: int64
links (list of ResourceLink or None) – The server will populate this field when returing the resource. Ignored on PUT and POST. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
schema (str or None) – Schema for this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
self (SelfResourceLink or None) – Link to this resource
revision (long or None) – The _revision property describes the current revision of the resource. To prevent clients from overwriting each other’s changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected. format: int32
create_time (long or None) – Timestamp of resource creation format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
create_user (str or None) – ID of the user who created this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
last_modified_time (long or None) – Timestamp of last modification format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
last_modified_user (str or None) – ID of the user who last modified this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
protection (str or None) – Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super user and can modify it, but only when providing the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this entity. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
system_owned (bool or None) – Indicates system owned resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
description (str or None) – Description of this resource
display_name (str or None) – Defaults to ID if not set
id (str or None) – Unique identifier of this resource
resource_type (str) –
Possible values are:
- IpAddressPoolSubnet.RESOURCE_TYPE_IPADDRESSPOOLBLOCKSUBNET
- IpAddressPoolSubnet.RESOURCE_TYPE_IPADDRESSPOOLSTATICSUBNET
Specifies whether the IpAddressPoolSubnet is to be carved out of a IpAddressBlock or will be specified by the user
tags (list of Tag or None) – Opaque identifiers meaningful to the API user
parent_path (str or None) – Path of its parent This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
path (str or None) – Absolute path of this object This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
relative_path (str or None) – Path relative from its parent This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
children (list of vmware.vapi.struct.VapiStruct or None) – subtree for this type within policy tree containing nested elements. When clients pass a value of this class as a parameter, the attribute must contain all the attributes defined in ChildPolicyConfigResource. When methods return a value of this class as a return value, the attribute will contain all the attributes defined in ChildPolicyConfigResource.
marked_for_delete (bool or None) – Intent objects are not directly deleted from the system when a delete is invoked on them. They are marked for deletion and only when all the realized entities for that intent object gets deleted, the intent object is deleted. Objects that are marked for deletion are not returned in GET call. One can use the search API to get these objects. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.

property resource_type¶: Return the discriminator value

class com.vmware.nsx_policy.model_client.IpAddressPoolListResult(links=None, schema=None, self_=None, cursor=None, result_count=None, sort_ascending=None, sort_by=None, results=None)¶

Bases: vmware.vapi.bindings.struct.VapiStruct

Paged collection of IpAddressPools

Tip

The arguments are used to initialize data attributes with the same names.

Parameters

links (list of ResourceLink or None) – The server will populate this field when returing the resource. Ignored on PUT and POST. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
schema (str or None) – Schema for this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
self (SelfResourceLink or None) – Link to this resource
cursor (str or None) – Opaque cursor to be used for getting next page of records (supplied by current result page) This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
result_count (long or None) – Count of results found (across all pages), set only on first page format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
sort_ascending (bool or None) – If true, results are sorted in ascending order This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
sort_by (str or None) – Field by which records are sorted This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
results (list of IpAddressPool) – IpAddressPool list results

class com.vmware.nsx_policy.model_client.IpAddressPoolStaticSubnet(allocation_ranges=None, cidr=None, dns_nameservers=None, dns_suffix=None, gateway_ip=None, links=None, schema=None, self_=None, revision=None, create_time=None, create_user=None, last_modified_time=None, last_modified_user=None, protection=None, system_owned=None, description=None, display_name=None, id=None, resource_type='IpAddressPoolStaticSubnet', tags=None, parent_path=None, path=None, relative_path=None, children=None, marked_for_delete=None)¶

Bases: vmware.vapi.bindings.struct.VapiStruct

This type of subnet is statically configured by the user. The user provides the range details and the gateway for the subnet.

Tip

The arguments are used to initialize data attributes with the same names.

Parameters

allocation_ranges (list of IpPoolRange) – A collection of IPv4 or IPv6 IP Pool Ranges.
cidr (str) – Subnet representation is a network address and prefix length
dns_nameservers (list of str or None) – The collection of upto 3 DNS servers for the subnet. format: ip
dns_suffix (str or None) – The DNS suffix for the DNS server. format: hostname
gateway_ip (str or None) – The default gateway address on a layer-3 router. format: ip
links (list of ResourceLink or None) – The server will populate this field when returing the resource. Ignored on PUT and POST. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
schema (str or None) – Schema for this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
self (SelfResourceLink or None) – Link to this resource
revision (long or None) – The _revision property describes the current revision of the resource. To prevent clients from overwriting each other’s changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected. format: int32
create_time (long or None) – Timestamp of resource creation format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
create_user (str or None) – ID of the user who created this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
last_modified_time (long or None) – Timestamp of last modification format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
last_modified_user (str or None) – ID of the user who last modified this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
protection (str or None) – Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super user and can modify it, but only when providing the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this entity. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
system_owned (bool or None) – Indicates system owned resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
description (str or None) – Description of this resource
display_name (str or None) – Defaults to ID if not set
id (str or None) – Unique identifier of this resource
resource_type (str) –
Possible values are:
- IpAddressPoolSubnet.RESOURCE_TYPE_IPADDRESSPOOLBLOCKSUBNET
- IpAddressPoolSubnet.RESOURCE_TYPE_IPADDRESSPOOLSTATICSUBNET
Specifies whether the IpAddressPoolSubnet is to be carved out of a IpAddressBlock or will be specified by the user
tags (list of Tag or None) – Opaque identifiers meaningful to the API user
parent_path (str or None) – Path of its parent This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
path (str or None) – Absolute path of this object This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
relative_path (str or None) – Path relative from its parent This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
children (list of vmware.vapi.struct.VapiStruct or None) – subtree for this type within policy tree containing nested elements. When clients pass a value of this class as a parameter, the attribute must contain all the attributes defined in ChildPolicyConfigResource. When methods return a value of this class as a return value, the attribute will contain all the attributes defined in ChildPolicyConfigResource.
marked_for_delete (bool or None) – Intent objects are not directly deleted from the system when a delete is invoked on them. They are marked for deletion and only when all the realized entities for that intent object gets deleted, the intent object is deleted. Objects that are marked for deletion are not returned in GET call. One can use the search API to get these objects. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.

property resource_type¶: Return the discriminator value

class com.vmware.nsx_policy.model_client.IpAddressPoolSubnet(links=None, schema=None, self_=None, revision=None, create_time=None, create_user=None, last_modified_time=None, last_modified_user=None, protection=None, system_owned=None, description=None, display_name=None, id=None, resource_type='IpAddressPoolSubnet', tags=None, parent_path=None, path=None, relative_path=None, children=None, marked_for_delete=None)¶

Bases: vmware.vapi.bindings.struct.VapiStruct

IpAddressPoolSubnet can either be carved out of a PolicyBlock or statically specified by the user. In the first case where the subnet is carved out of a IpAddressBlock, the user must specify the ID of the block from which this subnet is to be derived. This block must be pre-created. The subnet range is auto populated by the system. In the second case, the user configures the subnet range directly. No IpAddressBlock is required.

Tip

The arguments are used to initialize data attributes with the same names.

Parameters

links (list of ResourceLink or None) – The server will populate this field when returing the resource. Ignored on PUT and POST. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
schema (str or None) – Schema for this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
self (SelfResourceLink or None) – Link to this resource
revision (long or None) – The _revision property describes the current revision of the resource. To prevent clients from overwriting each other’s changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected. format: int32
create_time (long or None) – Timestamp of resource creation format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
create_user (str or None) – ID of the user who created this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
last_modified_time (long or None) – Timestamp of last modification format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
last_modified_user (str or None) – ID of the user who last modified this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
protection (str or None) – Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super user and can modify it, but only when providing the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this entity. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
system_owned (bool or None) – Indicates system owned resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
description (str or None) – Description of this resource
display_name (str or None) – Defaults to ID if not set
id (str or None) – Unique identifier of this resource
resource_type (str) –
Possible values are:
- IpAddressPoolSubnet.RESOURCE_TYPE_IPADDRESSPOOLBLOCKSUBNET
- IpAddressPoolSubnet.RESOURCE_TYPE_IPADDRESSPOOLSTATICSUBNET
Specifies whether the IpAddressPoolSubnet is to be carved out of a IpAddressBlock or will be specified by the user
tags (list of Tag or None) – Opaque identifiers meaningful to the API user
parent_path (str or None) – Path of its parent This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
path (str or None) – Absolute path of this object This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
relative_path (str or None) – Path relative from its parent This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
children (list of vmware.vapi.struct.VapiStruct or None) – subtree for this type within policy tree containing nested elements. When clients pass a value of this class as a parameter, the attribute must contain all the attributes defined in ChildPolicyConfigResource. When methods return a value of this class as a return value, the attribute will contain all the attributes defined in ChildPolicyConfigResource.
marked_for_delete (bool or None) – Intent objects are not directly deleted from the system when a delete is invoked on them. They are marked for deletion and only when all the realized entities for that intent object gets deleted, the intent object is deleted. Objects that are marked for deletion are not returned in GET call. One can use the search API to get these objects. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.

RESOURCE_TYPE_IPADDRESSPOOLBLOCKSUBNET = 'IpAddressPoolBlockSubnet'¶

RESOURCE_TYPE_IPADDRESSPOOLSTATICSUBNET = 'IpAddressPoolStaticSubnet'¶

property resource_type¶: Return the discriminator value

class com.vmware.nsx_policy.model_client.IpAddressPoolSubnetListResult(links=None, schema=None, self_=None, cursor=None, result_count=None, sort_ascending=None, sort_by=None, results=None)¶

Bases: vmware.vapi.bindings.struct.VapiStruct

Tip

The arguments are used to initialize data attributes with the same names.

Parameters

links (list of ResourceLink or None) – The server will populate this field when returing the resource. Ignored on PUT and POST. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
schema (str or None) – Schema for this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
self (SelfResourceLink or None) – Link to this resource
cursor (str or None) – Opaque cursor to be used for getting next page of records (supplied by current result page) This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
result_count (long or None) – Count of results found (across all pages), set only on first page format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
sort_ascending (bool or None) – If true, results are sorted in ascending order This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
sort_by (str or None) – Field by which records are sorted This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
results (list of vmware.vapi.struct.VapiStruct) – IP Pool subnet list results When clients pass a value of this class as a parameter, the attribute must contain all the attributes defined in IpAddressPoolSubnet. When methods return a value of this class as a return value, the attribute will contain all the attributes defined in IpAddressPoolSubnet.

class com.vmware.nsx_policy.model_client.IpPoolRange(links=None, schema=None, self_=None, end=None, start=None)¶

Bases: vmware.vapi.bindings.struct.VapiStruct

A set of IPv4 or IPv6 addresses defined by a start and end address.

Tip

The arguments are used to initialize data attributes with the same names.

Parameters

links (list of ResourceLink or None) – The server will populate this field when returing the resource. Ignored on PUT and POST. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
schema (str or None) – Schema for this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
self (SelfResourceLink or None) – Link to this resource
end (str) – The end IP Address of the IP Range. format: ip
start (str) – The start IP Address of the IP Range. format: ip

class com.vmware.nsx_policy.model_client.IpSecVpnPolicyTrafficStatistics(aggregate_traffic_counters=None, rule_path=None, tunnel_interface_path=None, tunnel_statistics=None)¶

Bases: vmware.vapi.bindings.struct.VapiStruct

IPSec VPN policy traffic statistics

Tip

The arguments are used to initialize data attributes with the same names.

Parameters

aggregate_traffic_counters (IPSecVpnTrafficCounters or None) – Aggregate traffic statistics across all IPSec tunnels.
rule_path (str or None) – Policy path referencing the IPSec VPN Rule. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
tunnel_interface_path (str or None) – Policy path referencing the IPSec VPN Tunnel Interface. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
tunnel_statistics (list of IpSecVpnTunnelTrafficStatistics or None) – Tunnel statistics. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.

class com.vmware.nsx_policy.model_client.IpSecVpnTunnelTrafficStatistics(bytes_in=None, bytes_out=None, decryption_failures=None, dropped_packets_in=None, dropped_packets_out=None, encryption_failures=None, integrity_failures=None, local_subnet=None, nomatching_policy_errors=None, packets_in=None, packets_out=None, packets_received_other_error=None, packets_sent_other_error=None, peer_subnet=None, replay_errors=None, sa_mismatch_errors_in=None, sa_mismatch_errors_out=None, seq_number_overflow_error=None, tunnel_down_reason=None, tunnel_status=None)¶

Bases: vmware.vapi.bindings.struct.VapiStruct

IPSec VPN tunnel traffic statistics.

Tip

The arguments are used to initialize data attributes with the same names.

Parameters

bytes_in (long or None) – Total number of incoming bytes on inbound Security association. format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
bytes_out (long or None) – Total number of outgoing bytes on outbound Security association. format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
decryption_failures (long or None) – Total number of packets dropped due to decryption failures. format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
dropped_packets_in (long or None) – Total number of incoming packets dropped on inbound security association. format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
dropped_packets_out (long or None) – Total number of outgoing packets dropped on outbound security association. format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
encryption_failures (long or None) – Total number of packets dropped because of failure in encryption. format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
integrity_failures (long or None) – Total number of packets dropped due to integrity failures. format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
local_subnet (str or None) – Tunnel local subnet in IPv4 CIDR Block format. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
nomatching_policy_errors (long or None) – Number of packets dropped because of no matching policy is available. format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
packets_in (long or None) – Total number of incoming packets on inbound Security association. format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
packets_out (long or None) – Total number of outgoing packets on outbound Security association. format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
packets_received_other_error (long or None) – Total number of incoming packets dropped on inbound Security association. format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
packets_sent_other_error (long or None) – Total number of packets dropped while sending for any reason. format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
peer_subnet (str or None) – Tunnel peer subnet in IPv4 CIDR Block format. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
replay_errors (long or None) – Total number of packets dropped due to replay check on that Security association. format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
sa_mismatch_errors_in (long or None) – Totoal number of security association mismatch errors on incoming packets. format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
sa_mismatch_errors_out (long or None) – Totoal number of security association mismatch errors on outgoing packets. format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
seq_number_overflow_error (long or None) – Total number of packets dropped while sending due to overflow in sequence number. format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
tunnel_down_reason (str or None) – Gives the detailed reason about the tunnel when it is down. If tunnel is UP tunnel down reason will be empty. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
tunnel_status (str or None) –
Possible values are:
- IpSecVpnTunnelTrafficStatistics.TUNNEL_STATUS_UP
- IpSecVpnTunnelTrafficStatistics.TUNNEL_STATUS_DOWN
Specifies the status of tunnel, if it is UP/DOWN.

This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.

TUNNEL_STATUS_DOWN = 'DOWN'¶

TUNNEL_STATUS_UP = 'UP'¶

class com.vmware.nsx_policy.model_client.Ipv6DadProfile(links=None, schema=None, self_=None, revision=None, create_time=None, create_user=None, last_modified_time=None, last_modified_user=None, protection=None, system_owned=None, description=None, display_name=None, id=None, resource_type=None, tags=None, parent_path=None, path=None, relative_path=None, children=None, marked_for_delete=None, dad_mode=None, ns_retries=None, wait_time=None)¶

Bases: vmware.vapi.bindings.struct.VapiStruct

Duplicate address detection profile.

Tip

The arguments are used to initialize data attributes with the same names.

Parameters

links (list of ResourceLink or None) – The server will populate this field when returing the resource. Ignored on PUT and POST. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
schema (str or None) – Schema for this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
self (SelfResourceLink or None) – Link to this resource
revision (long or None) – The _revision property describes the current revision of the resource. To prevent clients from overwriting each other’s changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected. format: int32
create_time (long or None) – Timestamp of resource creation format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
create_user (str or None) – ID of the user who created this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
last_modified_time (long or None) – Timestamp of last modification format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
last_modified_user (str or None) – ID of the user who last modified this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
protection (str or None) – Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super user and can modify it, but only when providing the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this entity. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
system_owned (bool or None) – Indicates system owned resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
description (str or None) – Description of this resource
display_name (str or None) – Defaults to ID if not set
id (str or None) – Unique identifier of this resource
resource_type (str or None) – The type of this resource.
tags (list of Tag or None) – Opaque identifiers meaningful to the API user
parent_path (str or None) – Path of its parent This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
path (str or None) – Absolute path of this object This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
relative_path (str or None) – Path relative from its parent This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
children (list of vmware.vapi.struct.VapiStruct or None) – subtree for this type within policy tree containing nested elements. When clients pass a value of this class as a parameter, the attribute must contain all the attributes defined in ChildPolicyConfigResource. When methods return a value of this class as a return value, the attribute will contain all the attributes defined in ChildPolicyConfigResource.
marked_for_delete (bool or None) – Intent objects are not directly deleted from the system when a delete is invoked on them. They are marked for deletion and only when all the realized entities for that intent object gets deleted, the intent object is deleted. Objects that are marked for deletion are not returned in GET call. One can use the search API to get these objects. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
dad_mode (str or None) –
Possible values are:
- Ipv6DadProfile.DAD_MODE_LOOSE
- Ipv6DadProfile.DAD_MODE_STRICT
DAD Mode
ns_retries (long or None) – Number of Neighbor solicitation packets generated before completing the Duplicate address detection process. format: int64
wait_time (long or None) – The time duration in seconds, to wait for Neighbor advertisement after sending the Neighbor solicitation message. format: int64

DAD_MODE_LOOSE = 'LOOSE'¶

DAD_MODE_STRICT = 'STRICT'¶

class com.vmware.nsx_policy.model_client.Ipv6DadProfileListResult(links=None, schema=None, self_=None, cursor=None, result_count=None, sort_ascending=None, sort_by=None, results=None)¶

Bases: vmware.vapi.bindings.struct.VapiStruct

Tip

The arguments are used to initialize data attributes with the same names.

Parameters

links (list of ResourceLink or None) – The server will populate this field when returing the resource. Ignored on PUT and POST. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
schema (str or None) – Schema for this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
self (SelfResourceLink or None) – Link to this resource
cursor (str or None) – Opaque cursor to be used for getting next page of records (supplied by current result page) This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
result_count (long or None) – Count of results found (across all pages), set only on first page format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
sort_ascending (bool or None) – If true, results are sorted in ascending order This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
sort_by (str or None) – Field by which records are sorted This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
results (list of Ipv6DadProfile) – Paginated list of Ipv6DadProfile

class com.vmware.nsx_policy.model_client.Ipv6NdraProfile(links=None, schema=None, self_=None, revision=None, create_time=None, create_user=None, last_modified_time=None, last_modified_user=None, protection=None, system_owned=None, description=None, display_name=None, id=None, resource_type=None, tags=None, parent_path=None, path=None, relative_path=None, children=None, marked_for_delete=None, dns_config=None, ra_config=None, ra_mode=None, reachable_timer=None, retransmit_interval=None)¶

Bases: vmware.vapi.bindings.struct.VapiStruct

Tip

The arguments are used to initialize data attributes with the same names.

Parameters

links (list of ResourceLink or None) – The server will populate this field when returing the resource. Ignored on PUT and POST. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
schema (str or None) – Schema for this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
self (SelfResourceLink or None) – Link to this resource
revision (long or None) – The _revision property describes the current revision of the resource. To prevent clients from overwriting each other’s changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected. format: int32
create_time (long or None) – Timestamp of resource creation format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
create_user (str or None) – ID of the user who created this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
last_modified_time (long or None) – Timestamp of last modification format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
last_modified_user (str or None) – ID of the user who last modified this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
protection (str or None) – Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super user and can modify it, but only when providing the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this entity. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
system_owned (bool or None) – Indicates system owned resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
description (str or None) – Description of this resource
display_name (str or None) – Defaults to ID if not set
id (str or None) – Unique identifier of this resource
resource_type (str or None) – The type of this resource.
tags (list of Tag or None) – Opaque identifiers meaningful to the API user
parent_path (str or None) – Path of its parent This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
path (str or None) – Absolute path of this object This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
relative_path (str or None) – Path relative from its parent This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
children (list of vmware.vapi.struct.VapiStruct or None) – subtree for this type within policy tree containing nested elements. When clients pass a value of this class as a parameter, the attribute must contain all the attributes defined in ChildPolicyConfigResource. When methods return a value of this class as a return value, the attribute will contain all the attributes defined in ChildPolicyConfigResource.
marked_for_delete (bool or None) – Intent objects are not directly deleted from the system when a delete is invoked on them. They are marked for deletion and only when all the realized entities for that intent object gets deleted, the intent object is deleted. Objects that are marked for deletion are not returned in GET call. One can use the search API to get these objects. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
dns_config (RaDNSConfig or None) – DNS Configurations
ra_config (RAConfig) – RA Configuration
ra_mode (str) –
Possible values are:
- Ipv6NdraProfile.RA_MODE_DISABLED
- Ipv6NdraProfile.RA_MODE_SLAAC_DNS_THROUGH_RA
- Ipv6NdraProfile.RA_MODE_SLAAC_DNS_THROUGH_DHCP
- Ipv6NdraProfile.RA_MODE_DHCP_ADDRESS_AND_DNS_THROUGH_DHCP
- Ipv6NdraProfile.RA_MODE_SLAAC_AND_ADDRESS_DNS_THROUGH_DHCP
  
  RA Mode
reachable_timer (long or None) – Neighbour reachable time duration in milliseconds. A value of 0 means unspecified. format: int64
retransmit_interval (long or None) – The time, in milliseconds, between retransmitted neighbour solicitation messages. A value of 0 means unspecified. format: int64

RA_MODE_DHCP_ADDRESS_AND_DNS_THROUGH_DHCP = 'DHCP_ADDRESS_AND_DNS_THROUGH_DHCP'¶

RA_MODE_DISABLED = 'DISABLED'¶

RA_MODE_SLAAC_AND_ADDRESS_DNS_THROUGH_DHCP = 'SLAAC_AND_ADDRESS_DNS_THROUGH_DHCP'¶

RA_MODE_SLAAC_DNS_THROUGH_DHCP = 'SLAAC_DNS_THROUGH_DHCP'¶

RA_MODE_SLAAC_DNS_THROUGH_RA = 'SLAAC_DNS_THROUGH_RA'¶

class com.vmware.nsx_policy.model_client.Ipv6NdraProfileListResult(links=None, schema=None, self_=None, cursor=None, result_count=None, sort_ascending=None, sort_by=None, results=None)¶

Bases: vmware.vapi.bindings.struct.VapiStruct

Tip

The arguments are used to initialize data attributes with the same names.

Parameters

links (list of ResourceLink or None) – The server will populate this field when returing the resource. Ignored on PUT and POST. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
schema (str or None) – Schema for this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
self (SelfResourceLink or None) – Link to this resource
cursor (str or None) – Opaque cursor to be used for getting next page of records (supplied by current result page) This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
result_count (long or None) – Count of results found (across all pages), set only on first page format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
sort_ascending (bool or None) – If true, results are sorted in ascending order This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
sort_by (str or None) – Field by which records are sorted This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
results (list of Ipv6NdraProfile) – Paginated list of Ipv6NdraProfile

class com.vmware.nsx_policy.model_client.KeyValuePair(key=None, value=None)¶

Bases: vmware.vapi.bindings.struct.VapiStruct

An arbitrary key-value pair

Tip

The arguments are used to initialize data attributes with the same names.

Parameters

key (str) – Key
value (str) – Value

class com.vmware.nsx_policy.model_client.L2Extension(l2vpn_path=None, l2vpn_paths=None, tunnel_id=None)¶

Bases: vmware.vapi.bindings.struct.VapiStruct

Segment specific L2 VPN configuration

Tip

The arguments are used to initialize data attributes with the same names.

Parameters

l2vpn_path (str or None) – This property has been deprecated. Please use the property l2vpn_paths for setting the paths of associated L2 VPN session. This property will continue to work as expected to provide backwards compatibility. However, when both l2vpn_path and l2vpn_paths properties are specified, only l2vpn_paths is used.
l2vpn_paths (list of str or None) – Policy paths corresponding to the associated L2 VPN sessions
tunnel_id (long or None) – Tunnel ID format: int32

class com.vmware.nsx_policy.model_client.L2VPNService(links=None, schema=None, self_=None, revision=None, create_time=None, create_user=None, last_modified_time=None, last_modified_user=None, protection=None, system_owned=None, description=None, display_name=None, id=None, resource_type=None, tags=None, parent_path=None, path=None, relative_path=None, children=None, marked_for_delete=None, enable_hub=None, mode=None)¶

Bases: vmware.vapi.bindings.struct.VapiStruct

L2VPN Service defines if service running as server or client. It also defines all the common properties for the multiple L2VPN Sessions associated with this service.

Tip

The arguments are used to initialize data attributes with the same names.

Parameters

links (list of ResourceLink or None) – The server will populate this field when returing the resource. Ignored on PUT and POST. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
schema (str or None) – Schema for this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
self (SelfResourceLink or None) – Link to this resource
revision (long or None) – The _revision property describes the current revision of the resource. To prevent clients from overwriting each other’s changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected. format: int32
create_time (long or None) – Timestamp of resource creation format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
create_user (str or None) – ID of the user who created this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
last_modified_time (long or None) – Timestamp of last modification format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
last_modified_user (str or None) – ID of the user who last modified this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
protection (str or None) – Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super user and can modify it, but only when providing the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this entity. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
system_owned (bool or None) – Indicates system owned resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
description (str or None) – Description of this resource
display_name (str or None) – Defaults to ID if not set
id (str or None) – Unique identifier of this resource
resource_type (str or None) – The type of this resource.
tags (list of Tag or None) – Opaque identifiers meaningful to the API user
parent_path (str or None) – Path of its parent This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
path (str or None) – Absolute path of this object This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
relative_path (str or None) – Path relative from its parent This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
children (list of vmware.vapi.struct.VapiStruct or None) – subtree for this type within policy tree containing nested elements. When clients pass a value of this class as a parameter, the attribute must contain all the attributes defined in ChildPolicyConfigResource. When methods return a value of this class as a return value, the attribute will contain all the attributes defined in ChildPolicyConfigResource.
marked_for_delete (bool or None) – Intent objects are not directly deleted from the system when a delete is invoked on them. They are marked for deletion and only when all the realized entities for that intent object gets deleted, the intent object is deleted. Objects that are marked for deletion are not returned in GET call. One can use the search API to get these objects. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
enable_hub (bool or None) – This property applies only in SERVER mode. If set to true, traffic from any client will be replicated to all other clients. If set to false, traffic received from clients is only replicated to the local VPN endpoint.
mode (str or None) –
Possible values are:
- L2VPNService.MODE_SERVER
- L2VPNService.MODE_CLIENT
Specify an L2VPN service mode as SERVER or CLIENT.

MODE_CLIENT = 'CLIENT'¶

MODE_SERVER = 'SERVER'¶

class com.vmware.nsx_policy.model_client.L2VPNServiceListResult(links=None, schema=None, self_=None, cursor=None, result_count=None, sort_ascending=None, sort_by=None, results=None)¶

Bases: vmware.vapi.bindings.struct.VapiStruct

Paged Collection of L2VPNServices

Tip

The arguments are used to initialize data attributes with the same names.

Parameters

links (list of ResourceLink or None) – The server will populate this field when returing the resource. Ignored on PUT and POST. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
schema (str or None) – Schema for this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
self (SelfResourceLink or None) – Link to this resource
cursor (str or None) – Opaque cursor to be used for getting next page of records (supplied by current result page) This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
result_count (long or None) – Count of results found (across all pages), set only on first page format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
sort_ascending (bool or None) – If true, results are sorted in ascending order This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
sort_by (str or None) – Field by which records are sorted This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
results (list of L2VPNService) – L2VPNService list results

class com.vmware.nsx_policy.model_client.L2VPNSession(links=None, schema=None, self_=None, revision=None, create_time=None, create_user=None, last_modified_time=None, last_modified_user=None, protection=None, system_owned=None, description=None, display_name=None, id=None, resource_type=None, tags=None, parent_path=None, path=None, relative_path=None, children=None, marked_for_delete=None, enabled=None, transport_tunnels=None, tunnel_encapsulation=None)¶

Bases: vmware.vapi.bindings.struct.VapiStruct

Defines the tunnel local and peer addresses along with multiple tansport tunnels for redundancy. L2VPNSession belongs to only one L2VPNService.

Tip

The arguments are used to initialize data attributes with the same names.

Parameters

links (list of ResourceLink or None) – The server will populate this field when returing the resource. Ignored on PUT and POST. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
schema (str or None) – Schema for this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
self (SelfResourceLink or None) – Link to this resource
revision (long or None) – The _revision property describes the current revision of the resource. To prevent clients from overwriting each other’s changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected. format: int32
create_time (long or None) – Timestamp of resource creation format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
create_user (str or None) – ID of the user who created this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
last_modified_time (long or None) – Timestamp of last modification format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
last_modified_user (str or None) – ID of the user who last modified this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
protection (str or None) – Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super user and can modify it, but only when providing the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this entity. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
system_owned (bool or None) – Indicates system owned resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
description (str or None) – Description of this resource
display_name (str or None) – Defaults to ID if not set
id (str or None) – Unique identifier of this resource
resource_type (str or None) – The type of this resource.
tags (list of Tag or None) – Opaque identifiers meaningful to the API user
parent_path (str or None) – Path of its parent This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
path (str or None) – Absolute path of this object This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
relative_path (str or None) – Path relative from its parent This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
children (list of vmware.vapi.struct.VapiStruct or None) – subtree for this type within policy tree containing nested elements. When clients pass a value of this class as a parameter, the attribute must contain all the attributes defined in ChildPolicyConfigResource. When methods return a value of this class as a return value, the attribute will contain all the attributes defined in ChildPolicyConfigResource.
marked_for_delete (bool or None) – Intent objects are not directly deleted from the system when a delete is invoked on them. They are marked for deletion and only when all the realized entities for that intent object gets deleted, the intent object is deleted. Objects that are marked for deletion are not returned in GET call. One can use the search API to get these objects. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
enabled (bool or None) – Enable to extend all the associated segments.
transport_tunnels (list of str) – List of transport tunnels for redundancy.
tunnel_encapsulation (L2VPNTunnelEncapsulation or None) – Tunnel encapsulation config. This property only applies in CLIENT mode. It is auto-populated from the L2VPNSessionData.

class com.vmware.nsx_policy.model_client.L2VPNSessionData(description=None, display_name=None, enabled=None, transport_tunnels=None)¶

Bases: vmware.vapi.bindings.struct.VapiStruct

L2VPN Session Data represents meta data necessary to create the L2VPN Session. It is represented by an array of peer code for each tunnel.

Tip

The arguments are used to initialize data attributes with the same names.

Parameters

description (str or None) – Description of L2VPN Session
display_name (str or None) – Defaults to id if not set.
enabled (bool or None) – Enable to extend all the associated segments.
transport_tunnels (list of L2VPNSessionTransportTunnelData or None) – List of L2VPN transport tunnel data.

class com.vmware.nsx_policy.model_client.L2VPNSessionListResult(links=None, schema=None, self_=None, cursor=None, result_count=None, sort_ascending=None, sort_by=None, results=None)¶

Bases: vmware.vapi.bindings.struct.VapiStruct

Paged Collection of L2VPNSession

Tip

The arguments are used to initialize data attributes with the same names.

Parameters

links (list of ResourceLink or None) – The server will populate this field when returing the resource. Ignored on PUT and POST. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
schema (str or None) – Schema for this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
self (SelfResourceLink or None) – Link to this resource
cursor (str or None) – Opaque cursor to be used for getting next page of records (supplied by current result page) This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
result_count (long or None) – Count of results found (across all pages), set only on first page format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
sort_ascending (bool or None) – If true, results are sorted in ascending order This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
sort_by (str or None) – Field by which records are sorted This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
results (list of L2VPNSession) – L2VPNSession list results

class com.vmware.nsx_policy.model_client.L2VPNSessionPeerConfigNsxt(peer_codes=None, alarm=None, enforcement_point_path=None, resource_type='L2VPNSessionPeerConfigNsxT')¶

Bases: vmware.vapi.bindings.struct.VapiStruct

L2VPNSessionPeerCodes represents an array of peer code for each tunnel. The peer code is necessary to configure the remote end of the tunnel. Currently only stand-along/unmanaged edge is supported on the remote end of the tunnel.

Tip

The arguments are used to initialize data attributes with the same names.

Parameters

peer_codes (list of L2VPNSessionTransportTunnelPeerCode or None) – List of peer codes per transport tunnel. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
alarm (PolicyRuntimeAlarm or None) – Alarm information details.
enforcement_point_path (str or None) – Policy Path referencing the enforcement point where the info is fetched. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
resource_type (str) –
Possible values are:
- L2VPNSessionPeerConfigPerEP.RESOURCE_TYPE_L2VPNSESSIONPEERCONFIGNSXT

property resource_type¶: Return the discriminator value

class com.vmware.nsx_policy.model_client.L2VPNSessionPeerConfigPerEP(alarm=None, enforcement_point_path=None, resource_type='L2VPNSessionPeerConfigPerEP')¶

Bases: vmware.vapi.bindings.struct.VapiStruct

Peer config per Enforcement Point to configure the other side of the tunnel.

Tip

The arguments are used to initialize data attributes with the same names.

Parameters

alarm (PolicyRuntimeAlarm or None) – Alarm information details.
enforcement_point_path (str or None) – Policy Path referencing the enforcement point where the info is fetched. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
resource_type (str) –
Possible values are:
- L2VPNSessionPeerConfigPerEP.RESOURCE_TYPE_L2VPNSESSIONPEERCONFIGNSXT

RESOURCE_TYPE_L2VPNSESSIONPEERCONFIGNSXT = 'L2VPNSessionPeerConfigNsxT'¶

property resource_type¶: Return the discriminator value

class com.vmware.nsx_policy.model_client.L2VPNSessionStatisticsNsxt(tap_traffic_counters=None, traffic_statistics_per_segment=None, alarm=None, enforcement_point_path=None, resource_type='L2VPNSessionStatisticsNsxT')¶

Bases: vmware.vapi.bindings.struct.VapiStruct

L2VPN session statistics gives session status and traffic statistics per segment.

Tip

The arguments are used to initialize data attributes with the same names.

Parameters

tap_traffic_counters (list of L2VPNTapStatistics or None) – Tunnel port traffic counters. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
traffic_statistics_per_segment (list of L2VPNTrafficStatisticsPerSegment or None) – Traffic statistics per segment. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
alarm (PolicyRuntimeAlarm or None) – Alarm information details.
enforcement_point_path (str or None) – Policy Path referencing the enforcement point where the info is fetched. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
resource_type (str) –
Possible values are:
- L2VPNSessionStatisticsPerEP.RESOURCE_TYPE_L2VPNSESSIONSTATISTICSNSXT

property resource_type¶: Return the discriminator value

class com.vmware.nsx_policy.model_client.L2VPNSessionStatisticsPerEP(alarm=None, enforcement_point_path=None, resource_type='L2VPNSessionStatisticsPerEP')¶

Bases: vmware.vapi.bindings.struct.VapiStruct

L2VPN Session Statistics Per Enforcement Point.

Tip

The arguments are used to initialize data attributes with the same names.

Parameters

alarm (PolicyRuntimeAlarm or None) – Alarm information details.
enforcement_point_path (str or None) – Policy Path referencing the enforcement point where the info is fetched. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
resource_type (str) –
Possible values are:
- L2VPNSessionStatisticsPerEP.RESOURCE_TYPE_L2VPNSESSIONSTATISTICSNSXT

RESOURCE_TYPE_L2VPNSESSIONSTATISTICSNSXT = 'L2VPNSessionStatisticsNsxT'¶

property resource_type¶: Return the discriminator value

class com.vmware.nsx_policy.model_client.L2VPNSessionStatusNsxt(runtime_status=None, transport_tunnels=None, alarm=None, enforcement_point_path=None, resource_type='L2VPNSessionStatusNsxT')¶

Bases: vmware.vapi.bindings.struct.VapiStruct

L2VPN Session Status represents status on an NSX-T type of enforcement point.

Tip

The arguments are used to initialize data attributes with the same names.

Parameters

runtime_status (str or None) –
Possible values are:
- L2VPNSessionStatusNsxt.RUNTIME_STATUS_UP
- L2VPNSessionStatusNsxt.RUNTIME_STATUS_DOWN
L2 VPN session status, specifies UP/DOWN.

This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
transport_tunnels (list of vmware.vapi.struct.VapiStruct or None) – Transport tunnels status. When clients pass a value of this class as a parameter, the attribute must contain all the attributes defined in L2VPNSessionTransportTunnelStatus. When methods return a value of this class as a return value, the attribute will contain all the attributes defined in L2VPNSessionTransportTunnelStatus. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
alarm (PolicyRuntimeAlarm or None) – Alarm information details.
enforcement_point_path (str or None) – Policy Path referencing the enforcement point where the info is fetched. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
resource_type (str) –
Possible values are:
- L2VPNSessionStatusPerEP.RESOURCE_TYPE_L2VPNSESSIONSTATUSNSXT

RUNTIME_STATUS_DOWN = 'DOWN'¶

RUNTIME_STATUS_UP = 'UP'¶

property resource_type¶: Return the discriminator value

class com.vmware.nsx_policy.model_client.L2VPNSessionStatusPerEP(alarm=None, enforcement_point_path=None, resource_type='L2VPNSessionStatusPerEP')¶

Bases: vmware.vapi.bindings.struct.VapiStruct

L2VPN Session Status Per Enforcement Point.

Tip

The arguments are used to initialize data attributes with the same names.

Parameters

alarm (PolicyRuntimeAlarm or None) – Alarm information details.
enforcement_point_path (str or None) – Policy Path referencing the enforcement point where the info is fetched. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
resource_type (str) –
Possible values are:
- L2VPNSessionStatusPerEP.RESOURCE_TYPE_L2VPNSESSIONSTATUSNSXT

RESOURCE_TYPE_L2VPNSESSIONSTATUSNSXT = 'L2VPNSessionStatusNsxT'¶

property resource_type¶: Return the discriminator value

class com.vmware.nsx_policy.model_client.L2VPNSessionTransportTunnelData(local_address=None, peer_address=None, peer_code=None)¶

Bases: vmware.vapi.bindings.struct.VapiStruct

L2VPN Session Transport Tunnel Data uses a peer code which has all the information to create the transport tunnel.

Tip

The arguments are used to initialize data attributes with the same names.

Parameters

local_address (str) – IPv4 Address of local endpoint. format: ipv4
peer_address (str) – IPv4 Address of Peer endpoint on remote site. format: ipv4
peer_code (str or None) – Peer code represents a base64 encoded string which has all the configuration for tunnel. E.g local/peer ips and protocol, encryption algorithm, etc. Peer code also contains PSK; be careful when sharing or storing it.

class com.vmware.nsx_policy.model_client.L2VPNSessionTransportTunnelPeerCode(peer_code=None, transport_tunnel_path=None)¶

Bases: vmware.vapi.bindings.struct.VapiStruct

L2VPN transport tunnel peer code.

Tip

The arguments are used to initialize data attributes with the same names.

Parameters

peer_code (str or None) – Peer code represents a base64 encoded string which has all the configuration for tunnel. E.g local/peer ips and protocol, encryption algorithm, etc. Peer code also contains PSK; be careful when sharing or storing it. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
transport_tunnel_path (str or None) – Policy Path referencing the transport tunnel. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.

class com.vmware.nsx_policy.model_client.L2VPNSessionTransportTunnelStatus(resource_type='L2VPNSessionTransportTunnelStatus', transport_tunnel_path=None)¶

Bases: vmware.vapi.bindings.struct.VapiStruct

Transport tunnel status.

Tip

The arguments are used to initialize data attributes with the same names.

Parameters

resource_type (str) –
Possible values are:
- L2VPNSessionTransportTunnelStatus.RESOURCE_TYPE_IPSECVPNTRANSPORTSTATUS
transport_tunnel_path (str or None) – Policy path referencing Transport Tunnel. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.

RESOURCE_TYPE_IPSECVPNTRANSPORTSTATUS = 'IPSecVpnTransportStatus'¶

property resource_type¶: Return the discriminator value

class com.vmware.nsx_policy.model_client.L2VPNTapStatistics(bytes_in=None, bytes_out=None, packets_in=None, packets_out=None, packets_receive_error=None, packets_sent_error=None)¶

Bases: vmware.vapi.bindings.struct.VapiStruct

TAP (Terminal access point) traffic statistics for L2VPN.

Tip

The arguments are used to initialize data attributes with the same names.

Parameters

bytes_in (long or None) – Total number of incoming bytes. format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
bytes_out (long or None) – Total number of outgoing bytes. format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
packets_in (long or None) – Total number of incoming packets. format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
packets_out (long or None) – Total number of outgoing packets. format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
packets_receive_error (long or None) – Total number of incoming packets dropped. format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
packets_sent_error (long or None) – Total number of packets dropped while sending for any reason. format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.

class com.vmware.nsx_policy.model_client.L2VPNTrafficStatisticsPerSegment(bum_bytes_in=None, bum_bytes_out=None, bum_packets_in=None, bum_packets_out=None, bytes_in=None, bytes_out=None, packets_in=None, packets_out=None, packets_receive_error=None, packets_sent_error=None, segment_path=None)¶

Bases: vmware.vapi.bindings.struct.VapiStruct

Traffic statistics for a segment.

Tip

The arguments are used to initialize data attributes with the same names.

Parameters

bum_bytes_in (long or None) – Total number of incoming Broadcast, Unknown unicast and Multicast (BUM) bytes. format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
bum_bytes_out (long or None) – Total number of outgoing Broadcast, Unknown unicast and Multicast (BUM) bytes. format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
bum_packets_in (long or None) – Total number of incoming Broadcast, Unknown unicast and Multicast (BUM) packets. format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
bum_packets_out (long or None) – Total number of outgoing Broadcast, Unknown unicast and Multicast (BUM) packets. format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
bytes_in (long or None) – Total number of incoming bytes. format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
bytes_out (long or None) – Total number of outgoing bytes. format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
packets_in (long or None) – Total number of incoming packets. format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
packets_out (long or None) – Total number of outgoing packets. format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
packets_receive_error (long or None) – Total number of incoming packets dropped. format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
packets_sent_error (long or None) – Total number of packets dropped while sending for any reason. format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
segment_path (str or None) – Policy path referencing the segment on which stats are gathered. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.

class com.vmware.nsx_policy.model_client.L2VPNTunnelEncapsulation(local_endpoint_address=None, peer_endpoint_address=None, protocol=None)¶

Bases: vmware.vapi.bindings.struct.VapiStruct

L2VPN tunnel encapsulation config.

Tip

The arguments are used to initialize data attributes with the same names.

Parameters

local_endpoint_address (str or None) – IP Address of the local tunnel port. This property only applies in CLIENT mode. format: ipv4 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
peer_endpoint_address (str or None) – IP Address of the peer tunnel port. This property only applies in CLIENT mode. format: ipv4 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
protocol (str or None) –
Possible values are:
- L2VPNTunnelEncapsulation.PROTOCOL_GRE
Encapsulation protocol used by the tunnel.

This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.

PROTOCOL_GRE = 'GRE'¶

class com.vmware.nsx_policy.model_client.L2Vpn(links=None, schema=None, self_=None, revision=None, create_time=None, create_user=None, last_modified_time=None, last_modified_user=None, protection=None, system_owned=None, description=None, display_name=None, id=None, resource_type=None, tags=None, parent_path=None, path=None, relative_path=None, children=None, marked_for_delete=None, enabled=None, transport_tunnels=None)¶

Bases: vmware.vapi.bindings.struct.VapiStruct

Contains information necessary to configure L2Vpn.

Tip

The arguments are used to initialize data attributes with the same names.

Parameters

links (list of ResourceLink or None) – The server will populate this field when returing the resource. Ignored on PUT and POST. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
schema (str or None) – Schema for this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
self (SelfResourceLink or None) – Link to this resource
revision (long or None) – The _revision property describes the current revision of the resource. To prevent clients from overwriting each other’s changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected. format: int32
create_time (long or None) – Timestamp of resource creation format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
create_user (str or None) – ID of the user who created this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
last_modified_time (long or None) – Timestamp of last modification format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
last_modified_user (str or None) – ID of the user who last modified this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
protection (str or None) – Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super user and can modify it, but only when providing the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this entity. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
system_owned (bool or None) – Indicates system owned resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
description (str or None) – Description of this resource
display_name (str or None) – Defaults to ID if not set
id (str or None) – Unique identifier of this resource
resource_type (str or None) – The type of this resource.
tags (list of Tag or None) – Opaque identifiers meaningful to the API user
parent_path (str or None) – Path of its parent This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
path (str or None) – Absolute path of this object This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
relative_path (str or None) – Path relative from its parent This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
children (list of vmware.vapi.struct.VapiStruct or None) – subtree for this type within policy tree containing nested elements. When clients pass a value of this class as a parameter, the attribute must contain all the attributes defined in ChildPolicyConfigResource. When methods return a value of this class as a return value, the attribute will contain all the attributes defined in ChildPolicyConfigResource.
marked_for_delete (bool or None) – Intent objects are not directly deleted from the system when a delete is invoked on them. They are marked for deletion and only when all the realized entities for that intent object gets deleted, the intent object is deleted. Objects that are marked for deletion are not returned in GET call. One can use the search API to get these objects. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
enabled (bool or None) – Enable to extend all the associated segments.
transport_tunnels (list of str) – List of paths referencing transport tunnels.

class com.vmware.nsx_policy.model_client.L2VpnContext(links=None, schema=None, self_=None, revision=None, create_time=None, create_user=None, last_modified_time=None, last_modified_user=None, protection=None, system_owned=None, description=None, display_name=None, id=None, resource_type=None, tags=None, parent_path=None, path=None, relative_path=None, children=None, marked_for_delete=None, enable_hub=None)¶

Bases: vmware.vapi.bindings.struct.VapiStruct

L2Vpn Context provides meta-data information about the parent Tier-0.

Tip

The arguments are used to initialize data attributes with the same names.

Parameters

links (list of ResourceLink or None) – The server will populate this field when returing the resource. Ignored on PUT and POST. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
schema (str or None) – Schema for this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
self (SelfResourceLink or None) – Link to this resource
revision (long or None) – The _revision property describes the current revision of the resource. To prevent clients from overwriting each other’s changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected. format: int32
create_time (long or None) – Timestamp of resource creation format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
create_user (str or None) – ID of the user who created this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
last_modified_time (long or None) – Timestamp of last modification format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
last_modified_user (str or None) – ID of the user who last modified this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
protection (str or None) – Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super user and can modify it, but only when providing the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this entity. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
system_owned (bool or None) – Indicates system owned resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
description (str or None) – Description of this resource
display_name (str or None) – Defaults to ID if not set
id (str or None) – Unique identifier of this resource
resource_type (str or None) – The type of this resource.
tags (list of Tag or None) – Opaque identifiers meaningful to the API user
parent_path (str or None) – Path of its parent This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
path (str or None) – Absolute path of this object This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
relative_path (str or None) – Path relative from its parent This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
children (list of vmware.vapi.struct.VapiStruct or None) – subtree for this type within policy tree containing nested elements. When clients pass a value of this class as a parameter, the attribute must contain all the attributes defined in ChildPolicyConfigResource. When methods return a value of this class as a return value, the attribute will contain all the attributes defined in ChildPolicyConfigResource.
marked_for_delete (bool or None) – Intent objects are not directly deleted from the system when a delete is invoked on them. They are marked for deletion and only when all the realized entities for that intent object gets deleted, the intent object is deleted. Objects that are marked for deletion are not returned in GET call. One can use the search API to get these objects. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
enable_hub (bool or None) – If enabled, the tier-0 acts as a Hub and replicates traffic received from peer to all other peers. If disabled, the tier-0 acts as a Spoke and replicates only the local.

class com.vmware.nsx_policy.model_client.L2VpnListResult(links=None, schema=None, self_=None, cursor=None, result_count=None, sort_ascending=None, sort_by=None, results=None)¶

Bases: vmware.vapi.bindings.struct.VapiStruct

Paged Collection of L2Vpns

Tip

The arguments are used to initialize data attributes with the same names.

Parameters

links (list of ResourceLink or None) – The server will populate this field when returing the resource. Ignored on PUT and POST. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
schema (str or None) – Schema for this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
self (SelfResourceLink or None) – Link to this resource
cursor (str or None) – Opaque cursor to be used for getting next page of records (supplied by current result page) This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
result_count (long or None) – Count of results found (across all pages), set only on first page format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
sort_ascending (bool or None) – If true, results are sorted in ascending order This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
sort_by (str or None) – Field by which records are sorted This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
results (list of L2Vpn) – L2Vpn list results

class com.vmware.nsx_policy.model_client.L2VpnPeerCodes(peer_codes=None, enforcement_point_path=None, resource_type='L2VpnPeerCodes')¶

Bases: vmware.vapi.bindings.struct.VapiStruct

Get the peer_code for each tunnel to paste on the remote end of the tunnel. Currently only stand-along/unmanaged edge is supported on the remote end of the tunnel.

Tip

The arguments are used to initialize data attributes with the same names.

Parameters

peer_codes (list of L2VpnTransportTunnelPeerCode) – List of peer codes per transport tunnel.
enforcement_point_path (str or None) – Policy Path referencing the enforcement point to which the config belongs. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
resource_type (str) –
Possible values are:
- L2VpnPeerConfigPerEnforcementPoint.RESOURCE_TYPE_L2VPNPEERCODES

property resource_type¶: Return the discriminator value

class com.vmware.nsx_policy.model_client.L2VpnPeerConfigPerEnforcementPoint(enforcement_point_path=None, resource_type='L2VpnPeerConfigPerEnforcementPoint')¶

Bases: vmware.vapi.bindings.struct.VapiStruct

Peer config per Enforcement Point to configure the other side of the tunnel.

Tip

The arguments are used to initialize data attributes with the same names.

Parameters

enforcement_point_path (str or None) – Policy Path referencing the enforcement point to which the config belongs. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
resource_type (str) –
Possible values are:
- L2VpnPeerConfigPerEnforcementPoint.RESOURCE_TYPE_L2VPNPEERCODES

RESOURCE_TYPE_L2VPNPEERCODES = 'L2VpnPeerCodes'¶

property resource_type¶: Return the discriminator value

class com.vmware.nsx_policy.model_client.L2VpnPerSegmentTrafficStatistics(bum_bytes_in=None, bum_bytes_out=None, bum_packets_in=None, bum_packets_out=None, bytes_in=None, bytes_out=None, packets_in=None, packets_out=None, packets_receive_error=None, packets_sent_error=None, segment_path=None)¶

Bases: vmware.vapi.bindings.struct.VapiStruct

Traffic statistics for a segment.

Tip

The arguments are used to initialize data attributes with the same names.

Parameters

bum_bytes_in (long or None) – Total number of incoming Broadcast, Unknown unicast and Multicast (BUM) bytes. format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
bum_bytes_out (long or None) – Total number of outgoing Broadcast, Unknown unicast and Multicast (BUM) bytes. format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
bum_packets_in (long or None) – Total number of incoming Broadcast, Unknown unicast and Multicast (BUM) packets. format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
bum_packets_out (long or None) – Total number of outgoing Broadcast, Unknown unicast and Multicast (BUM) packets. format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
bytes_in (long or None) – Total number of incoming bytes. format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
bytes_out (long or None) – Total number of outgoing bytes. format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
packets_in (long or None) – Total number of incoming packets. format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
packets_out (long or None) – Total number of outgoing packets. format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
packets_receive_error (long or None) – Total number of incoming packets dropped. format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
packets_sent_error (long or None) – Total number of packets dropped while sending for any reason. format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
segment_path (str or None) – Policy path referencing the segment on which stats are gathered. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.

class com.vmware.nsx_policy.model_client.L2VpnSessionStatistics(tap_traffic_counters=None, traffic_statistics_per_segment=None, enforcement_point_path=None, resource_type='L2VpnSessionStatistics')¶

Bases: vmware.vapi.bindings.struct.VapiStruct

Session statistics gives VPN session status and traffic statistics per segment.

Tip

The arguments are used to initialize data attributes with the same names.

Parameters

tap_traffic_counters (list of L2VpnTapTrafficStatistics or None) – Tunnel port traffic counters. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
traffic_statistics_per_segment (list of L2VpnPerSegmentTrafficStatistics or None) – Traffic statistics per segment. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
enforcement_point_path (str or None) – Policy Path referencing the enforcement point wehere the statistics are fetched. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
resource_type (str) –
Possible values are:
- L2VpnStatisticsPerEnforcementPoint.RESOURCE_TYPE_L2VPNSESSIONSTATISTICS

property resource_type¶: Return the discriminator value

class com.vmware.nsx_policy.model_client.L2VpnStatisticsPerEnforcementPoint(enforcement_point_path=None, resource_type='L2VpnStatisticsPerEnforcementPoint')¶

Bases: vmware.vapi.bindings.struct.VapiStruct

L2Vpn Statistics Per Enforcement Point.

Tip

The arguments are used to initialize data attributes with the same names.

Parameters

enforcement_point_path (str or None) – Policy Path referencing the enforcement point wehere the statistics are fetched. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
resource_type (str) –
Possible values are:
- L2VpnStatisticsPerEnforcementPoint.RESOURCE_TYPE_L2VPNSESSIONSTATISTICS

RESOURCE_TYPE_L2VPNSESSIONSTATISTICS = 'L2VpnSessionStatistics'¶

property resource_type¶: Return the discriminator value

class com.vmware.nsx_policy.model_client.L2VpnTapTrafficStatistics(bytes_in=None, bytes_out=None, packets_in=None, packets_out=None, packets_receive_error=None, packets_sent_error=None)¶

Bases: vmware.vapi.bindings.struct.VapiStruct

TAP (Terminal access point) traffic statistics for L2Vpn.

Tip

The arguments are used to initialize data attributes with the same names.

Parameters

bytes_in (long or None) – Total number of incoming bytes. format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
bytes_out (long or None) – Total number of outgoing bytes. format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
packets_in (long or None) – Total number of incoming packets. format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
packets_out (long or None) – Total number of outgoing packets. format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
packets_receive_error (long or None) – Total number of incoming packets dropped. format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
packets_sent_error (long or None) – Total number of packets dropped while sending for any reason. format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.

class com.vmware.nsx_policy.model_client.L2VpnTransportTunnelPeerCode(peer_code=None, transport_tunnel_path=None)¶

Bases: vmware.vapi.bindings.struct.VapiStruct

L2Vpn transport tunnel peer code.

Tip

The arguments are used to initialize data attributes with the same names.

Parameters

peer_code (str) – Copy this code to paste on the remote end of the tunnel. This is a base64 encoded string which has all the configuration for tunnel. E.g local/remote ips and protocol, encryption algorithm, etc. Peer code also contains PSK; be careful when sharing or storing it.
transport_tunnel_path (str) – Policy path referencing the transport tunnel.

class com.vmware.nsx_policy.model_client.L3Vpn(links=None, schema=None, self_=None, revision=None, create_time=None, create_user=None, last_modified_time=None, last_modified_user=None, protection=None, system_owned=None, description=None, display_name=None, id=None, resource_type=None, tags=None, parent_path=None, path=None, relative_path=None, children=None, marked_for_delete=None, dh_groups=None, enable_perfect_forward_secrecy=None, enabled=None, ike_digest_algorithms=None, ike_encryption_algorithms=None, ike_version=None, l3vpn_session=None, local_address=None, passphrases=None, remote_private_address=None, remote_public_address=None, tunnel_digest_algorithms=None, tunnel_encryption_algorithms=None)¶

Bases: vmware.vapi.bindings.struct.VapiStruct

Contains information necessary to configure IPSec VPN.

Tip

The arguments are used to initialize data attributes with the same names.

Parameters

links (list of ResourceLink or None) – The server will populate this field when returing the resource. Ignored on PUT and POST. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
schema (str or None) – Schema for this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
self (SelfResourceLink or None) – Link to this resource
revision (long or None) – The _revision property describes the current revision of the resource. To prevent clients from overwriting each other’s changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected. format: int32
create_time (long or None) – Timestamp of resource creation format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
create_user (str or None) – ID of the user who created this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
last_modified_time (long or None) – Timestamp of last modification format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
last_modified_user (str or None) – ID of the user who last modified this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
protection (str or None) – Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super user and can modify it, but only when providing the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this entity. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
system_owned (bool or None) – Indicates system owned resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
description (str or None) – Description of this resource
display_name (str or None) – Defaults to ID if not set
id (str or None) – Unique identifier of this resource
resource_type (str or None) – The type of this resource.
tags (list of Tag or None) – Opaque identifiers meaningful to the API user
parent_path (str or None) – Path of its parent This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
path (str or None) – Absolute path of this object This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
relative_path (str or None) – Path relative from its parent This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
children (list of vmware.vapi.struct.VapiStruct or None) – subtree for this type within policy tree containing nested elements. When clients pass a value of this class as a parameter, the attribute must contain all the attributes defined in ChildPolicyConfigResource. When methods return a value of this class as a return value, the attribute will contain all the attributes defined in ChildPolicyConfigResource.
marked_for_delete (bool or None) – Intent objects are not directly deleted from the system when a delete is invoked on them. They are marked for deletion and only when all the realized entities for that intent object gets deleted, the intent object is deleted. Objects that are marked for deletion are not returned in GET call. One can use the search API to get these objects. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
dh_groups (list of str or None) –
Possible values are:
- L3Vpn.DH_GROUPS_GROUP2
- L3Vpn.DH_GROUPS_GROUP5
- L3Vpn.DH_GROUPS_GROUP14
- L3Vpn.DH_GROUPS_GROUP15
- L3Vpn.DH_GROUPS_GROUP16
Diffie-Hellman group to be used if PFS is enabled. Default group is GROUP14.
enable_perfect_forward_secrecy (bool or None) – If true, perfect forward secrecy (PFS) is enabled.
enabled (bool or None) – Flag to enable L3Vpn. Default is enabled.
ike_digest_algorithms (list of str or None) –
Possible values are:
- L3Vpn.IKE_DIGEST_ALGORITHMS_SHA1
- L3Vpn.IKE_DIGEST_ALGORITHMS_SHA2_256
Algorithm to be used for message digest during Internet Key Exchange(IKE) negotiation. Default is SHA2_256.
ike_encryption_algorithms (list of str or None) –
Possible values are:
- L3Vpn.IKE_ENCRYPTION_ALGORITHMS__128
- L3Vpn.IKE_ENCRYPTION_ALGORITHMS__256
- L3Vpn.IKE_ENCRYPTION_ALGORITHMS_GCM_128
- L3Vpn.IKE_ENCRYPTION_ALGORITHMS_GCM_192
- L3Vpn.IKE_ENCRYPTION_ALGORITHMS_GCM_256
Algorithm to be used during Internet Key Exchange(IKE) negotiation. Default is AES_128.
ike_version (str or None) –
Possible values are:
- L3Vpn.IKE_VERSION_V1
- L3Vpn.IKE_VERSION_V2
- L3Vpn.IKE_VERSION_FLEX
IKE protocol version to be used. IKE-Flex will initiate IKE-V2 and responds to both IKE-V1 and IKE-V2.
l3vpn_session (vmware.vapi.struct.VapiStruct) – L3Vpn Session When clients pass a value of this class as a parameter, the attribute must contain all the attributes defined in L3VpnSession. When methods return a value of this class as a return value, the attribute will contain all the attributes defined in L3VpnSession.
local_address (str) – IPv4 address of local gateway format: ipv4
passphrases (list of str or None) – List of IPSec pre-shared keys used for IPSec authentication. If not specified, the older passphrase values are retained if there are any.
remote_private_address (str or None) – This field is used to resolve conflicts in case of a remote site being behind NAT as remote public ip address is not enough. If it is not the case the remote public address should be provided here. If not provided, the value of this field is set to remote_public_address.
remote_public_address (str) – Public IPv4 address of remote gateway format: ipv4
tunnel_digest_algorithms (list of str or None) –
Possible values are:
- L3Vpn.TUNNEL_DIGEST_ALGORITHMS_SHA1
- L3Vpn.TUNNEL_DIGEST_ALGORITHMS_SHA2_256
Algorithm to be used for message digest during tunnel establishment. Default algorithm is empty.
tunnel_encryption_algorithms (list of str or None) –
Possible values are:
- L3Vpn.TUNNEL_ENCRYPTION_ALGORITHMS__128
- L3Vpn.TUNNEL_ENCRYPTION_ALGORITHMS__256
- L3Vpn.TUNNEL_ENCRYPTION_ALGORITHMS_GCM_128
- L3Vpn.TUNNEL_ENCRYPTION_ALGORITHMS_GCM_192
- L3Vpn.TUNNEL_ENCRYPTION_ALGORITHMS_GCM_256
Encryption algorithm to encrypt/decrypt the messages exchanged between IPSec VPN initiator and responder during tunnel negotiation. Default is AES_GCM_128.

DH_GROUPS_GROUP14 = 'GROUP14'¶

DH_GROUPS_GROUP15 = 'GROUP15'¶

DH_GROUPS_GROUP16 = 'GROUP16'¶

DH_GROUPS_GROUP2 = 'GROUP2'¶

DH_GROUPS_GROUP5 = 'GROUP5'¶

IKE_DIGEST_ALGORITHMS_SHA1 = 'SHA1'¶

IKE_DIGEST_ALGORITHMS_SHA2_256 = 'SHA2_256'¶

IKE_ENCRYPTION_ALGORITHMS_128 = 'AES_128'¶

IKE_ENCRYPTION_ALGORITHMS_256 = 'AES_256'¶

IKE_ENCRYPTION_ALGORITHMS_GCM_128 = 'AES_GCM_128'¶

IKE_ENCRYPTION_ALGORITHMS_GCM_192 = 'AES_GCM_192'¶

IKE_ENCRYPTION_ALGORITHMS_GCM_256 = 'AES_GCM_256'¶

IKE_VERSION_FLEX = 'IKE_FLEX'¶

IKE_VERSION_V1 = 'IKE_V1'¶

IKE_VERSION_V2 = 'IKE_V2'¶

TUNNEL_DIGEST_ALGORITHMS_SHA1 = 'SHA1'¶

TUNNEL_DIGEST_ALGORITHMS_SHA2_256 = 'SHA2_256'¶

TUNNEL_ENCRYPTION_ALGORITHMS_128 = 'AES_128'¶

TUNNEL_ENCRYPTION_ALGORITHMS_256 = 'AES_256'¶

TUNNEL_ENCRYPTION_ALGORITHMS_GCM_128 = 'AES_GCM_128'¶

TUNNEL_ENCRYPTION_ALGORITHMS_GCM_192 = 'AES_GCM_192'¶

TUNNEL_ENCRYPTION_ALGORITHMS_GCM_256 = 'AES_GCM_256'¶

class com.vmware.nsx_policy.model_client.L3VpnContext(links=None, schema=None, self_=None, revision=None, create_time=None, create_user=None, last_modified_time=None, last_modified_user=None, protection=None, system_owned=None, description=None, display_name=None, id=None, resource_type=None, tags=None, parent_path=None, path=None, relative_path=None, children=None, marked_for_delete=None, available_local_addresses=None, bypass_rules=None, enabled=None, ike_log_level=None, label=None)¶

Bases: vmware.vapi.bindings.struct.VapiStruct

L3Vpn Context provides the configuration context that different L3Vpns can consume.

Tip

The arguments are used to initialize data attributes with the same names.

Parameters

links (list of ResourceLink or None) – The server will populate this field when returing the resource. Ignored on PUT and POST. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
schema (str or None) – Schema for this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
self (SelfResourceLink or None) – Link to this resource
revision (long or None) – The _revision property describes the current revision of the resource. To prevent clients from overwriting each other’s changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected. format: int32
create_time (long or None) – Timestamp of resource creation format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
create_user (str or None) – ID of the user who created this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
last_modified_time (long or None) – Timestamp of last modification format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
last_modified_user (str or None) – ID of the user who last modified this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
protection (str or None) – Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super user and can modify it, but only when providing the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this entity. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
system_owned (bool or None) – Indicates system owned resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
description (str or None) – Description of this resource
display_name (str or None) – Defaults to ID if not set
id (str or None) – Unique identifier of this resource
resource_type (str or None) – The type of this resource.
tags (list of Tag or None) – Opaque identifiers meaningful to the API user
parent_path (str or None) – Path of its parent This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
path (str or None) – Absolute path of this object This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
relative_path (str or None) – Path relative from its parent This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
children (list of vmware.vapi.struct.VapiStruct or None) – subtree for this type within policy tree containing nested elements. When clients pass a value of this class as a parameter, the attribute must contain all the attributes defined in ChildPolicyConfigResource. When methods return a value of this class as a return value, the attribute will contain all the attributes defined in ChildPolicyConfigResource.
marked_for_delete (bool or None) – Intent objects are not directly deleted from the system when a delete is invoked on them. They are marked for deletion and only when all the realized entities for that intent object gets deleted, the intent object is deleted. Objects that are marked for deletion are not returned in GET call. One can use the search API to get these objects. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
available_local_addresses (list of PolicyIPAddressInfo or None) – Local gateway IPv4 addresses available for configuration of each L3Vpn.
bypass_rules (list of L3VpnRule or None) – Bypass L3Vpn rules that will be shared across L3Vpns. Only Bypass action is supported on these L3Vpn rules.
enabled (bool or None) – If true, enable L3Vpn Service for given tier-0. Enabling/disabling this service affects all L3Vpns under the given tier-0.
ike_log_level (str or None) –
Possible values are:
- L3VpnContext.IKE_LOG_LEVEL_DEBUG
- L3VpnContext.IKE_LOG_LEVEL_INFO
- L3VpnContext.IKE_LOG_LEVEL_WARN
- L3VpnContext.IKE_LOG_LEVEL_ERROR
- L3VpnContext.IKE_LOG_LEVEL_EMERGENCY
Log level for internet key exchange (IKE).
label (str or None) – Policy path referencing Label. A label is used as a mechanism to group route-based L3Vpns in order to apply edge firewall rules on members’ VTIs.

IKE_LOG_LEVEL_DEBUG = 'DEBUG'¶

IKE_LOG_LEVEL_EMERGENCY = 'EMERGENCY'¶

IKE_LOG_LEVEL_ERROR = 'ERROR'¶

IKE_LOG_LEVEL_INFO = 'INFO'¶

IKE_LOG_LEVEL_WARN = 'WARN'¶

class com.vmware.nsx_policy.model_client.L3VpnListResult(links=None, schema=None, self_=None, cursor=None, result_count=None, sort_ascending=None, sort_by=None, results=None)¶

Bases: vmware.vapi.bindings.struct.VapiStruct

Paged Collection of L3Vpns

Tip

The arguments are used to initialize data attributes with the same names.

Parameters

links (list of ResourceLink or None) – The server will populate this field when returing the resource. Ignored on PUT and POST. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
schema (str or None) – Schema for this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
self (SelfResourceLink or None) – Link to this resource
cursor (str or None) – Opaque cursor to be used for getting next page of records (supplied by current result page) This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
result_count (long or None) – Count of results found (across all pages), set only on first page format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
sort_ascending (bool or None) – If true, results are sorted in ascending order This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
sort_by (str or None) – Field by which records are sorted This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
results (list of L3Vpn) – L3Vpn list results

class com.vmware.nsx_policy.model_client.L3VpnPeerConfigRequestParameters(enforcement_point_path=None)¶

Bases: vmware.vapi.bindings.struct.VapiStruct

Peer Config Request parameters that represents an enforcement point path. A request to get the Peer config for an L3Vpn can be parameterized with this path and will be evaluted as follows: - no enforcement point path specified: the request is evaluated on all enforcement points. - {enforcement_point_path}: the request is evaluated only on the given enforcement point.

Tip

The arguments are used to initialize data attributes with the same names.

Parameters: enforcement_point_path (str or None) – enforcement point path, forward slashes must be escaped using %2F.

class com.vmware.nsx_policy.model_client.L3VpnRule(links=None, schema=None, self_=None, revision=None, create_time=None, create_user=None, last_modified_time=None, last_modified_user=None, protection=None, system_owned=None, description=None, display_name=None, id=None, resource_type=None, tags=None, parent_path=None, path=None, relative_path=None, children=None, marked_for_delete=None, action=None, destinations=None, sequence_number=None, sources=None)¶

Bases: vmware.vapi.bindings.struct.VapiStruct

For policy-based L3Vpn sessions, a rule specifies as its action the vpn tunnel to be used for transit traffic that meets the rule’s match criteria.

Tip

The arguments are used to initialize data attributes with the same names.

Parameters

links (list of ResourceLink or None) – The server will populate this field when returing the resource. Ignored on PUT and POST. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
schema (str or None) – Schema for this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
self (SelfResourceLink or None) – Link to this resource
revision (long or None) – The _revision property describes the current revision of the resource. To prevent clients from overwriting each other’s changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected. format: int32
create_time (long or None) – Timestamp of resource creation format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
create_user (str or None) – ID of the user who created this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
last_modified_time (long or None) – Timestamp of last modification format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
last_modified_user (str or None) – ID of the user who last modified this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
protection (str or None) – Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super user and can modify it, but only when providing the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this entity. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
system_owned (bool or None) – Indicates system owned resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
description (str or None) – Description of this resource
display_name (str or None) – Defaults to ID if not set
id (str or None) – Unique identifier of this resource
resource_type (str or None) – The type of this resource.
tags (list of Tag or None) – Opaque identifiers meaningful to the API user
parent_path (str or None) – Path of its parent This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
path (str or None) – Absolute path of this object This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
relative_path (str or None) – Path relative from its parent This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
children (list of vmware.vapi.struct.VapiStruct or None) – subtree for this type within policy tree containing nested elements. When clients pass a value of this class as a parameter, the attribute must contain all the attributes defined in ChildPolicyConfigResource. When methods return a value of this class as a return value, the attribute will contain all the attributes defined in ChildPolicyConfigResource.
marked_for_delete (bool or None) – Intent objects are not directly deleted from the system when a delete is invoked on them. They are marked for deletion and only when all the realized entities for that intent object gets deleted, the intent object is deleted. Objects that are marked for deletion are not returned in GET call. One can use the search API to get these objects. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
action (str or None) –
Possible values are:
- L3VpnRule.ACTION_PROTECT
- L3VpnRule.ACTION_BYPASS
Action to exchange data with or without protection. PROTECT - Allows to exchange data with ipsec protection. Protect rules are defined per L3Vpn. BYPASS - Allows to exchange data without ipsec protection. Bypass rules are defined per L3VpnContext and affects all policy based L3Vpns. Bypass rules are prioritized over protect rules.
destinations (list of L3VpnSubnet) – List of remote subnets used in policy-based L3Vpn.
sequence_number (long or None) – This field is used to resolve conflicts between multiple L3VpnRules associated with a single L3Vpn or L3VpnContext. format: int32
sources (list of L3VpnSubnet) – List of local subnets used in policy-based L3Vpn.

ACTION_BYPASS = 'BYPASS'¶

ACTION_PROTECT = 'PROTECT'¶

class com.vmware.nsx_policy.model_client.L3VpnSession(resource_type='L3VpnSession')¶

Bases: vmware.vapi.bindings.struct.VapiStruct

Contains information about L3Vpn session.

Tip

The arguments are used to initialize data attributes with the same names.

Parameters

resource_type (str) –

Possible values are:

L3VpnSession.RESOURCE_TYPE_POLICYBASEDL3VPNSESSION
L3VpnSession.RESOURCE_TYPE_ROUTEBASEDL3VPNSESSION

A Policy Based L3Vpn is a configuration in which protect rules to

match local and remote subnet needs to be defined. Tunnel is established for each pair of local and remote subnet defined in protect rules. - A Route Based L3Vpn is more flexible, more powerful and recommended over policy based. IP Tunnel subnet is created and all traffic routed through tunnel subnet (commonly known as VTI) is sent over tunnel. Routes can be learned through BGP. A route based L3Vpn is required when using redundant L3Vpn.

RESOURCE_TYPE_POLICYBASEDL3VPNSESSION = 'PolicyBasedL3VpnSession'¶

RESOURCE_TYPE_ROUTEBASEDL3VPNSESSION = 'RouteBasedL3VpnSession'¶

property resource_type¶: Return the discriminator value

class com.vmware.nsx_policy.model_client.L3VpnStatisticsPerEnforcementPoint(enforcement_point_path=None, resource_type='L3VpnStatisticsPerEnforcementPoint')¶

Bases: vmware.vapi.bindings.struct.VapiStruct

L3Vpn Statistics Per Enforcement Point.

Tip

The arguments are used to initialize data attributes with the same names.

Parameters

enforcement_point_path (str or None) – Policy Path referencing the enforcement point wehere the statistics are fetched. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
resource_type (str) –
Possible values are:
- L3VpnStatisticsPerEnforcementPoint.RESOURCE_TYPE_IPSECVPNSESSIONSTATISTICS

RESOURCE_TYPE_IPSECVPNSESSIONSTATISTICS = 'IPSecVpnSessionStatistics'¶

property resource_type¶: Return the discriminator value

class com.vmware.nsx_policy.model_client.L3VpnSubnet(subnet=None)¶

Bases: vmware.vapi.bindings.struct.VapiStruct

Used to specify subnets in L3Vpn rule.

Tip

The arguments are used to initialize data attributes with the same names.

Parameters: subnet (str) – Subnet used in L3Vpn Rule. format: ipv4-cidr-block

class com.vmware.nsx_policy.model_client.L4PolicyLbPersistenceProfile(persistence=None, links=None, schema=None, self_=None, revision=None, create_time=None, create_user=None, last_modified_time=None, last_modified_user=None, protection=None, system_owned=None, description=None, display_name=None, id=None, resource_type='L4PolicyLbPersistenceProfile', tags=None, parent_path=None, path=None, relative_path=None, children=None, marked_for_delete=None)¶

Bases: vmware.vapi.bindings.struct.VapiStruct

Some applications maintain state and require all relevant connections to be sent to the same server as the application state is not synchronized among servers. Persistence is enabled on a PolicyLbVirtualServer by binding a persistence profile to it.

Tip

The arguments are used to initialize data attributes with the same names.

Parameters

persistence (str or None) –
Possible values are:
- L4PolicyLbPersistenceProfile.PERSISTENCE_IP
This field indicates the persistence method used for the PolicyLbVirtualServer. - SOURCE_IP persistence ensures all connections from a client (identified by IP address) are sent to the same backend server for a specified period. - This object is not required and persistence is disabled by default
links (list of ResourceLink or None) – The server will populate this field when returing the resource. Ignored on PUT and POST. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
schema (str or None) – Schema for this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
self (SelfResourceLink or None) – Link to this resource
revision (long or None) – The _revision property describes the current revision of the resource. To prevent clients from overwriting each other’s changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected. format: int32
create_time (long or None) – Timestamp of resource creation format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
create_user (str or None) – ID of the user who created this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
last_modified_time (long or None) – Timestamp of last modification format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
last_modified_user (str or None) – ID of the user who last modified this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
protection (str or None) – Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super user and can modify it, but only when providing the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this entity. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
system_owned (bool or None) – Indicates system owned resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
description (str or None) – Description of this resource
display_name (str or None) – Defaults to ID if not set
id (str or None) – Unique identifier of this resource
resource_type (str) –
Possible values are:
- PolicyLbPersistenceProfile.RESOURCE_TYPE_L4POLICYLBPERSISTENCEPROFILE
- PolicyLbPersistenceProfile.RESOURCE_TYPE_L7POLICYLBPERSISTENCEPROFILE
- PolicyLbPersistenceProfile.RESOURCE_TYPE_CUSTOMPOLICYLBPERSISTENCEPROFILE
tags (list of Tag or None) – Opaque identifiers meaningful to the API user
parent_path (str or None) – Path of its parent This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
path (str or None) – Absolute path of this object This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
relative_path (str or None) – Path relative from its parent This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
children (list of vmware.vapi.struct.VapiStruct or None) – subtree for this type within policy tree containing nested elements. When clients pass a value of this class as a parameter, the attribute must contain all the attributes defined in ChildPolicyConfigResource. When methods return a value of this class as a return value, the attribute will contain all the attributes defined in ChildPolicyConfigResource.
marked_for_delete (bool or None) – Intent objects are not directly deleted from the system when a delete is invoked on them. They are marked for deletion and only when all the realized entities for that intent object gets deleted, the intent object is deleted. Objects that are marked for deletion are not returned in GET call. One can use the search API to get these objects. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.

PERSISTENCE_IP = 'SOURCE_IP'¶

property resource_type¶: Return the discriminator value

class com.vmware.nsx_policy.model_client.L4PortSetServiceEntry(destination_ports=None, l4_protocol=None, source_ports=None, links=None, schema=None, self_=None, revision=None, create_time=None, create_user=None, last_modified_time=None, last_modified_user=None, protection=None, system_owned=None, description=None, display_name=None, id=None, resource_type='L4PortSetServiceEntry', tags=None, parent_path=None, path=None, relative_path=None, children=None, marked_for_delete=None)¶

Bases: vmware.vapi.bindings.struct.VapiStruct

L4PortSet can be specified in comma separated notation of parts. Parts of a L4PortSet includes single integer or range of port in hyphen notation. Example of a PortSet: “22, 33-70, 44”.

Tip

The arguments are used to initialize data attributes with the same names.

Parameters

destination_ports (list of str or None) –
l4_protocol (str) –
Possible values are:
- L4PortSetServiceEntry.L4PROTOCOL_TCP
- L4PortSetServiceEntry.L4PROTOCOL_UDP
source_ports (list of str or None) –
links (list of ResourceLink or None) – The server will populate this field when returing the resource. Ignored on PUT and POST. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
schema (str or None) – Schema for this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
self (SelfResourceLink or None) – Link to this resource
revision (long or None) – The _revision property describes the current revision of the resource. To prevent clients from overwriting each other’s changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected. format: int32
create_time (long or None) – Timestamp of resource creation format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
create_user (str or None) – ID of the user who created this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
last_modified_time (long or None) – Timestamp of last modification format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
last_modified_user (str or None) – ID of the user who last modified this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
protection (str or None) – Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super user and can modify it, but only when providing the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this entity. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
system_owned (bool or None) – Indicates system owned resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
description (str or None) – Description of this resource
display_name (str or None) – Defaults to ID if not set
id (str or None) – Unique identifier of this resource
resource_type (str) –
Possible values are:
- ServiceEntry.RESOURCE_TYPE_IPPROTOCOLSERVICEENTRY
- ServiceEntry.RESOURCE_TYPE_IGMPTYPESERVICEENTRY
- ServiceEntry.RESOURCE_TYPE_ICMPTYPESERVICEENTRY
- ServiceEntry.RESOURCE_TYPE_ALGTYPESERVICEENTRY
- ServiceEntry.RESOURCE_TYPE_L4PORTSETSERVICEENTRY
- ServiceEntry.RESOURCE_TYPE_ETHERTYPESERVICEENTRY
tags (list of Tag or None) – Opaque identifiers meaningful to the API user
parent_path (str or None) – Path of its parent This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
path (str or None) – Absolute path of this object This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
relative_path (str or None) – Path relative from its parent This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
children (list of vmware.vapi.struct.VapiStruct or None) – subtree for this type within policy tree containing nested elements. When clients pass a value of this class as a parameter, the attribute must contain all the attributes defined in ChildPolicyConfigResource. When methods return a value of this class as a return value, the attribute will contain all the attributes defined in ChildPolicyConfigResource.
marked_for_delete (bool or None) – Intent objects are not directly deleted from the system when a delete is invoked on them. They are marked for deletion and only when all the realized entities for that intent object gets deleted, the intent object is deleted. Objects that are marked for deletion are not returned in GET call. One can use the search API to get these objects. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.

L4PROTOCOL_TCP = 'TCP'¶

L4PROTOCOL_UDP = 'UDP'¶

property resource_type¶: Return the discriminator value

class com.vmware.nsx_policy.model_client.L7PolicyLbPersistenceProfile(persistence=None, links=None, schema=None, self_=None, revision=None, create_time=None, create_user=None, last_modified_time=None, last_modified_user=None, protection=None, system_owned=None, description=None, display_name=None, id=None, resource_type='L7PolicyLbPersistenceProfile', tags=None, parent_path=None, path=None, relative_path=None, children=None, marked_for_delete=None)¶

Bases: vmware.vapi.bindings.struct.VapiStruct

Some applications maintain state and require all relevant connections to be sent to the same server as the application state is not synchronized among servers. Persistence is enabled on a PolicyLbVirtualServer by binding a persistence profile to it.

Tip

The arguments are used to initialize data attributes with the same names.

Parameters

persistence (str or None) –
Possible values are:
- L7PolicyLbPersistenceProfile.PERSISTENCE_COOKIE
This field indicates the persistence method used for the PolicyLbVirtualServer. - COOKIE persistence allows related client connections, identified by the same cookie in HTTP requests [Refer to HTTP Cookie for details on HTTP cookies], to be redirected to the same server. Load balancer does not maintain any persistence table for cookie persistence. Instead, it encodes the necessary information in the HTTP cookie value sent to client and relies on the client to store it and send it back in subsequent related HTTP requests. Hence there is no limit on the number of cookie persistence entries that can be supported. - This object is not required and persistence is disabled by default
links (list of ResourceLink or None) – The server will populate this field when returing the resource. Ignored on PUT and POST. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
schema (str or None) – Schema for this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
self (SelfResourceLink or None) – Link to this resource
revision (long or None) – The _revision property describes the current revision of the resource. To prevent clients from overwriting each other’s changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected. format: int32
create_time (long or None) – Timestamp of resource creation format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
create_user (str or None) – ID of the user who created this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
last_modified_time (long or None) – Timestamp of last modification format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
last_modified_user (str or None) – ID of the user who last modified this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
protection (str or None) – Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super user and can modify it, but only when providing the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this entity. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
system_owned (bool or None) – Indicates system owned resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
description (str or None) – Description of this resource
display_name (str or None) – Defaults to ID if not set
id (str or None) – Unique identifier of this resource
resource_type (str) –
Possible values are:
- PolicyLbPersistenceProfile.RESOURCE_TYPE_L4POLICYLBPERSISTENCEPROFILE
- PolicyLbPersistenceProfile.RESOURCE_TYPE_L7POLICYLBPERSISTENCEPROFILE
- PolicyLbPersistenceProfile.RESOURCE_TYPE_CUSTOMPOLICYLBPERSISTENCEPROFILE
tags (list of Tag or None) – Opaque identifiers meaningful to the API user
parent_path (str or None) – Path of its parent This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
path (str or None) – Absolute path of this object This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
relative_path (str or None) – Path relative from its parent This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
children (list of vmware.vapi.struct.VapiStruct or None) – subtree for this type within policy tree containing nested elements. When clients pass a value of this class as a parameter, the attribute must contain all the attributes defined in ChildPolicyConfigResource. When methods return a value of this class as a return value, the attribute will contain all the attributes defined in ChildPolicyConfigResource.
marked_for_delete (bool or None) – Intent objects are not directly deleted from the system when a delete is invoked on them. They are marked for deletion and only when all the realized entities for that intent object gets deleted, the intent object is deleted. Objects that are marked for deletion are not returned in GET call. One can use the search API to get these objects. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.

PERSISTENCE_COOKIE = 'COOKIE'¶

property resource_type¶: Return the discriminator value

class com.vmware.nsx_policy.model_client.LBActiveMonitor(fall_count=None, interval=None, monitor_port=None, rise_count=None, timeout=None, links=None, schema=None, self_=None, revision=None, create_time=None, create_user=None, last_modified_time=None, last_modified_user=None, protection=None, system_owned=None, description=None, display_name=None, id=None, resource_type='LBActiveMonitor', tags=None, parent_path=None, path=None, relative_path=None, children=None, marked_for_delete=None)¶

Bases: vmware.vapi.bindings.struct.VapiStruct

All the active types of LBMonitorProfile extend from this abstract class. This is present for extensibility.

Tip

The arguments are used to initialize data attributes with the same names.

Parameters

fall_count (long or None) – Only if a healthcheck fails consecutively for a specified number of times, given with fall_count, to a member will the member status be marked DOWN. format: int64
interval (long or None) – Active healthchecks are initiated periodically, at a configurable interval (in seconds), to each member of the Group. format: int64
monitor_port (long or None) – Typically, monitors perform healthchecks to Group members using the member IP address and pool_port. However, in some cases, customers prefer to run healthchecks against a different port than the pool member port which handles actual application traffic. In such cases, the port to run healthchecks against can be specified in the monitor_port value. For ICMP monitor, monitor_port is not required. format: int32
rise_count (long or None) – Once a member is DOWN, a specified number of consecutive successful healthchecks specified by rise_count will bring the member back to UP state. format: int64
timeout (long or None) – Timeout specified in seconds. After a healthcheck is initiated, if it does not complete within a certain period, then also the healthcheck is considered to be unsuccessful. Completing a healthcheck within timeout means establishing a connection (TCP or SSL), if applicable, sending the request and receiving the response, all within the configured timeout. format: int64
links (list of ResourceLink or None) – The server will populate this field when returing the resource. Ignored on PUT and POST. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
schema (str or None) – Schema for this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
self (SelfResourceLink or None) – Link to this resource
revision (long or None) – The _revision property describes the current revision of the resource. To prevent clients from overwriting each other’s changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected. format: int32
create_time (long or None) – Timestamp of resource creation format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
create_user (str or None) – ID of the user who created this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
last_modified_time (long or None) – Timestamp of last modification format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
last_modified_user (str or None) – ID of the user who last modified this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
protection (str or None) – Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super user and can modify it, but only when providing the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this entity. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
system_owned (bool or None) – Indicates system owned resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
description (str or None) – Description of this resource
display_name (str or None) – Defaults to ID if not set
id (str or None) – Unique identifier of this resource
resource_type (str) –
Possible values are:
- LBMonitorProfile.RESOURCE_TYPE_LBTCPMONITORPROFILE
- LBMonitorProfile.RESOURCE_TYPE_LBUDPMONITORPROFILE
- LBMonitorProfile.RESOURCE_TYPE_LBICMPMONITORPROFILE
- LBMonitorProfile.RESOURCE_TYPE_LBHTTPMONITORPROFILE
- LBMonitorProfile.RESOURCE_TYPE_LBHTTPSMONITORPROFILE
- LBMonitorProfile.RESOURCE_TYPE_LBPASSIVEMONITORPROFILE
There are two types of healthchecks: active and passive. Passive healthchecks depend on failures in actual client traffic (e.g. RST from server in response to a client connection) to detect that the server or the application is down. In case of active healthchecks, load balancer itself initiates new connections (or sends ICMP ping) to the servers periodically to check their health, completely independent of any data traffic. Currently, active health monitors are supported for HTTP, HTTPS, TCP, UDP and ICMP protocols.
tags (list of Tag or None) – Opaque identifiers meaningful to the API user
parent_path (str or None) – Path of its parent This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
path (str or None) – Absolute path of this object This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
relative_path (str or None) – Path relative from its parent This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
children (list of vmware.vapi.struct.VapiStruct or None) – subtree for this type within policy tree containing nested elements. When clients pass a value of this class as a parameter, the attribute must contain all the attributes defined in ChildPolicyConfigResource. When methods return a value of this class as a return value, the attribute will contain all the attributes defined in ChildPolicyConfigResource.
marked_for_delete (bool or None) – Intent objects are not directly deleted from the system when a delete is invoked on them. They are marked for deletion and only when all the realized entities for that intent object gets deleted, the intent object is deleted. Objects that are marked for deletion are not returned in GET call. One can use the search API to get these objects. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.

property resource_type¶: Return the discriminator value

class com.vmware.nsx_policy.model_client.LBAppProfile(links=None, schema=None, self_=None, revision=None, create_time=None, create_user=None, last_modified_time=None, last_modified_user=None, protection=None, system_owned=None, description=None, display_name=None, id=None, resource_type='LBAppProfile', tags=None, parent_path=None, path=None, relative_path=None, children=None, marked_for_delete=None)¶

Bases: vmware.vapi.bindings.struct.VapiStruct

App profile.

Tip

The arguments are used to initialize data attributes with the same names.

Parameters

links (list of ResourceLink or None) – The server will populate this field when returing the resource. Ignored on PUT and POST. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
schema (str or None) – Schema for this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
self (SelfResourceLink or None) – Link to this resource
revision (long or None) – The _revision property describes the current revision of the resource. To prevent clients from overwriting each other’s changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected. format: int32
create_time (long or None) – Timestamp of resource creation format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
create_user (str or None) – ID of the user who created this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
last_modified_time (long or None) – Timestamp of last modification format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
last_modified_user (str or None) – ID of the user who last modified this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
protection (str or None) – Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super user and can modify it, but only when providing the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this entity. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
system_owned (bool or None) – Indicates system owned resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
description (str or None) – Description of this resource
display_name (str or None) – Defaults to ID if not set
id (str or None) – Unique identifier of this resource
resource_type (str) –
Possible values are:
- LBAppProfile.RESOURCE_TYPE_LBHTTPPROFILE
- LBAppProfile.RESOURCE_TYPE_LBFASTTCPPROFILE
- LBAppProfile.RESOURCE_TYPE_LBFASTUDPPROFILE
An application profile can be bound to a virtual server to specify the application protocol characteristics. It is used to influence how load balancing is performed. Currently, three types of application profiles are supported: LBFastTCPProfile, LBFastUDPProfile and LBHttpProfile. LBFastTCPProfile or LBFastUDPProfile is typically used when the application is using a custom protocol or a standard protocol not supported by the load balancer. It is also used in cases where the user only wants L4 load balancing mainly because L4 load balancing has much higher performance and scalability, and/or supports connection mirroring. LBHttpProfile is used for both HTTP and HTTPS applications. Though application rules, if bound to the virtual server, can be used to accomplish the same goal, LBHttpProfile is intended to simplify enabling certain common use cases.
tags (list of Tag or None) – Opaque identifiers meaningful to the API user
parent_path (str or None) – Path of its parent This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
path (str or None) – Absolute path of this object This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
relative_path (str or None) – Path relative from its parent This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
children (list of vmware.vapi.struct.VapiStruct or None) – subtree for this type within policy tree containing nested elements. When clients pass a value of this class as a parameter, the attribute must contain all the attributes defined in ChildPolicyConfigResource. When methods return a value of this class as a return value, the attribute will contain all the attributes defined in ChildPolicyConfigResource.
marked_for_delete (bool or None) – Intent objects are not directly deleted from the system when a delete is invoked on them. They are marked for deletion and only when all the realized entities for that intent object gets deleted, the intent object is deleted. Objects that are marked for deletion are not returned in GET call. One can use the search API to get these objects. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.

RESOURCE_TYPE_LBFASTTCPPROFILE = 'LBFastTcpProfile'¶

RESOURCE_TYPE_LBFASTUDPPROFILE = 'LBFastUdpProfile'¶

RESOURCE_TYPE_LBHTTPPROFILE = 'LBHttpProfile'¶

property resource_type¶: Return the discriminator value

class com.vmware.nsx_policy.model_client.LBClientCertificateIssuerDnCondition(case_sensitive=None, issuer_dn=None, match_type=None)¶

Bases: vmware.vapi.bindings.struct.VapiStruct

Match condition for client certficate issuer DN.

Tip

The arguments are used to initialize data attributes with the same names.

Parameters

case_sensitive (bool or None) – If true, case is significant when comparing issuer DN value.
issuer_dn (str) – Value of issuer DN.
match_type (str or None) –
Possible values are:
Match type of issuer DN.

MATCH_TYPE_CONTAINS = 'CONTAINS'¶

MATCH_TYPE_ENDS_WITH = 'ENDS_WITH'¶

MATCH_TYPE_EQUALS = 'EQUALS'¶

MATCH_TYPE_REGEX = 'REGEX'¶

MATCH_TYPE_STARTS_WITH = 'STARTS_WITH'¶

class com.vmware.nsx_policy.model_client.LBClientCertificateSubjectDnCondition(case_sensitive=None, match_type=None, subject_dn=None)¶

Bases: vmware.vapi.bindings.struct.VapiStruct

Match condition for client certficate subject DN.

Tip

The arguments are used to initialize data attributes with the same names.

Parameters

case_sensitive (bool or None) – If true, case is significant when comparing subject DN value.
match_type (str or None) –
Possible values are:
Match type of subject DN.
subject_dn (str) – Value of subject DN.

MATCH_TYPE_CONTAINS = 'CONTAINS'¶

MATCH_TYPE_ENDS_WITH = 'ENDS_WITH'¶

MATCH_TYPE_EQUALS = 'EQUALS'¶

MATCH_TYPE_REGEX = 'REGEX'¶

MATCH_TYPE_STARTS_WITH = 'STARTS_WITH'¶

class com.vmware.nsx_policy.model_client.LBClientSslProfile(links=None, schema=None, self_=None, revision=None, create_time=None, create_user=None, last_modified_time=None, last_modified_user=None, protection=None, system_owned=None, description=None, display_name=None, id=None, resource_type=None, tags=None, parent_path=None, path=None, relative_path=None, children=None, marked_for_delete=None, cipher_group_label=None, ciphers=None, is_fips=None, is_secure=None, prefer_server_ciphers=None, protocols=None, session_cache_enabled=None, session_cache_timeout=None)¶

Bases: vmware.vapi.bindings.struct.VapiStruct

Client SSL profile.

Tip

The arguments are used to initialize data attributes with the same names.

Parameters

links (list of ResourceLink or None) – The server will populate this field when returing the resource. Ignored on PUT and POST. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
schema (str or None) – Schema for this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
self (SelfResourceLink or None) – Link to this resource
revision (long or None) – The _revision property describes the current revision of the resource. To prevent clients from overwriting each other’s changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected. format: int32
create_time (long or None) – Timestamp of resource creation format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
create_user (str or None) – ID of the user who created this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
last_modified_time (long or None) – Timestamp of last modification format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
last_modified_user (str or None) – ID of the user who last modified this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
protection (str or None) – Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super user and can modify it, but only when providing the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this entity. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
system_owned (bool or None) – Indicates system owned resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
description (str or None) – Description of this resource
display_name (str or None) – Defaults to ID if not set
id (str or None) – Unique identifier of this resource
resource_type (str or None) – The type of this resource.
tags (list of Tag or None) – Opaque identifiers meaningful to the API user
parent_path (str or None) – Path of its parent This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
path (str or None) – Absolute path of this object This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
relative_path (str or None) – Path relative from its parent This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
children (list of vmware.vapi.struct.VapiStruct or None) – subtree for this type within policy tree containing nested elements. When clients pass a value of this class as a parameter, the attribute must contain all the attributes defined in ChildPolicyConfigResource. When methods return a value of this class as a return value, the attribute will contain all the attributes defined in ChildPolicyConfigResource.
marked_for_delete (bool or None) – Intent objects are not directly deleted from the system when a delete is invoked on them. They are marked for deletion and only when all the realized entities for that intent object gets deleted, the intent object is deleted. Objects that are marked for deletion are not returned in GET call. One can use the search API to get these objects. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
cipher_group_label (str or None) –
Possible values are:
- LBClientSslProfile.CIPHER_GROUP_LABEL_BALANCED
- LBClientSslProfile.CIPHER_GROUP_LABEL_HIGH_SECURITY
- LBClientSslProfile.CIPHER_GROUP_LABEL_HIGH_COMPATIBILITY
- LBClientSslProfile.CIPHER_GROUP_LABEL_CUSTOM
It is a label of cipher group which is mostly consumed by GUI.
ciphers (list of str or None) –
Possible values are:
- LBClientSslProfile.CIPHERS_ECDHE_RSA_WITH_AES_128_GCM_SHA256
- LBClientSslProfile.CIPHERS_ECDHE_RSA_WITH_AES_256_GCM_SHA384
- LBClientSslProfile.CIPHERS_ECDHE_RSA_WITH_AES_256_CBC_SHA
- LBClientSslProfile.CIPHERS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA
- LBClientSslProfile.CIPHERS_ECDH_ECDSA_WITH_AES_256_CBC_SHA
- LBClientSslProfile.CIPHERS_ECDH_RSA_WITH_AES_256_CBC_SHA
- LBClientSslProfile.CIPHERS_RSA_WITH_AES_256_CBC_SHA
- LBClientSslProfile.CIPHERS_RSA_WITH_AES_128_CBC_SHA
- LBClientSslProfile.CIPHERS_RSA_WITH_3DES_EDE_CBC_SHA
- LBClientSslProfile.CIPHERS_ECDHE_RSA_WITH_AES_128_CBC_SHA
- LBClientSslProfile.CIPHERS_ECDHE_RSA_WITH_AES_128_CBC_SHA256
- LBClientSslProfile.CIPHERS_ECDHE_RSA_WITH_AES_256_CBC_SHA384
- LBClientSslProfile.CIPHERS_RSA_WITH_AES_128_CBC_SHA256
- LBClientSslProfile.CIPHERS_RSA_WITH_AES_128_GCM_SHA256
- LBClientSslProfile.CIPHERS_RSA_WITH_AES_256_CBC_SHA256
- LBClientSslProfile.CIPHERS_RSA_WITH_AES_256_GCM_SHA384
- LBClientSslProfile.CIPHERS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA
- LBClientSslProfile.CIPHERS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA256
- LBClientSslProfile.CIPHERS_ECDHE_ECDSA_WITH_AES_128_GCM_SHA256
- LBClientSslProfile.CIPHERS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA384
- LBClientSslProfile.CIPHERS_ECDHE_ECDSA_WITH_AES_256_GCM_SHA384
- LBClientSslProfile.CIPHERS_ECDH_ECDSA_WITH_AES_128_CBC_SHA
- LBClientSslProfile.CIPHERS_ECDH_ECDSA_WITH_AES_128_CBC_SHA256
- LBClientSslProfile.CIPHERS_ECDH_ECDSA_WITH_AES_128_GCM_SHA256
- LBClientSslProfile.CIPHERS_ECDH_ECDSA_WITH_AES_256_CBC_SHA384
- LBClientSslProfile.CIPHERS_ECDH_ECDSA_WITH_AES_256_GCM_SHA384
- LBClientSslProfile.CIPHERS_ECDH_RSA_WITH_AES_128_CBC_SHA
- LBClientSslProfile.CIPHERS_ECDH_RSA_WITH_AES_128_CBC_SHA256
- LBClientSslProfile.CIPHERS_ECDH_RSA_WITH_AES_128_GCM_SHA256
- LBClientSslProfile.CIPHERS_ECDH_RSA_WITH_AES_256_CBC_SHA384
- LBClientSslProfile.CIPHERS_ECDH_RSA_WITH_AES_256_GCM_SHA384
  
  Supported SSL cipher list to client side.
is_fips (bool or None) – This flag is set to true when all the ciphers and protocols are FIPS compliant. It is set to false when one of the ciphers or protocols are not FIPS compliant.. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
is_secure (bool or None) – This flag is set to true when all the ciphers and protocols are secure. It is set to false when one of the ciphers or protocols is insecure. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
prefer_server_ciphers (bool or None) – During SSL handshake as part of the SSL client Hello client sends an ordered list of ciphers that it can support (or prefers) and typically server selects the first one from the top of that list it can also support. For Perfect Forward Secrecy(PFS), server could override the client’s preference.
protocols (list of str or None) –
Possible values are:
- LBClientSslProfile.PROTOCOLS_SSL_V2
- LBClientSslProfile.PROTOCOLS_SSL_V3
- LBClientSslProfile.PROTOCOLS_TLS_V1
- LBClientSslProfile.PROTOCOLS_TLS_V1_1
- LBClientSslProfile.PROTOCOLS_TLS_V1_2
SSL versions TLS1.1 and TLS1.2 are supported and enabled by default. SSLv2, SSLv3, and TLS1.0 are supported, but disabled by default.
session_cache_enabled (bool or None) – SSL session caching allows SSL client and server to reuse previously negotiated security parameters avoiding the expensive public key operation during handshake.
session_cache_timeout (long or None) – Session cache timeout specifies how long the SSL session parameters are held on to and can be reused. format: int64

CIPHERS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA = 'TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA'¶

CIPHERS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA256 = 'TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA256'¶

CIPHERS_ECDHE_ECDSA_WITH_AES_128_GCM_SHA256 = 'TLS_ECDHE_ECDSA_WITH_AES_128_GCM_SHA256'¶

CIPHERS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA = 'TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA'¶

CIPHERS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA384 = 'TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA384'¶

CIPHERS_ECDHE_ECDSA_WITH_AES_256_GCM_SHA384 = 'TLS_ECDHE_ECDSA_WITH_AES_256_GCM_SHA384'¶

CIPHERS_ECDHE_RSA_WITH_AES_128_CBC_SHA = 'TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA'¶

CIPHERS_ECDHE_RSA_WITH_AES_128_CBC_SHA256 = 'TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA256'¶

CIPHERS_ECDHE_RSA_WITH_AES_128_GCM_SHA256 = 'TLS_ECDHE_RSA_WITH_AES_128_GCM_SHA256'¶

CIPHERS_ECDHE_RSA_WITH_AES_256_CBC_SHA = 'TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA'¶

CIPHERS_ECDHE_RSA_WITH_AES_256_CBC_SHA384 = 'TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA384'¶

CIPHERS_ECDHE_RSA_WITH_AES_256_GCM_SHA384 = 'TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384'¶

CIPHERS_ECDH_ECDSA_WITH_AES_128_CBC_SHA = 'TLS_ECDH_ECDSA_WITH_AES_128_CBC_SHA'¶

CIPHERS_ECDH_ECDSA_WITH_AES_128_CBC_SHA256 = 'TLS_ECDH_ECDSA_WITH_AES_128_CBC_SHA256'¶

CIPHERS_ECDH_ECDSA_WITH_AES_128_GCM_SHA256 = 'TLS_ECDH_ECDSA_WITH_AES_128_GCM_SHA256'¶

CIPHERS_ECDH_ECDSA_WITH_AES_256_CBC_SHA = 'TLS_ECDH_ECDSA_WITH_AES_256_CBC_SHA'¶

CIPHERS_ECDH_ECDSA_WITH_AES_256_CBC_SHA384 = 'TLS_ECDH_ECDSA_WITH_AES_256_CBC_SHA384'¶

CIPHERS_ECDH_ECDSA_WITH_AES_256_GCM_SHA384 = 'TLS_ECDH_ECDSA_WITH_AES_256_GCM_SHA384'¶

CIPHERS_ECDH_RSA_WITH_AES_128_CBC_SHA = 'TLS_ECDH_RSA_WITH_AES_128_CBC_SHA'¶

CIPHERS_ECDH_RSA_WITH_AES_128_CBC_SHA256 = 'TLS_ECDH_RSA_WITH_AES_128_CBC_SHA256'¶

CIPHERS_ECDH_RSA_WITH_AES_128_GCM_SHA256 = 'TLS_ECDH_RSA_WITH_AES_128_GCM_SHA256'¶

CIPHERS_ECDH_RSA_WITH_AES_256_CBC_SHA = 'TLS_ECDH_RSA_WITH_AES_256_CBC_SHA'¶

CIPHERS_ECDH_RSA_WITH_AES_256_CBC_SHA384 = 'TLS_ECDH_RSA_WITH_AES_256_CBC_SHA384'¶

CIPHERS_ECDH_RSA_WITH_AES_256_GCM_SHA384 = 'TLS_ECDH_RSA_WITH_AES_256_GCM_SHA384'¶

CIPHERS_RSA_WITH_3DES_EDE_CBC_SHA = 'TLS_RSA_WITH_3DES_EDE_CBC_SHA'¶

CIPHERS_RSA_WITH_AES_128_CBC_SHA = 'TLS_RSA_WITH_AES_128_CBC_SHA'¶

CIPHERS_RSA_WITH_AES_128_CBC_SHA256 = 'TLS_RSA_WITH_AES_128_CBC_SHA256'¶

CIPHERS_RSA_WITH_AES_128_GCM_SHA256 = 'TLS_RSA_WITH_AES_128_GCM_SHA256'¶

CIPHERS_RSA_WITH_AES_256_CBC_SHA = 'TLS_RSA_WITH_AES_256_CBC_SHA'¶

CIPHERS_RSA_WITH_AES_256_CBC_SHA256 = 'TLS_RSA_WITH_AES_256_CBC_SHA256'¶

CIPHERS_RSA_WITH_AES_256_GCM_SHA384 = 'TLS_RSA_WITH_AES_256_GCM_SHA384'¶

CIPHER_GROUP_LABEL_BALANCED = 'BALANCED'¶

CIPHER_GROUP_LABEL_CUSTOM = 'CUSTOM'¶

CIPHER_GROUP_LABEL_HIGH_COMPATIBILITY = 'HIGH_COMPATIBILITY'¶

CIPHER_GROUP_LABEL_HIGH_SECURITY = 'HIGH_SECURITY'¶

PROTOCOLS_SSL_V2 = 'SSL_V2'¶

PROTOCOLS_SSL_V3 = 'SSL_V3'¶

PROTOCOLS_TLS_V1 = 'TLS_V1'¶

PROTOCOLS_TLS_V1_1 = 'TLS_V1_1'¶

PROTOCOLS_TLS_V1_2 = 'TLS_V1_2'¶

class com.vmware.nsx_policy.model_client.LBClientSslProfileBinding(certificate_chain_depth=None, client_auth=None, client_auth_ca_paths=None, client_auth_crl_paths=None, default_certificate_path=None, sni_certificate_paths=None, ssl_profile_path=None)¶

Bases: vmware.vapi.bindings.struct.VapiStruct

Client SSL profile binding.

Tip

The arguments are used to initialize data attributes with the same names.

Parameters

certificate_chain_depth (long or None) – Authentication depth is used to set the verification depth in the client certificates chain. format: int64
client_auth (str or None) –
Possible values are:
- LBClientSslProfileBinding.CLIENT_AUTH_REQUIRED
- LBClientSslProfileBinding.CLIENT_AUTH_IGNORE
Client authentication mode.
client_auth_ca_paths (list of str or None) – If client auth type is REQUIRED, client certificate must be signed by one of the trusted Certificate Authorities (CAs), also referred to as root CAs, whose self signed certificates are specified.
client_auth_crl_paths (list of str or None) – A Certificate Revocation List (CRL) can be specified in the client-side SSL profile binding to disallow compromised client certificates.
default_certificate_path (str) – A default certificate should be specified which will be used if the server does not host multiple hostnames on the same IP address or if the client does not support SNI extension.
sni_certificate_paths (list of str or None) – Client-side SSL profile binding allows multiple certificates, for different hostnames, to be bound to the same virtual server.
ssl_profile_path (str or None) – Client SSL profile defines reusable, application-independent client side SSL properties.

CLIENT_AUTH_IGNORE = 'IGNORE'¶

CLIENT_AUTH_REQUIRED = 'REQUIRED'¶

class com.vmware.nsx_policy.model_client.LBCookiePersistenceProfile(cookie_domain=None, cookie_fallback=None, cookie_garble=None, cookie_mode=None, cookie_name=None, cookie_path=None, cookie_time=None, links=None, schema=None, self_=None, revision=None, create_time=None, create_user=None, last_modified_time=None, last_modified_user=None, protection=None, system_owned=None, description=None, display_name=None, id=None, resource_type='LBCookiePersistenceProfile', tags=None, parent_path=None, path=None, relative_path=None, children=None, marked_for_delete=None, persistence_shared=None)¶

Bases: vmware.vapi.bindings.struct.VapiStruct

Some applications maintain state and require all relevant connections to be sent to the same server as the application state is not synchronized among servers. Persistence is enabled on a LBVirtualServer by binding a persistence profile to it.

Tip

The arguments are used to initialize data attributes with the same names.

Parameters

cookie_domain (str or None) – HTTP cookie domain could be configured, only available for insert mode.
cookie_fallback (bool or None) – If fallback is true, once the cookie points to a server that is down (i.e. admin state DISABLED or healthcheck state is DOWN), then a new server is selected by default to handle that request. If fallback is false, it will cause the request to be rejected if cookie points to a server.
cookie_garble (bool or None) – If garble is set to true, cookie value (server IP and port) would be encrypted. If garble is set to false, cookie value would be plain text.
cookie_mode (str or None) –
Possible values are:
- LBCookiePersistenceProfile.COOKIE_MODE_INSERT
- LBCookiePersistenceProfile.COOKIE_MODE_PREFIX
- LBCookiePersistenceProfile.COOKIE_MODE_REWRITE
Cookie persistence mode.
cookie_name (str or None) – Cookie name.
cookie_path (str or None) – HTTP cookie path could be set, only available for insert mode.
cookie_time (vmware.vapi.struct.VapiStruct or None) – Both session cookie and persistence cookie are supported, if not specified, it’s a session cookie. It expires when the browser is closed. When clients pass a value of this class as a parameter, the attribute must contain all the attributes defined in LBCookieTime. When methods return a value of this class as a return value, the attribute will contain all the attributes defined in LBCookieTime.
links (list of ResourceLink or None) – The server will populate this field when returing the resource. Ignored on PUT and POST. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
schema (str or None) – Schema for this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
self (SelfResourceLink or None) – Link to this resource
revision (long or None) – The _revision property describes the current revision of the resource. To prevent clients from overwriting each other’s changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected. format: int32
create_time (long or None) – Timestamp of resource creation format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
create_user (str or None) – ID of the user who created this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
last_modified_time (long or None) – Timestamp of last modification format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
last_modified_user (str or None) – ID of the user who last modified this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
protection (str or None) – Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super user and can modify it, but only when providing the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this entity. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
system_owned (bool or None) – Indicates system owned resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
description (str or None) – Description of this resource
display_name (str or None) – Defaults to ID if not set
id (str or None) – Unique identifier of this resource
resource_type (str) –
Possible values are:
- LBPersistenceProfile.RESOURCE_TYPE_LBSOURCEIPPERSISTENCEPROFILE
- LBPersistenceProfile.RESOURCE_TYPE_LBCOOKIEPERSISTENCEPROFILE
- LBPersistenceProfile.RESOURCE_TYPE_LBGENERICPERSISTENCEPROFILE
  
  The resource_type property identifies persistence profile type.
tags (list of Tag or None) – Opaque identifiers meaningful to the API user
parent_path (str or None) – Path of its parent This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
path (str or None) – Absolute path of this object This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
relative_path (str or None) – Path relative from its parent This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
children (list of vmware.vapi.struct.VapiStruct or None) – subtree for this type within policy tree containing nested elements. When clients pass a value of this class as a parameter, the attribute must contain all the attributes defined in ChildPolicyConfigResource. When methods return a value of this class as a return value, the attribute will contain all the attributes defined in ChildPolicyConfigResource.
marked_for_delete (bool or None) – Intent objects are not directly deleted from the system when a delete is invoked on them. They are marked for deletion and only when all the realized entities for that intent object gets deleted, the intent object is deleted. Objects that are marked for deletion are not returned in GET call. One can use the search API to get these objects. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
persistence_shared (bool or None) – Persistence shared setting indicates that all LBVirtualServers that consume this LBPersistenceProfile should share the same persistence mechanism when enabled. Meaning, persistence entries of a client accessing one virtual server will also affect the same client’s connections to a different virtual server. For example, say there are two virtual servers vip-ip1:80 and vip-ip1:8080 bound to the same Group g1 consisting of two servers (s11:80 and s12:80). By default, each virtual server will have its own persistence table or cookie. So, in the earlier example, there will be two tables (vip-ip1:80, p1) and (vip-ip1:8080, p1) or cookies. So, if a client connects to vip1:80 and later connects to vip1:8080, the second connection may be sent to a different server than the first. When persistence_shared is enabled, then the second connection will always connect to the same server as the original connection. For COOKIE persistence type, the same cookie will be shared by multiple virtual servers. For SOURCE_IP persistence type, the persistence table will be shared across virtual servers. For GENERIC persistence type, the persistence table will be shared across virtual servers which consume the same persistence profile in LBRule actions.

COOKIE_MODE_INSERT = 'INSERT'¶

COOKIE_MODE_PREFIX = 'PREFIX'¶

COOKIE_MODE_REWRITE = 'REWRITE'¶

property resource_type¶: Return the discriminator value

class com.vmware.nsx_policy.model_client.LBCookieTime(type='LBCookieTime')¶

Bases: vmware.vapi.bindings.struct.VapiStruct

Cookie time.

Tip

The arguments are used to initialize data attributes with the same names.

Parameters

type (str) –

Possible values are:

LBCookieTime.TYPE_LBSESSIONCOOKIETIME
LBCookieTime.TYPE_LBPERSISTENCECOOKIETIME

Both session cookie and persistence cookie are supported, Use LbSessionCookieTime for session cookie time setting, Use LbPersistenceCookieTime for persistence cookie time setting

TYPE_LBPERSISTENCECOOKIETIME = 'LBPersistenceCookieTime'¶

TYPE_LBSESSIONCOOKIETIME = 'LBSessionCookieTime'¶

property type¶: Return the discriminator value

class com.vmware.nsx_policy.model_client.LBFastTcpProfile(close_timeout=None, ha_flow_mirroring_enabled=None, idle_timeout=None, links=None, schema=None, self_=None, revision=None, create_time=None, create_user=None, last_modified_time=None, last_modified_user=None, protection=None, system_owned=None, description=None, display_name=None, id=None, resource_type='LBFastTcpProfile', tags=None, parent_path=None, path=None, relative_path=None, children=None, marked_for_delete=None)¶

Bases: vmware.vapi.bindings.struct.VapiStruct

Fast TCP profile.

Tip

The arguments are used to initialize data attributes with the same names.

Parameters

close_timeout (long or None) – It is used to specify how long a closing TCP connection (both FINs received or a RST is received) should be kept for this application before cleaning up the connection. format: int64
ha_flow_mirroring_enabled (bool or None) – If flow mirroring is enabled, all the flows to the bounded virtual server are mirrored to the standby node.
idle_timeout (long or None) – It is used to configure how long an idle TCP connection in ESTABLISHED state should be kept for this application before cleaning up. format: int64
links (list of ResourceLink or None) – The server will populate this field when returing the resource. Ignored on PUT and POST. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
schema (str or None) – Schema for this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
self (SelfResourceLink or None) – Link to this resource
revision (long or None) – The _revision property describes the current revision of the resource. To prevent clients from overwriting each other’s changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected. format: int32
create_time (long or None) – Timestamp of resource creation format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
create_user (str or None) – ID of the user who created this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
last_modified_time (long or None) – Timestamp of last modification format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
last_modified_user (str or None) – ID of the user who last modified this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
protection (str or None) – Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super user and can modify it, but only when providing the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this entity. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
system_owned (bool or None) – Indicates system owned resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
description (str or None) – Description of this resource
display_name (str or None) – Defaults to ID if not set
id (str or None) – Unique identifier of this resource
resource_type (str) –
Possible values are:
- LBAppProfile.RESOURCE_TYPE_LBHTTPPROFILE
- LBAppProfile.RESOURCE_TYPE_LBFASTTCPPROFILE
- LBAppProfile.RESOURCE_TYPE_LBFASTUDPPROFILE
An application profile can be bound to a virtual server to specify the application protocol characteristics. It is used to influence how load balancing is performed. Currently, three types of application profiles are supported: LBFastTCPProfile, LBFastUDPProfile and LBHttpProfile. LBFastTCPProfile or LBFastUDPProfile is typically used when the application is using a custom protocol or a standard protocol not supported by the load balancer. It is also used in cases where the user only wants L4 load balancing mainly because L4 load balancing has much higher performance and scalability, and/or supports connection mirroring. LBHttpProfile is used for both HTTP and HTTPS applications. Though application rules, if bound to the virtual server, can be used to accomplish the same goal, LBHttpProfile is intended to simplify enabling certain common use cases.
tags (list of Tag or None) – Opaque identifiers meaningful to the API user
parent_path (str or None) – Path of its parent This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
path (str or None) – Absolute path of this object This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
relative_path (str or None) – Path relative from its parent This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
children (list of vmware.vapi.struct.VapiStruct or None) – subtree for this type within policy tree containing nested elements. When clients pass a value of this class as a parameter, the attribute must contain all the attributes defined in ChildPolicyConfigResource. When methods return a value of this class as a return value, the attribute will contain all the attributes defined in ChildPolicyConfigResource.
marked_for_delete (bool or None) – Intent objects are not directly deleted from the system when a delete is invoked on them. They are marked for deletion and only when all the realized entities for that intent object gets deleted, the intent object is deleted. Objects that are marked for deletion are not returned in GET call. One can use the search API to get these objects. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.

property resource_type¶: Return the discriminator value

class com.vmware.nsx_policy.model_client.LBFastUdpProfile(flow_mirroring_enabled=None, idle_timeout=None, links=None, schema=None, self_=None, revision=None, create_time=None, create_user=None, last_modified_time=None, last_modified_user=None, protection=None, system_owned=None, description=None, display_name=None, id=None, resource_type='LBFastUdpProfile', tags=None, parent_path=None, path=None, relative_path=None, children=None, marked_for_delete=None)¶

Bases: vmware.vapi.bindings.struct.VapiStruct

Fast UDP profile.

Tip

The arguments are used to initialize data attributes with the same names.

Parameters

flow_mirroring_enabled (bool or None) – If flow mirroring is enabled, all the flows to the bounded virtual server are mirrored to the standby node.
idle_timeout (long or None) – Though UDP is a connectionless protocol, for the purposes of load balancing, all UDP packets with the same flow signature (source and destination IP/ports and IP protocol) received within the idle timeout period are considered to belong to the same connection and are sent to the same backend server. If no packets are received for idle timeout period, the connection (association between flow signature and the selected server) is cleaned up. format: int64
links (list of ResourceLink or None) – The server will populate this field when returing the resource. Ignored on PUT and POST. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
schema (str or None) – Schema for this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
self (SelfResourceLink or None) – Link to this resource
revision (long or None) – The _revision property describes the current revision of the resource. To prevent clients from overwriting each other’s changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected. format: int32
create_time (long or None) – Timestamp of resource creation format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
create_user (str or None) – ID of the user who created this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
last_modified_time (long or None) – Timestamp of last modification format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
last_modified_user (str or None) – ID of the user who last modified this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
protection (str or None) – Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super user and can modify it, but only when providing the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this entity. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
system_owned (bool or None) – Indicates system owned resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
description (str or None) – Description of this resource
display_name (str or None) – Defaults to ID if not set
id (str or None) – Unique identifier of this resource
resource_type (str) –
Possible values are:
- LBAppProfile.RESOURCE_TYPE_LBHTTPPROFILE
- LBAppProfile.RESOURCE_TYPE_LBFASTTCPPROFILE
- LBAppProfile.RESOURCE_TYPE_LBFASTUDPPROFILE
An application profile can be bound to a virtual server to specify the application protocol characteristics. It is used to influence how load balancing is performed. Currently, three types of application profiles are supported: LBFastTCPProfile, LBFastUDPProfile and LBHttpProfile. LBFastTCPProfile or LBFastUDPProfile is typically used when the application is using a custom protocol or a standard protocol not supported by the load balancer. It is also used in cases where the user only wants L4 load balancing mainly because L4 load balancing has much higher performance and scalability, and/or supports connection mirroring. LBHttpProfile is used for both HTTP and HTTPS applications. Though application rules, if bound to the virtual server, can be used to accomplish the same goal, LBHttpProfile is intended to simplify enabling certain common use cases.
tags (list of Tag or None) – Opaque identifiers meaningful to the API user
parent_path (str or None) – Path of its parent This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
path (str or None) – Absolute path of this object This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
relative_path (str or None) – Path relative from its parent This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
children (list of vmware.vapi.struct.VapiStruct or None) – subtree for this type within policy tree containing nested elements. When clients pass a value of this class as a parameter, the attribute must contain all the attributes defined in ChildPolicyConfigResource. When methods return a value of this class as a return value, the attribute will contain all the attributes defined in ChildPolicyConfigResource.
marked_for_delete (bool or None) – Intent objects are not directly deleted from the system when a delete is invoked on them. They are marked for deletion and only when all the realized entities for that intent object gets deleted, the intent object is deleted. Objects that are marked for deletion are not returned in GET call. One can use the search API to get these objects. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.

property resource_type¶: Return the discriminator value

class com.vmware.nsx_policy.model_client.LBGenericPersistenceProfile(ha_persistence_mirroring_enabled=None, timeout=None, links=None, schema=None, self_=None, revision=None, create_time=None, create_user=None, last_modified_time=None, last_modified_user=None, protection=None, system_owned=None, description=None, display_name=None, id=None, resource_type='LBGenericPersistenceProfile', tags=None, parent_path=None, path=None, relative_path=None, children=None, marked_for_delete=None, persistence_shared=None)¶

Bases: vmware.vapi.bindings.struct.VapiStruct

Some applications maintain state and require all relevant connections to be sent to the same server as the application state is not synchronized among servers. Persistence is enabled on a LBVirtualServer by binding a persistence profile to it. LBGenericPersistenceProfile cannot be attached to virtual server directly, it can be specified in LB rule actions. In HTTP forwarding phase, the profile can be specified in LBVariablePersistenceOnAction. In HTTP response rewriting phase, the profile can be specified in LBVariablePersistenceLearnAction.

Tip

The arguments are used to initialize data attributes with the same names.

Parameters

ha_persistence_mirroring_enabled (bool or None) – The mirroring enabled flag is to synchronize persistence entries. Persistence entries are not synchronized to the HA peer by default.
timeout (long or None) – When all connections complete (reference count reaches 0), persistence entry timer is started with the expiration time. format: int64
links (list of ResourceLink or None) – The server will populate this field when returing the resource. Ignored on PUT and POST. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
schema (str or None) – Schema for this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
self (SelfResourceLink or None) – Link to this resource
revision (long or None) – The _revision property describes the current revision of the resource. To prevent clients from overwriting each other’s changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected. format: int32
create_time (long or None) – Timestamp of resource creation format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
create_user (str or None) – ID of the user who created this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
last_modified_time (long or None) – Timestamp of last modification format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
last_modified_user (str or None) – ID of the user who last modified this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
protection (str or None) – Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super user and can modify it, but only when providing the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this entity. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
system_owned (bool or None) – Indicates system owned resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
description (str or None) – Description of this resource
display_name (str or None) – Defaults to ID if not set
id (str or None) – Unique identifier of this resource
resource_type (str) –
Possible values are:
- LBPersistenceProfile.RESOURCE_TYPE_LBSOURCEIPPERSISTENCEPROFILE
- LBPersistenceProfile.RESOURCE_TYPE_LBCOOKIEPERSISTENCEPROFILE
- LBPersistenceProfile.RESOURCE_TYPE_LBGENERICPERSISTENCEPROFILE
  
  The resource_type property identifies persistence profile type.
tags (list of Tag or None) – Opaque identifiers meaningful to the API user
parent_path (str or None) – Path of its parent This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
path (str or None) – Absolute path of this object This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
relative_path (str or None) – Path relative from its parent This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
children (list of vmware.vapi.struct.VapiStruct or None) – subtree for this type within policy tree containing nested elements. When clients pass a value of this class as a parameter, the attribute must contain all the attributes defined in ChildPolicyConfigResource. When methods return a value of this class as a return value, the attribute will contain all the attributes defined in ChildPolicyConfigResource.
marked_for_delete (bool or None) – Intent objects are not directly deleted from the system when a delete is invoked on them. They are marked for deletion and only when all the realized entities for that intent object gets deleted, the intent object is deleted. Objects that are marked for deletion are not returned in GET call. One can use the search API to get these objects. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
persistence_shared (bool or None) – Persistence shared setting indicates that all LBVirtualServers that consume this LBPersistenceProfile should share the same persistence mechanism when enabled. Meaning, persistence entries of a client accessing one virtual server will also affect the same client’s connections to a different virtual server. For example, say there are two virtual servers vip-ip1:80 and vip-ip1:8080 bound to the same Group g1 consisting of two servers (s11:80 and s12:80). By default, each virtual server will have its own persistence table or cookie. So, in the earlier example, there will be two tables (vip-ip1:80, p1) and (vip-ip1:8080, p1) or cookies. So, if a client connects to vip1:80 and later connects to vip1:8080, the second connection may be sent to a different server than the first. When persistence_shared is enabled, then the second connection will always connect to the same server as the original connection. For COOKIE persistence type, the same cookie will be shared by multiple virtual servers. For SOURCE_IP persistence type, the persistence table will be shared across virtual servers. For GENERIC persistence type, the persistence table will be shared across virtual servers which consume the same persistence profile in LBRule actions.

property resource_type¶: Return the discriminator value

class com.vmware.nsx_policy.model_client.LBHttpMonitorProfile(request_body=None, request_headers=None, request_method=None, request_url=None, request_version=None, response_body=None, response_status_codes=None, fall_count=None, interval=None, monitor_port=None, rise_count=None, timeout=None, links=None, schema=None, self_=None, revision=None, create_time=None, create_user=None, last_modified_time=None, last_modified_user=None, protection=None, system_owned=None, description=None, display_name=None, id=None, resource_type=None, tags=None, parent_path=None, path=None, relative_path=None, children=None, marked_for_delete=None)¶

Bases: vmware.vapi.bindings.struct.VapiStruct

Active healthchecks are disabled by default and can be enabled for a server pool by binding a health monitor to the Group through the LBRule object. This represents active health monitoring over HTTP. Active healthchecks are initiated periodically, at a configurable interval, to each member of the Group. Only if a healthcheck fails consecutively for a specified number of times (fall_count) to a member will the member status be marked DOWN. Once a member is DOWN, a specified number of consecutive successful healthchecks (rise_count) will bring the member back to UP state. After a healthcheck is initiated, if it does not complete within a certain period, then also the healthcheck is considered to be unsuccessful. Completing a healthcheck within timeout means establishing a connection (TCP or SSL), if applicable, sending the request and receiving the response, all within the configured timeout.

Tip

The arguments are used to initialize data attributes with the same names.

Parameters

request_body (str or None) – String to send as part of HTTP health check request body. Valid only for certain HTTP methods like POST.
request_headers (list of LbHttpRequestHeader or None) – Array of HTTP request headers.
request_method (str or None) –
Possible values are:
- LBHttpMonitorProfile.REQUEST_METHOD_GET
- LBHttpMonitorProfile.REQUEST_METHOD_OPTIONS
- LBHttpMonitorProfile.REQUEST_METHOD_POST
- LBHttpMonitorProfile.REQUEST_METHOD_HEAD
- LBHttpMonitorProfile.REQUEST_METHOD_PUT
The health check method for HTTP monitor type.
request_url (str or None) – For HTTP active healthchecks, the HTTP request url sent can be customized and can include query parameters.
request_version (str or None) –
Possible values are:
- LBHttpMonitorProfile.REQUEST_VERSION__1_0
- LBHttpMonitorProfile.REQUEST_VERSION__1_1
- LBHttpMonitorProfile.REQUEST_VERSION__2_0
HTTP request version.
response_body (str or None) – If HTTP response body match string (regular expressions not supported) is specified (using LBHttpMonitor.response_body) then the healthcheck HTTP response body is matched against the specified string and server is considered healthy only if there is a match. If the response body string is not specified, HTTP healthcheck is considered successful if the HTTP response status code is 2xx, but it can be configured to accept other status codes as successful.
response_status_codes (list of long or None) – The HTTP response status code should be a valid HTTP status code. format: int32
fall_count (long or None) – Only if a healthcheck fails consecutively for a specified number of times, given with fall_count, to a member will the member status be marked DOWN. format: int64
interval (long or None) – Active healthchecks are initiated periodically, at a configurable interval (in seconds), to each member of the Group. format: int64
monitor_port (long or None) – Typically, monitors perform healthchecks to Group members using the member IP address and pool_port. However, in some cases, customers prefer to run healthchecks against a different port than the pool member port which handles actual application traffic. In such cases, the port to run healthchecks against can be specified in the monitor_port value. For ICMP monitor, monitor_port is not required. format: int32
rise_count (long or None) – Once a member is DOWN, a specified number of consecutive successful healthchecks specified by rise_count will bring the member back to UP state. format: int64
timeout (long or None) – Timeout specified in seconds. After a healthcheck is initiated, if it does not complete within a certain period, then also the healthcheck is considered to be unsuccessful. Completing a healthcheck within timeout means establishing a connection (TCP or SSL), if applicable, sending the request and receiving the response, all within the configured timeout. format: int64
links (list of ResourceLink or None) – The server will populate this field when returing the resource. Ignored on PUT and POST. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
schema (str or None) – Schema for this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
self (SelfResourceLink or None) – Link to this resource
revision (long or None) – The _revision property describes the current revision of the resource. To prevent clients from overwriting each other’s changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected. format: int32
create_time (long or None) – Timestamp of resource creation format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
create_user (str or None) – ID of the user who created this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
last_modified_time (long or None) – Timestamp of last modification format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
last_modified_user (str or None) – ID of the user who last modified this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
protection (str or None) – Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super user and can modify it, but only when providing the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this entity. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
system_owned (bool or None) – Indicates system owned resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
description (str or None) – Description of this resource
display_name (str or None) – Defaults to ID if not set
id (str or None) – Unique identifier of this resource
resource_type (str) –
Possible values are:
- LBMonitorProfile.RESOURCE_TYPE_LBTCPMONITORPROFILE
- LBMonitorProfile.RESOURCE_TYPE_LBUDPMONITORPROFILE
- LBMonitorProfile.RESOURCE_TYPE_LBICMPMONITORPROFILE
- LBMonitorProfile.RESOURCE_TYPE_LBHTTPMONITORPROFILE
- LBMonitorProfile.RESOURCE_TYPE_LBHTTPSMONITORPROFILE
- LBMonitorProfile.RESOURCE_TYPE_LBPASSIVEMONITORPROFILE
There are two types of healthchecks: active and passive. Passive healthchecks depend on failures in actual client traffic (e.g. RST from server in response to a client connection) to detect that the server or the application is down. In case of active healthchecks, load balancer itself initiates new connections (or sends ICMP ping) to the servers periodically to check their health, completely independent of any data traffic. Currently, active health monitors are supported for HTTP, HTTPS, TCP, UDP and ICMP protocols.
tags (list of Tag or None) – Opaque identifiers meaningful to the API user
parent_path (str or None) – Path of its parent This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
path (str or None) – Absolute path of this object This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
relative_path (str or None) – Path relative from its parent This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
children (list of vmware.vapi.struct.VapiStruct or None) – subtree for this type within policy tree containing nested elements. When clients pass a value of this class as a parameter, the attribute must contain all the attributes defined in ChildPolicyConfigResource. When methods return a value of this class as a return value, the attribute will contain all the attributes defined in ChildPolicyConfigResource.
marked_for_delete (bool or None) – Intent objects are not directly deleted from the system when a delete is invoked on them. They are marked for deletion and only when all the realized entities for that intent object gets deleted, the intent object is deleted. Objects that are marked for deletion are not returned in GET call. One can use the search API to get these objects. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.

REQUEST_METHOD_GET = 'GET'¶

REQUEST_METHOD_HEAD = 'HEAD'¶

REQUEST_METHOD_OPTIONS = 'OPTIONS'¶

REQUEST_METHOD_POST = 'POST'¶

REQUEST_METHOD_PUT = 'PUT'¶

REQUEST_VERSION_1_0 = 'HTTP_VERSION_1_0'¶

REQUEST_VERSION_1_1 = 'HTTP_VERSION_1_1'¶

REQUEST_VERSION_2_0 = 'HTTP_VERSION_2_0'¶

property resource_type¶: Return the discriminator value

class com.vmware.nsx_policy.model_client.LBHttpProfile(http_redirect_to=None, http_redirect_to_https=None, idle_timeout=None, ntlm=None, request_body_size=None, request_header_size=None, response_header_size=None, response_timeout=None, x_forwarded_for=None, links=None, schema=None, self_=None, revision=None, create_time=None, create_user=None, last_modified_time=None, last_modified_user=None, protection=None, system_owned=None, description=None, display_name=None, id=None, resource_type='LBHttpProfile', tags=None, parent_path=None, path=None, relative_path=None, children=None, marked_for_delete=None)¶

Bases: vmware.vapi.bindings.struct.VapiStruct

Http profile.

Tip

The arguments are used to initialize data attributes with the same names.

Parameters

http_redirect_to (str or None) – If a website is temporarily down or has moved, incoming requests for that virtual server can be temporarily redirected to a URL.
http_redirect_to_https (bool or None) – Certain secure applications may want to force communication over SSL, but instead of rejecting non-SSL connections, they may choose to redirect the client automatically to use SSL.
idle_timeout (long or None) – It is used to specify the HTTP application idle timeout, it means that how long the load balancer will keep the connection idle to wait for the client to send the next keep-alive request. It is not a TCP socket setting. format: int64
ntlm (bool or None) – NTLM is an authentication protocol that can be used over HTTP. If the flag is set to true, LB will use NTLM challenge/response methodology.
request_body_size (long or None) – If it is not specified, it means that request body size is unlimited. format: int64
request_header_size (long or None) – A request with header larger than request_header_size will be processed as best effort whereas a request with header below this specified size is guaranteed to be processed. format: int64
response_header_size (long or None) – A response with header larger than response_header_size will be dropped. format: int64
response_timeout (long or None) – If server doesn’t send any packet within this time, the connection is closed. format: int64
x_forwarded_for (str or None) –
Possible values are:
- LBHttpProfile.XFORWARDED_FOR_INSERT
- LBHttpProfile.XFORWARDED_FOR_REPLACE
Insert or replace x_forwarded_for.
links (list of ResourceLink or None) – The server will populate this field when returing the resource. Ignored on PUT and POST. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
schema (str or None) – Schema for this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
self (SelfResourceLink or None) – Link to this resource
revision (long or None) – The _revision property describes the current revision of the resource. To prevent clients from overwriting each other’s changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected. format: int32
create_time (long or None) – Timestamp of resource creation format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
create_user (str or None) – ID of the user who created this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
last_modified_time (long or None) – Timestamp of last modification format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
last_modified_user (str or None) – ID of the user who last modified this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
protection (str or None) – Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super user and can modify it, but only when providing the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this entity. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
system_owned (bool or None) – Indicates system owned resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
description (str or None) – Description of this resource
display_name (str or None) – Defaults to ID if not set
id (str or None) – Unique identifier of this resource
resource_type (str) –
Possible values are:
- LBAppProfile.RESOURCE_TYPE_LBHTTPPROFILE
- LBAppProfile.RESOURCE_TYPE_LBFASTTCPPROFILE
- LBAppProfile.RESOURCE_TYPE_LBFASTUDPPROFILE
An application profile can be bound to a virtual server to specify the application protocol characteristics. It is used to influence how load balancing is performed. Currently, three types of application profiles are supported: LBFastTCPProfile, LBFastUDPProfile and LBHttpProfile. LBFastTCPProfile or LBFastUDPProfile is typically used when the application is using a custom protocol or a standard protocol not supported by the load balancer. It is also used in cases where the user only wants L4 load balancing mainly because L4 load balancing has much higher performance and scalability, and/or supports connection mirroring. LBHttpProfile is used for both HTTP and HTTPS applications. Though application rules, if bound to the virtual server, can be used to accomplish the same goal, LBHttpProfile is intended to simplify enabling certain common use cases.
tags (list of Tag or None) – Opaque identifiers meaningful to the API user
parent_path (str or None) – Path of its parent This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
path (str or None) – Absolute path of this object This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
relative_path (str or None) – Path relative from its parent This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
children (list of vmware.vapi.struct.VapiStruct or None) – subtree for this type within policy tree containing nested elements. When clients pass a value of this class as a parameter, the attribute must contain all the attributes defined in ChildPolicyConfigResource. When methods return a value of this class as a return value, the attribute will contain all the attributes defined in ChildPolicyConfigResource.
marked_for_delete (bool or None) – Intent objects are not directly deleted from the system when a delete is invoked on them. They are marked for deletion and only when all the realized entities for that intent object gets deleted, the intent object is deleted. Objects that are marked for deletion are not returned in GET call. One can use the search API to get these objects. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.

XFORWARDED_FOR_INSERT = 'INSERT'¶

XFORWARDED_FOR_REPLACE = 'REPLACE'¶

property resource_type¶: Return the discriminator value

class com.vmware.nsx_policy.model_client.LBHttpRedirectAction(redirect_status=None, redirect_url=None, type='LBHttpRedirectAction')¶

Bases: vmware.vapi.bindings.struct.VapiStruct

This action is used to redirect HTTP request messages to a new URL. The reply_status value specified in this action is used as the status code of HTTP response message which is sent back to client (Normally a browser). The HTTP status code for redirection is 3xx, for example, 301, 302, 303, 307, etc. The redirect_url is the new URL that the HTTP request message is redirected to. Normally browser will send another HTTP request to the new URL after receiving a redirection response message. Captured variables and built-in variables can be used in redirect_url field. For example, to redirect all HTTP requests to HTTPS requests for a virtual server. We create an LBRule without any conditions, add an LBHttpRedirectAction to the rule. Set the redirect_url field of the LBHttpRedirectAction to: https://$_host$_request_uri And set redirect_status to “302”, which means found. This rule will redirect all HTTP requests to HTTPS server port on the same host.

Tip

The arguments are used to initialize data attributes with the same names.

Parameters

redirect_status (str) – HTTP response status code.
redirect_url (str) – The URL that the HTTP request is redirected to.
type (str) –
Possible values are:
The property identifies the load balancer rule action type.

property type¶: Return the discriminator value

class com.vmware.nsx_policy.model_client.LBHttpRejectAction(reply_message=None, reply_status=None, type='LBHttpRejectAction')¶

Bases: vmware.vapi.bindings.struct.VapiStruct

This action is used to reject HTTP request messages. The specified reply_status value is used as the status code for the corresponding HTTP response message which is sent back to client (Normally a browser) indicating the reason it was rejected. Reference official HTTP status code list for your specific HTTP version to set the reply_status properly. LBHttpRejectAction does not support variables.

Tip

The arguments are used to initialize data attributes with the same names.

Parameters

reply_message (str or None) – Response message.
reply_status (str) – HTTP response status code.
type (str) –
Possible values are:
The property identifies the load balancer rule action type.

property type¶: Return the discriminator value

class com.vmware.nsx_policy.model_client.LBHttpRequestBodyCondition(body_value=None, case_sensitive=None, match_type=None, inverse=None, type='LBHttpRequestBodyCondition')¶

Bases: vmware.vapi.bindings.struct.VapiStruct

This condition is used to match the message body of an HTTP request. Typically, only HTTP POST, PATCH, or PUT requests have request body. The match_type field defines how body_value field is used to match the body of HTTP requests.

Tip

The arguments are used to initialize data attributes with the same names.

Parameters

body_value (str) – HTTP request body
case_sensitive (bool or None) – If true, case is significant when comparing HTTP body value.
match_type (str or None) –
Possible values are:
Match type of HTTP body
inverse (bool or None) – A flag to indicate whether reverse the match result of this condition
type (str) –
Possible values are:
Type of load balancer rule condition

MATCH_TYPE_CONTAINS = 'CONTAINS'¶

MATCH_TYPE_ENDS_WITH = 'ENDS_WITH'¶

MATCH_TYPE_EQUALS = 'EQUALS'¶

MATCH_TYPE_REGEX = 'REGEX'¶

MATCH_TYPE_STARTS_WITH = 'STARTS_WITH'¶

property type¶: Return the discriminator value

class com.vmware.nsx_policy.model_client.LBHttpRequestCookieCondition(case_sensitive=None, cookie_name=None, cookie_value=None, match_type=None, inverse=None, type='LBHttpRequestCookieCondition')¶

Bases: vmware.vapi.bindings.struct.VapiStruct

This condition is used to match HTTP request messages by cookie which is a specific type of HTTP header. The match_type and case_sensitive define how to compare cookie value.

Tip

The arguments are used to initialize data attributes with the same names.

Parameters

case_sensitive (bool or None) – If true, case is significant when comparing cookie value.
cookie_name (str) – Cookie name.
cookie_value (str) – Cookie value.
match_type (str or None) –
Possible values are:
Match type of cookie value.
inverse (bool or None) – A flag to indicate whether reverse the match result of this condition
type (str) –
Possible values are:
Type of load balancer rule condition

MATCH_TYPE_CONTAINS = 'CONTAINS'¶

MATCH_TYPE_ENDS_WITH = 'ENDS_WITH'¶

MATCH_TYPE_EQUALS = 'EQUALS'¶

MATCH_TYPE_REGEX = 'REGEX'¶

MATCH_TYPE_STARTS_WITH = 'STARTS_WITH'¶

property type¶: Return the discriminator value

class com.vmware.nsx_policy.model_client.LBHttpRequestHeaderCondition(case_sensitive=None, header_name=None, header_value=None, match_type=None, inverse=None, type='LBHttpRequestHeaderCondition')¶

Bases: vmware.vapi.bindings.struct.VapiStruct

This condition is used to match HTTP request messages by HTTP header fields. HTTP header fields are components of the header section of HTTP request and response messages. They define the operating parameters of an HTTP transaction. For example, Cookie, Authorization, User-Agent, etc. One condition can be used to match one header field, to match multiple header fields, multiple conditions must be specified. The match_type field defines how header_value field is used to match HTTP requests. The header_name field does not support match types.

Tip

The arguments are used to initialize data attributes with the same names.

Parameters

case_sensitive (bool or None) – If true, case is significant when comparing HTTP header value.
header_name (str or None) – Name of HTTP header
header_value (str) – Value of HTTP header
match_type (str or None) –
Possible values are:
Match type of HTTP header value
inverse (bool or None) – A flag to indicate whether reverse the match result of this condition
type (str) –
Possible values are:
Type of load balancer rule condition

MATCH_TYPE_CONTAINS = 'CONTAINS'¶

MATCH_TYPE_ENDS_WITH = 'ENDS_WITH'¶

MATCH_TYPE_EQUALS = 'EQUALS'¶

MATCH_TYPE_REGEX = 'REGEX'¶

MATCH_TYPE_STARTS_WITH = 'STARTS_WITH'¶

property type¶: Return the discriminator value

class com.vmware.nsx_policy.model_client.LBHttpRequestHeaderDeleteAction(header_name=None, type='LBHttpRequestHeaderDeleteAction')¶

Bases: vmware.vapi.bindings.struct.VapiStruct

This action is used to delete header fields of HTTP request messages at HTTP_REQUEST_REWRITE phase. One action can be used to delete all headers with same header name. To delete headers with different header names, multiple actions must be defined.

Tip

The arguments are used to initialize data attributes with the same names.

Parameters

header_name (str) – Name of a header field of HTTP request message.
type (str) –
Possible values are:
The property identifies the load balancer rule action type.

property type¶: Return the discriminator value

class com.vmware.nsx_policy.model_client.LBHttpRequestHeaderRewriteAction(header_name=None, header_value=None, type='LBHttpRequestHeaderRewriteAction')¶

Bases: vmware.vapi.bindings.struct.VapiStruct

This action is used to rewrite header fields of matched HTTP request messages to specified new values. One action can be used to rewrite one header field. To rewrite multiple header fields, multiple actions must be defined. Captured variables and built-in variables can be used in the header_value field, header_name field does not support variables.

Tip

The arguments are used to initialize data attributes with the same names.

Parameters

header_name (str) – Name of HTTP request header.
header_value (str) – Value of HTTP request header.
type (str) –
Possible values are:
The property identifies the load balancer rule action type.

property type¶: Return the discriminator value

class com.vmware.nsx_policy.model_client.LBHttpRequestMethodCondition(method=None, inverse=None, type='LBHttpRequestMethodCondition')¶

Bases: vmware.vapi.bindings.struct.VapiStruct

This condition is used to match method of HTTP requests. If the method of an HTTP request is same as the method specified in this condition, the HTTP request match this condition. For example, if the method field is set to GET in this condition, any HTTP request with GET method matches the condition.

Tip

The arguments are used to initialize data attributes with the same names.

Parameters

method (str) –
Possible values are:
Type of HTTP request method
inverse (bool or None) – A flag to indicate whether reverse the match result of this condition
type (str) –
Possible values are:
Type of load balancer rule condition

METHOD_GET = 'GET'¶

METHOD_HEAD = 'HEAD'¶

METHOD_OPTIONS = 'OPTIONS'¶

METHOD_POST = 'POST'¶

METHOD_PUT = 'PUT'¶

property type¶: Return the discriminator value

class com.vmware.nsx_policy.model_client.LBHttpRequestUriArgumentsCondition(case_sensitive=None, match_type=None, uri_arguments=None, inverse=None, type='LBHttpRequestUriArgumentsCondition')¶

Bases: vmware.vapi.bindings.struct.VapiStruct

This condition is used to match URI arguments aka query string of Http request messages, for example, in URI http://exaple.com?foo=1&bar=2, the “foo=1&bar=2” is the query string containing URI arguments. In an URI scheme, query string is indicated by the first question mark (“?”) character and terminated by a number sign (“#”) character or by the end of the URI. The uri_arguments field can be specified as a regular expression(Set match_type to REGEX). For example, “foo=(?<x>d+)”. It matches HTTP requests whose URI arguments containing “foo”, the value of foo contains only digits. And the value of foo is captured as $x which can be used in LBRuleAction fields which support variables.

Tip

The arguments are used to initialize data attributes with the same names.

Parameters

case_sensitive (bool or None) – If true, case is significant when comparing URI arguments.
match_type (str or None) –
Possible values are:
Match type of URI arguments
uri_arguments (str) – URI arguments, aka query string of URI.
inverse (bool or None) – A flag to indicate whether reverse the match result of this condition
type (str) –
Possible values are:
Type of load balancer rule condition

MATCH_TYPE_CONTAINS = 'CONTAINS'¶

MATCH_TYPE_ENDS_WITH = 'ENDS_WITH'¶

MATCH_TYPE_EQUALS = 'EQUALS'¶

MATCH_TYPE_REGEX = 'REGEX'¶

MATCH_TYPE_STARTS_WITH = 'STARTS_WITH'¶

property type¶: Return the discriminator value

class com.vmware.nsx_policy.model_client.LBHttpRequestUriCondition(case_sensitive=None, match_type=None, uri=None, inverse=None, type='LBHttpRequestUriCondition')¶

Bases: vmware.vapi.bindings.struct.VapiStruct

This condition is used to match URIs(Uniform Resource Identifier) of HTTP request messages. The URI field can be specified as a regular expression. If an HTTP request message is requesting an URI which matches specified regular expression, it matches the condition. The syntax of whole URI looks like this: scheme:[//[user[:password]\@]host[:port]][/path][?query][#fragment] This condition matches only the path part of entire URI. When match_type field is specified as REGEX, the uri field is used as a regular expression to match URI path of HTTP requests. For example, to match any URI that has “/image/” or “/images/”, uri field can be specified as: “/image[s]?/”. Named capturing groups can be used in the uri field to capture substrings of matched URIs and store them in variables for use in LBRuleAction. For example, specify uri field as: “/news/(?<year>d+)/(?<month>d+)/(?<article>.*)” If the URI path is /articles/news/2017/06/xyz.html, then substring “2017” is captured in variable year, “06” is captured in variable month, and “xyz.html” is captured in variable article. These variables can then be used in an LBRuleAction field which supports variables, such as uri field of LBHttpRequestUriRewriteAction. For example, set the uri field of LBHttpRequestUriRewriteAction as: “/articles/news/$year-$month-$article” Then the URI path /articles/news/2017/06/xyz.html is rewritten to: “/articles/news/2017-06-xyz.html”

Tip

The arguments are used to initialize data attributes with the same names.

Parameters

case_sensitive (bool or None) – If true, case is significant when comparing URI.
match_type (str or None) –
Possible values are:
Match type of URI
uri (str) – A string used to identify resource
inverse (bool or None) – A flag to indicate whether reverse the match result of this condition
type (str) –
Possible values are:
Type of load balancer rule condition

MATCH_TYPE_CONTAINS = 'CONTAINS'¶

MATCH_TYPE_ENDS_WITH = 'ENDS_WITH'¶

MATCH_TYPE_EQUALS = 'EQUALS'¶

MATCH_TYPE_REGEX = 'REGEX'¶

MATCH_TYPE_STARTS_WITH = 'STARTS_WITH'¶

property type¶: Return the discriminator value

class com.vmware.nsx_policy.model_client.LBHttpRequestUriRewriteAction(uri=None, uri_arguments=None, type='LBHttpRequestUriRewriteAction')¶

Bases: vmware.vapi.bindings.struct.VapiStruct

This action is used to rewrite URIs in matched HTTP request messages. Specify the uri and uri_arguments fields in this condition to rewrite the matched HTTP request message’s URI and URI arguments to the new values. Full URI scheme of HTTP messages have following syntax: scheme:[//[user[:password]\@]host[:port]][/path][?query][#fragment] The uri field of this action is used to rewrite the /path part in above scheme. And the uri_arguments field is used to rewrite the query part. Captured variables and built-in variables can be used in the uri and uri_arguments fields. Check the example in LBRuleAction to see how to use variables in this action.

Tip

The arguments are used to initialize data attributes with the same names.

Parameters

uri (str) – URI of HTTP request.
uri_arguments (str or None) – Query string of URI, typically contains key value pairs, for example: foo1=bar1&foo2=bar2.
type (str) –
Possible values are:
The property identifies the load balancer rule action type.

property type¶: Return the discriminator value

class com.vmware.nsx_policy.model_client.LBHttpRequestVersionCondition(version=None, inverse=None, type='LBHttpRequestVersionCondition')¶

Bases: vmware.vapi.bindings.struct.VapiStruct

This condition is used to match the HTTP protocol version of the HTTP request messages.

Tip

The arguments are used to initialize data attributes with the same names.

Parameters

version (str) –
Possible values are:
- LBHttpRequestVersionCondition.VERSION__1_0
- LBHttpRequestVersionCondition.VERSION__1_1
- LBHttpRequestVersionCondition.VERSION__2_0
HTTP version
inverse (bool or None) – A flag to indicate whether reverse the match result of this condition
type (str) –
Possible values are:
Type of load balancer rule condition

VERSION_1_0 = 'HTTP_VERSION_1_0'¶

VERSION_1_1 = 'HTTP_VERSION_1_1'¶

VERSION_2_0 = 'HTTP_VERSION_2_0'¶

property type¶: Return the discriminator value

class com.vmware.nsx_policy.model_client.LBHttpResponseHeaderCondition(case_sensitive=None, header_name=None, header_value=None, match_type=None, inverse=None, type='LBHttpResponseHeaderCondition')¶

Bases: vmware.vapi.bindings.struct.VapiStruct

This condition is used to match HTTP response messages from backend servers by HTTP header fields. HTTP header fields are components of the header section of HTTP request and response messages. They define the operating parameters of an HTTP transaction. For example, Cookie, Authorization, User-Agent, etc. One condition can be used to match one header field, to match multiple header fields, multiple conditions must be specified. The match_type field defines how header_value field is used to match HTTP responses. The header_name field does not support match types.

Tip

The arguments are used to initialize data attributes with the same names.

Parameters

case_sensitive (bool or None) – If true, case is significant when comparing HTTP header value.
header_name (str) – Name of HTTP header field
header_value (str) – Value of HTTP header field
match_type (str or None) –
Possible values are:
Match type of HTTP header value
inverse (bool or None) – A flag to indicate whether reverse the match result of this condition
type (str) –
Possible values are:
Type of load balancer rule condition

MATCH_TYPE_CONTAINS = 'CONTAINS'¶

MATCH_TYPE_ENDS_WITH = 'ENDS_WITH'¶

MATCH_TYPE_EQUALS = 'EQUALS'¶

MATCH_TYPE_REGEX = 'REGEX'¶

MATCH_TYPE_STARTS_WITH = 'STARTS_WITH'¶

property type¶: Return the discriminator value

class com.vmware.nsx_policy.model_client.LBHttpResponseHeaderDeleteAction(header_name=None, type='LBHttpResponseHeaderDeleteAction')¶

Bases: vmware.vapi.bindings.struct.VapiStruct

This action is used to delete header fields of HTTP response messages at HTTP_RESPONSE_REWRITE phase. One action can be used to delete allgi headers with same header name. To delete headers with different header names, multiple actions must be defined.

Tip

The arguments are used to initialize data attributes with the same names.

Parameters

header_name (str) – Name of a header field of HTTP response message.
type (str) –
Possible values are:
The property identifies the load balancer rule action type.

property type¶: Return the discriminator value

class com.vmware.nsx_policy.model_client.LBHttpResponseHeaderRewriteAction(header_name=None, header_value=None, type='LBHttpResponseHeaderRewriteAction')¶

Bases: vmware.vapi.bindings.struct.VapiStruct

This action is used to rewrite header fields of HTTP response messages to specified new values at HTTP_RESPONSE_REWRITE phase. One action can be used to rewrite one header field. To rewrite multiple header fields, multiple actions must be defined. Captured variables and built-in variables can be used in the header_value field, header_name field does not support variables.

Tip

The arguments are used to initialize data attributes with the same names.

Parameters

header_name (str) – Name of a header field of HTTP request message.
header_value (str) – Value of header field
type (str) –
Possible values are:
The property identifies the load balancer rule action type.

property type¶: Return the discriminator value

class com.vmware.nsx_policy.model_client.LBHttpSslCondition(client_certificate_issuer_dn=None, client_certificate_subject_dn=None, client_supported_ssl_ciphers=None, session_reused=None, used_protocol=None, used_ssl_cipher=None, inverse=None, type='LBHttpSslCondition')¶

Bases: vmware.vapi.bindings.struct.VapiStruct

This condition is used to match SSL handshake and SSL connection at all phases.If multiple properties are configured, the rule is considered a match when all the configured properties are matched.

Tip

The arguments are used to initialize data attributes with the same names.

Parameters

client_certificate_issuer_dn (LBClientCertificateIssuerDnCondition or None) – The issuer DN match condition of the client certificate for an established SSL connection.
client_certificate_subject_dn (LBClientCertificateSubjectDnCondition or None) – The subject DN match condition of the client certificate for an established SSL connection.
client_supported_ssl_ciphers (list of str or None) –
Possible values are:
session_reused (str or None) –
Possible values are:
The type of SSL session reused.
used_protocol (str or None) –
Possible values are:
Protocol of an established SSL connection.
used_ssl_cipher (str or None) –
Possible values are:
inverse (bool or None) – A flag to indicate whether reverse the match result of this condition
type (str) –
Possible values are:
Type of load balancer rule condition

CLIENT_SUPPORTED_SSL_CIPHERS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA = 'TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA'¶

CLIENT_SUPPORTED_SSL_CIPHERS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA256 = 'TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA256'¶

CLIENT_SUPPORTED_SSL_CIPHERS_ECDHE_ECDSA_WITH_AES_128_GCM_SHA256 = 'TLS_ECDHE_ECDSA_WITH_AES_128_GCM_SHA256'¶

CLIENT_SUPPORTED_SSL_CIPHERS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA = 'TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA'¶

CLIENT_SUPPORTED_SSL_CIPHERS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA384 = 'TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA384'¶

CLIENT_SUPPORTED_SSL_CIPHERS_ECDHE_ECDSA_WITH_AES_256_GCM_SHA384 = 'TLS_ECDHE_ECDSA_WITH_AES_256_GCM_SHA384'¶

CLIENT_SUPPORTED_SSL_CIPHERS_ECDHE_RSA_WITH_AES_128_CBC_SHA = 'TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA'¶

CLIENT_SUPPORTED_SSL_CIPHERS_ECDHE_RSA_WITH_AES_128_CBC_SHA256 = 'TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA256'¶

CLIENT_SUPPORTED_SSL_CIPHERS_ECDHE_RSA_WITH_AES_128_GCM_SHA256 = 'TLS_ECDHE_RSA_WITH_AES_128_GCM_SHA256'¶

CLIENT_SUPPORTED_SSL_CIPHERS_ECDHE_RSA_WITH_AES_256_CBC_SHA = 'TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA'¶

CLIENT_SUPPORTED_SSL_CIPHERS_ECDHE_RSA_WITH_AES_256_CBC_SHA384 = 'TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA384'¶

CLIENT_SUPPORTED_SSL_CIPHERS_ECDHE_RSA_WITH_AES_256_GCM_SHA384 = 'TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384'¶

CLIENT_SUPPORTED_SSL_CIPHERS_ECDH_ECDSA_WITH_AES_128_CBC_SHA = 'TLS_ECDH_ECDSA_WITH_AES_128_CBC_SHA'¶

CLIENT_SUPPORTED_SSL_CIPHERS_ECDH_ECDSA_WITH_AES_128_CBC_SHA256 = 'TLS_ECDH_ECDSA_WITH_AES_128_CBC_SHA256'¶

CLIENT_SUPPORTED_SSL_CIPHERS_ECDH_ECDSA_WITH_AES_128_GCM_SHA256 = 'TLS_ECDH_ECDSA_WITH_AES_128_GCM_SHA256'¶

CLIENT_SUPPORTED_SSL_CIPHERS_ECDH_ECDSA_WITH_AES_256_CBC_SHA = 'TLS_ECDH_ECDSA_WITH_AES_256_CBC_SHA'¶

CLIENT_SUPPORTED_SSL_CIPHERS_ECDH_ECDSA_WITH_AES_256_CBC_SHA384 = 'TLS_ECDH_ECDSA_WITH_AES_256_CBC_SHA384'¶

CLIENT_SUPPORTED_SSL_CIPHERS_ECDH_ECDSA_WITH_AES_256_GCM_SHA384 = 'TLS_ECDH_ECDSA_WITH_AES_256_GCM_SHA384'¶

CLIENT_SUPPORTED_SSL_CIPHERS_ECDH_RSA_WITH_AES_128_CBC_SHA = 'TLS_ECDH_RSA_WITH_AES_128_CBC_SHA'¶

CLIENT_SUPPORTED_SSL_CIPHERS_ECDH_RSA_WITH_AES_128_CBC_SHA256 = 'TLS_ECDH_RSA_WITH_AES_128_CBC_SHA256'¶

CLIENT_SUPPORTED_SSL_CIPHERS_ECDH_RSA_WITH_AES_128_GCM_SHA256 = 'TLS_ECDH_RSA_WITH_AES_128_GCM_SHA256'¶

CLIENT_SUPPORTED_SSL_CIPHERS_ECDH_RSA_WITH_AES_256_CBC_SHA = 'TLS_ECDH_RSA_WITH_AES_256_CBC_SHA'¶

CLIENT_SUPPORTED_SSL_CIPHERS_ECDH_RSA_WITH_AES_256_CBC_SHA384 = 'TLS_ECDH_RSA_WITH_AES_256_CBC_SHA384'¶

CLIENT_SUPPORTED_SSL_CIPHERS_ECDH_RSA_WITH_AES_256_GCM_SHA384 = 'TLS_ECDH_RSA_WITH_AES_256_GCM_SHA384'¶

CLIENT_SUPPORTED_SSL_CIPHERS_RSA_WITH_3DES_EDE_CBC_SHA = 'TLS_RSA_WITH_3DES_EDE_CBC_SHA'¶

CLIENT_SUPPORTED_SSL_CIPHERS_RSA_WITH_AES_128_CBC_SHA = 'TLS_RSA_WITH_AES_128_CBC_SHA'¶

CLIENT_SUPPORTED_SSL_CIPHERS_RSA_WITH_AES_128_CBC_SHA256 = 'TLS_RSA_WITH_AES_128_CBC_SHA256'¶

CLIENT_SUPPORTED_SSL_CIPHERS_RSA_WITH_AES_128_GCM_SHA256 = 'TLS_RSA_WITH_AES_128_GCM_SHA256'¶

CLIENT_SUPPORTED_SSL_CIPHERS_RSA_WITH_AES_256_CBC_SHA = 'TLS_RSA_WITH_AES_256_CBC_SHA'¶

CLIENT_SUPPORTED_SSL_CIPHERS_RSA_WITH_AES_256_CBC_SHA256 = 'TLS_RSA_WITH_AES_256_CBC_SHA256'¶

CLIENT_SUPPORTED_SSL_CIPHERS_RSA_WITH_AES_256_GCM_SHA384 = 'TLS_RSA_WITH_AES_256_GCM_SHA384'¶

SESSION_REUSED_IGNORE = 'IGNORE'¶

SESSION_REUSED_NEW = 'NEW'¶

SESSION_REUSED_REUSED = 'REUSED'¶

USED_PROTOCOL_SSL_V2 = 'SSL_V2'¶

USED_PROTOCOL_SSL_V3 = 'SSL_V3'¶

USED_PROTOCOL_TLS_V1 = 'TLS_V1'¶

USED_PROTOCOL_TLS_V1_1 = 'TLS_V1_1'¶

USED_PROTOCOL_TLS_V1_2 = 'TLS_V1_2'¶

USED_SSL_CIPHER_ECDHE_ECDSA_WITH_AES_128_CBC_SHA = 'TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA'¶

USED_SSL_CIPHER_ECDHE_ECDSA_WITH_AES_128_CBC_SHA256 = 'TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA256'¶

USED_SSL_CIPHER_ECDHE_ECDSA_WITH_AES_128_GCM_SHA256 = 'TLS_ECDHE_ECDSA_WITH_AES_128_GCM_SHA256'¶

USED_SSL_CIPHER_ECDHE_ECDSA_WITH_AES_256_CBC_SHA = 'TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA'¶

USED_SSL_CIPHER_ECDHE_ECDSA_WITH_AES_256_CBC_SHA384 = 'TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA384'¶

USED_SSL_CIPHER_ECDHE_ECDSA_WITH_AES_256_GCM_SHA384 = 'TLS_ECDHE_ECDSA_WITH_AES_256_GCM_SHA384'¶

USED_SSL_CIPHER_ECDHE_RSA_WITH_AES_128_CBC_SHA = 'TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA'¶

USED_SSL_CIPHER_ECDHE_RSA_WITH_AES_128_CBC_SHA256 = 'TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA256'¶

USED_SSL_CIPHER_ECDHE_RSA_WITH_AES_128_GCM_SHA256 = 'TLS_ECDHE_RSA_WITH_AES_128_GCM_SHA256'¶

USED_SSL_CIPHER_ECDHE_RSA_WITH_AES_256_CBC_SHA = 'TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA'¶

USED_SSL_CIPHER_ECDHE_RSA_WITH_AES_256_CBC_SHA384 = 'TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA384'¶

USED_SSL_CIPHER_ECDHE_RSA_WITH_AES_256_GCM_SHA384 = 'TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384'¶

USED_SSL_CIPHER_ECDH_ECDSA_WITH_AES_128_CBC_SHA = 'TLS_ECDH_ECDSA_WITH_AES_128_CBC_SHA'¶

USED_SSL_CIPHER_ECDH_ECDSA_WITH_AES_128_CBC_SHA256 = 'TLS_ECDH_ECDSA_WITH_AES_128_CBC_SHA256'¶

USED_SSL_CIPHER_ECDH_ECDSA_WITH_AES_128_GCM_SHA256 = 'TLS_ECDH_ECDSA_WITH_AES_128_GCM_SHA256'¶

USED_SSL_CIPHER_ECDH_ECDSA_WITH_AES_256_CBC_SHA = 'TLS_ECDH_ECDSA_WITH_AES_256_CBC_SHA'¶

USED_SSL_CIPHER_ECDH_ECDSA_WITH_AES_256_CBC_SHA384 = 'TLS_ECDH_ECDSA_WITH_AES_256_CBC_SHA384'¶

USED_SSL_CIPHER_ECDH_ECDSA_WITH_AES_256_GCM_SHA384 = 'TLS_ECDH_ECDSA_WITH_AES_256_GCM_SHA384'¶

USED_SSL_CIPHER_ECDH_RSA_WITH_AES_128_CBC_SHA = 'TLS_ECDH_RSA_WITH_AES_128_CBC_SHA'¶

USED_SSL_CIPHER_ECDH_RSA_WITH_AES_128_CBC_SHA256 = 'TLS_ECDH_RSA_WITH_AES_128_CBC_SHA256'¶

USED_SSL_CIPHER_ECDH_RSA_WITH_AES_128_GCM_SHA256 = 'TLS_ECDH_RSA_WITH_AES_128_GCM_SHA256'¶

USED_SSL_CIPHER_ECDH_RSA_WITH_AES_256_CBC_SHA = 'TLS_ECDH_RSA_WITH_AES_256_CBC_SHA'¶

USED_SSL_CIPHER_ECDH_RSA_WITH_AES_256_CBC_SHA384 = 'TLS_ECDH_RSA_WITH_AES_256_CBC_SHA384'¶

USED_SSL_CIPHER_ECDH_RSA_WITH_AES_256_GCM_SHA384 = 'TLS_ECDH_RSA_WITH_AES_256_GCM_SHA384'¶

USED_SSL_CIPHER_RSA_WITH_3DES_EDE_CBC_SHA = 'TLS_RSA_WITH_3DES_EDE_CBC_SHA'¶

USED_SSL_CIPHER_RSA_WITH_AES_128_CBC_SHA = 'TLS_RSA_WITH_AES_128_CBC_SHA'¶

USED_SSL_CIPHER_RSA_WITH_AES_128_CBC_SHA256 = 'TLS_RSA_WITH_AES_128_CBC_SHA256'¶

USED_SSL_CIPHER_RSA_WITH_AES_128_GCM_SHA256 = 'TLS_RSA_WITH_AES_128_GCM_SHA256'¶

USED_SSL_CIPHER_RSA_WITH_AES_256_CBC_SHA = 'TLS_RSA_WITH_AES_256_CBC_SHA'¶

USED_SSL_CIPHER_RSA_WITH_AES_256_CBC_SHA256 = 'TLS_RSA_WITH_AES_256_CBC_SHA256'¶

USED_SSL_CIPHER_RSA_WITH_AES_256_GCM_SHA384 = 'TLS_RSA_WITH_AES_256_GCM_SHA384'¶

property type¶: Return the discriminator value

class com.vmware.nsx_policy.model_client.LBHttpsMonitorProfile(request_body=None, request_headers=None, request_method=None, request_url=None, request_version=None, response_body=None, response_status_codes=None, server_ssl_profile_binding=None, fall_count=None, interval=None, monitor_port=None, rise_count=None, timeout=None, links=None, schema=None, self_=None, revision=None, create_time=None, create_user=None, last_modified_time=None, last_modified_user=None, protection=None, system_owned=None, description=None, display_name=None, id=None, resource_type=None, tags=None, parent_path=None, path=None, relative_path=None, children=None, marked_for_delete=None)¶

Bases: vmware.vapi.bindings.struct.VapiStruct

Active healthchecks are disabled by default and can be enabled for a server pool by binding a health monitor to the Group through the LBRule object. This represents active health monitoring over HTTPS. Active healthchecks are initiated periodically, at a configurable interval, to each member of the Group. Only if a healthcheck fails consecutively for a specified number of times (fall_count) to a member will the member status be marked DOWN. Once a member is DOWN, a specified number of consecutive successful healthchecks (rise_count) will bring the member back to UP state. After a healthcheck is initiated, if it does not complete within a certain period, then also the healthcheck is considered to be unsuccessful. Completing a healthcheck within timeout means establishing a connection (TCP or SSL), if applicable, sending the request and receiving the response, all within the configured timeout.

Tip

The arguments are used to initialize data attributes with the same names.

Parameters

request_body (str or None) – String to send as part of HTTP health check request body. Valid only for certain HTTP methods like POST.
request_headers (list of LbHttpRequestHeader or None) – Array of HTTP request headers.
request_method (str or None) –
Possible values are:
- LBHttpsMonitorProfile.REQUEST_METHOD_GET
- LBHttpsMonitorProfile.REQUEST_METHOD_OPTIONS
- LBHttpsMonitorProfile.REQUEST_METHOD_POST
- LBHttpsMonitorProfile.REQUEST_METHOD_HEAD
- LBHttpsMonitorProfile.REQUEST_METHOD_PUT
The health check method for HTTP monitor type.
request_url (str or None) – For HTTPS active healthchecks, the HTTPS request url sent can be customized and can include query parameters.
request_version (str or None) –
Possible values are:
- LBHttpsMonitorProfile.REQUEST_VERSION__1_0
- LBHttpsMonitorProfile.REQUEST_VERSION__1_1
- LBHttpsMonitorProfile.REQUEST_VERSION__2_0
HTTP request version.
response_body (str or None) – If HTTP response body match string (regular expressions not supported) is specified (using LBHttpMonitor.response_body) then the healthcheck HTTP response body is matched against the specified string and server is considered healthy only if there is a match. If the response body string is not specified, HTTP healthcheck is considered successful if the HTTP response status code is 2xx, but it can be configured to accept other status codes as successful.
response_status_codes (list of long or None) – The HTTP response status code should be a valid HTTP status code. format: int32
server_ssl_profile_binding (LBServerSslProfileBinding or None) – The setting is used when the monitor acts as an SSL client and establishing a connection to the backend server.
fall_count (long or None) – Only if a healthcheck fails consecutively for a specified number of times, given with fall_count, to a member will the member status be marked DOWN. format: int64
interval (long or None) – Active healthchecks are initiated periodically, at a configurable interval (in seconds), to each member of the Group. format: int64
monitor_port (long or None) – Typically, monitors perform healthchecks to Group members using the member IP address and pool_port. However, in some cases, customers prefer to run healthchecks against a different port than the pool member port which handles actual application traffic. In such cases, the port to run healthchecks against can be specified in the monitor_port value. For ICMP monitor, monitor_port is not required. format: int32
rise_count (long or None) – Once a member is DOWN, a specified number of consecutive successful healthchecks specified by rise_count will bring the member back to UP state. format: int64
timeout (long or None) – Timeout specified in seconds. After a healthcheck is initiated, if it does not complete within a certain period, then also the healthcheck is considered to be unsuccessful. Completing a healthcheck within timeout means establishing a connection (TCP or SSL), if applicable, sending the request and receiving the response, all within the configured timeout. format: int64
links (list of ResourceLink or None) – The server will populate this field when returing the resource. Ignored on PUT and POST. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
schema (str or None) – Schema for this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
self (SelfResourceLink or None) – Link to this resource
revision (long or None) – The _revision property describes the current revision of the resource. To prevent clients from overwriting each other’s changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected. format: int32
create_time (long or None) – Timestamp of resource creation format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
create_user (str or None) – ID of the user who created this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
last_modified_time (long or None) – Timestamp of last modification format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
last_modified_user (str or None) – ID of the user who last modified this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
protection (str or None) – Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super user and can modify it, but only when providing the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this entity. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
system_owned (bool or None) – Indicates system owned resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
description (str or None) – Description of this resource
display_name (str or None) – Defaults to ID if not set
id (str or None) – Unique identifier of this resource
resource_type (str) –
Possible values are:
- LBMonitorProfile.RESOURCE_TYPE_LBTCPMONITORPROFILE
- LBMonitorProfile.RESOURCE_TYPE_LBUDPMONITORPROFILE
- LBMonitorProfile.RESOURCE_TYPE_LBICMPMONITORPROFILE
- LBMonitorProfile.RESOURCE_TYPE_LBHTTPMONITORPROFILE
- LBMonitorProfile.RESOURCE_TYPE_LBHTTPSMONITORPROFILE
- LBMonitorProfile.RESOURCE_TYPE_LBPASSIVEMONITORPROFILE
There are two types of healthchecks: active and passive. Passive healthchecks depend on failures in actual client traffic (e.g. RST from server in response to a client connection) to detect that the server or the application is down. In case of active healthchecks, load balancer itself initiates new connections (or sends ICMP ping) to the servers periodically to check their health, completely independent of any data traffic. Currently, active health monitors are supported for HTTP, HTTPS, TCP, UDP and ICMP protocols.
tags (list of Tag or None) – Opaque identifiers meaningful to the API user
parent_path (str or None) – Path of its parent This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
path (str or None) – Absolute path of this object This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
relative_path (str or None) – Path relative from its parent This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
children (list of vmware.vapi.struct.VapiStruct or None) – subtree for this type within policy tree containing nested elements. When clients pass a value of this class as a parameter, the attribute must contain all the attributes defined in ChildPolicyConfigResource. When methods return a value of this class as a return value, the attribute will contain all the attributes defined in ChildPolicyConfigResource.
marked_for_delete (bool or None) – Intent objects are not directly deleted from the system when a delete is invoked on them. They are marked for deletion and only when all the realized entities for that intent object gets deleted, the intent object is deleted. Objects that are marked for deletion are not returned in GET call. One can use the search API to get these objects. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.

REQUEST_METHOD_GET = 'GET'¶

REQUEST_METHOD_HEAD = 'HEAD'¶

REQUEST_METHOD_OPTIONS = 'OPTIONS'¶

REQUEST_METHOD_POST = 'POST'¶

REQUEST_METHOD_PUT = 'PUT'¶

REQUEST_VERSION_1_0 = 'HTTP_VERSION_1_0'¶

REQUEST_VERSION_1_1 = 'HTTP_VERSION_1_1'¶

REQUEST_VERSION_2_0 = 'HTTP_VERSION_2_0'¶

property resource_type¶: Return the discriminator value

class com.vmware.nsx_policy.model_client.LBIcmpMonitorProfile(data_length=None, fall_count=None, interval=None, monitor_port=None, rise_count=None, timeout=None, links=None, schema=None, self_=None, revision=None, create_time=None, create_user=None, last_modified_time=None, last_modified_user=None, protection=None, system_owned=None, description=None, display_name=None, id=None, resource_type=None, tags=None, parent_path=None, path=None, relative_path=None, children=None, marked_for_delete=None)¶

Bases: vmware.vapi.bindings.struct.VapiStruct

Active healthchecks are disabled by default and can be enabled for a server pool by binding a health monitor to the Group through the LBRule object. This represents active health monitoring over ICMP. Active healthchecks are initiated periodically, at a configurable interval, to each member of the Group. Only if a healthcheck fails consecutively for a specified number of times (fall_count) to a member will the member status be marked DOWN. Once a member is DOWN, a specified number of consecutive successful healt hchecks (rise_count) will bring the member back to UP state. After a healthcheck is initiated, if it does not complete within a certain period, then also the healthcheck is considered to be unsuccessful. Completing a healthcheck within timeout means establishing a connection (TCP or SSL), if applicable, sending the request and receiving the response, all within the configured timeout.

Tip

The arguments are used to initialize data attributes with the same names.

Parameters

data_length (long or None) – The data size (in byte) of the ICMP healthcheck packet format: int64
fall_count (long or None) – Only if a healthcheck fails consecutively for a specified number of times, given with fall_count, to a member will the member status be marked DOWN. format: int64
interval (long or None) – Active healthchecks are initiated periodically, at a configurable interval (in seconds), to each member of the Group. format: int64
monitor_port (long or None) – Typically, monitors perform healthchecks to Group members using the member IP address and pool_port. However, in some cases, customers prefer to run healthchecks against a different port than the pool member port which handles actual application traffic. In such cases, the port to run healthchecks against can be specified in the monitor_port value. For ICMP monitor, monitor_port is not required. format: int32
rise_count (long or None) – Once a member is DOWN, a specified number of consecutive successful healthchecks specified by rise_count will bring the member back to UP state. format: int64
timeout (long or None) – Timeout specified in seconds. After a healthcheck is initiated, if it does not complete within a certain period, then also the healthcheck is considered to be unsuccessful. Completing a healthcheck within timeout means establishing a connection (TCP or SSL), if applicable, sending the request and receiving the response, all within the configured timeout. format: int64
links (list of ResourceLink or None) – The server will populate this field when returing the resource. Ignored on PUT and POST. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
schema (str or None) – Schema for this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
self (SelfResourceLink or None) – Link to this resource
revision (long or None) – The _revision property describes the current revision of the resource. To prevent clients from overwriting each other’s changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected. format: int32
create_time (long or None) – Timestamp of resource creation format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
create_user (str or None) – ID of the user who created this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
last_modified_time (long or None) – Timestamp of last modification format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
last_modified_user (str or None) – ID of the user who last modified this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
protection (str or None) – Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super user and can modify it, but only when providing the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this entity. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
system_owned (bool or None) – Indicates system owned resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
description (str or None) – Description of this resource
display_name (str or None) – Defaults to ID if not set
id (str or None) – Unique identifier of this resource
resource_type (str) –
Possible values are:
- LBMonitorProfile.RESOURCE_TYPE_LBTCPMONITORPROFILE
- LBMonitorProfile.RESOURCE_TYPE_LBUDPMONITORPROFILE
- LBMonitorProfile.RESOURCE_TYPE_LBICMPMONITORPROFILE
- LBMonitorProfile.RESOURCE_TYPE_LBHTTPMONITORPROFILE
- LBMonitorProfile.RESOURCE_TYPE_LBHTTPSMONITORPROFILE
- LBMonitorProfile.RESOURCE_TYPE_LBPASSIVEMONITORPROFILE
There are two types of healthchecks: active and passive. Passive healthchecks depend on failures in actual client traffic (e.g. RST from server in response to a client connection) to detect that the server or the application is down. In case of active healthchecks, load balancer itself initiates new connections (or sends ICMP ping) to the servers periodically to check their health, completely independent of any data traffic. Currently, active health monitors are supported for HTTP, HTTPS, TCP, UDP and ICMP protocols.
tags (list of Tag or None) – Opaque identifiers meaningful to the API user
parent_path (str or None) – Path of its parent This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
path (str or None) – Absolute path of this object This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
relative_path (str or None) – Path relative from its parent This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
children (list of vmware.vapi.struct.VapiStruct or None) – subtree for this type within policy tree containing nested elements. When clients pass a value of this class as a parameter, the attribute must contain all the attributes defined in ChildPolicyConfigResource. When methods return a value of this class as a return value, the attribute will contain all the attributes defined in ChildPolicyConfigResource.
marked_for_delete (bool or None) – Intent objects are not directly deleted from the system when a delete is invoked on them. They are marked for deletion and only when all the realized entities for that intent object gets deleted, the intent object is deleted. Objects that are marked for deletion are not returned in GET call. One can use the search API to get these objects. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.

property resource_type¶: Return the discriminator value

class com.vmware.nsx_policy.model_client.LBIpHeaderCondition(source_address=None, inverse=None, type='LBIpHeaderCondition')¶

Bases: vmware.vapi.bindings.struct.VapiStruct

This condition is used to match IP header fields of HTTP messages. Currently, only the source IP address is supported. IP addresses can be expressed as a single IP address like 10.1.1.1, or a range of IP addresses like 10.1.1.101-10.1.1.160. Both IPv4 and IPv6 addresses are supported.

Tip

The arguments are used to initialize data attributes with the same names.

Parameters

source_address (str) – Source IP address of HTTP message format: address-or-block-or-range
inverse (bool or None) – A flag to indicate whether reverse the match result of this condition
type (str) –
Possible values are:
Type of load balancer rule condition

property type¶: Return the discriminator value

class com.vmware.nsx_policy.model_client.LBMonitorProfile(links=None, schema=None, self_=None, revision=None, create_time=None, create_user=None, last_modified_time=None, last_modified_user=None, protection=None, system_owned=None, description=None, display_name=None, id=None, resource_type='LBMonitorProfile', tags=None, parent_path=None, path=None, relative_path=None, children=None, marked_for_delete=None)¶

Bases: vmware.vapi.bindings.struct.VapiStruct

Tip

The arguments are used to initialize data attributes with the same names.

Parameters

links (list of ResourceLink or None) – The server will populate this field when returing the resource. Ignored on PUT and POST. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
schema (str or None) – Schema for this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
self (SelfResourceLink or None) – Link to this resource
revision (long or None) – The _revision property describes the current revision of the resource. To prevent clients from overwriting each other’s changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected. format: int32
create_time (long or None) – Timestamp of resource creation format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
create_user (str or None) – ID of the user who created this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
last_modified_time (long or None) – Timestamp of last modification format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
last_modified_user (str or None) – ID of the user who last modified this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
protection (str or None) – Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super user and can modify it, but only when providing the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this entity. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
system_owned (bool or None) – Indicates system owned resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
description (str or None) – Description of this resource
display_name (str or None) – Defaults to ID if not set
id (str or None) – Unique identifier of this resource
resource_type (str) –
Possible values are:
- LBMonitorProfile.RESOURCE_TYPE_LBTCPMONITORPROFILE
- LBMonitorProfile.RESOURCE_TYPE_LBUDPMONITORPROFILE
- LBMonitorProfile.RESOURCE_TYPE_LBICMPMONITORPROFILE
- LBMonitorProfile.RESOURCE_TYPE_LBHTTPMONITORPROFILE
- LBMonitorProfile.RESOURCE_TYPE_LBHTTPSMONITORPROFILE
- LBMonitorProfile.RESOURCE_TYPE_LBPASSIVEMONITORPROFILE
There are two types of healthchecks: active and passive. Passive healthchecks depend on failures in actual client traffic (e.g. RST from server in response to a client connection) to detect that the server or the application is down. In case of active healthchecks, load balancer itself initiates new connections (or sends ICMP ping) to the servers periodically to check their health, completely independent of any data traffic. Currently, active health monitors are supported for HTTP, HTTPS, TCP, UDP and ICMP protocols.
tags (list of Tag or None) – Opaque identifiers meaningful to the API user
parent_path (str or None) – Path of its parent This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
path (str or None) – Absolute path of this object This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
relative_path (str or None) – Path relative from its parent This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
children (list of vmware.vapi.struct.VapiStruct or None) – subtree for this type within policy tree containing nested elements. When clients pass a value of this class as a parameter, the attribute must contain all the attributes defined in ChildPolicyConfigResource. When methods return a value of this class as a return value, the attribute will contain all the attributes defined in ChildPolicyConfigResource.
marked_for_delete (bool or None) – Intent objects are not directly deleted from the system when a delete is invoked on them. They are marked for deletion and only when all the realized entities for that intent object gets deleted, the intent object is deleted. Objects that are marked for deletion are not returned in GET call. One can use the search API to get these objects. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.

RESOURCE_TYPE_LBHTTPMONITORPROFILE = 'LBHttpMonitorProfile'¶

RESOURCE_TYPE_LBHTTPSMONITORPROFILE = 'LBHttpsMonitorProfile'¶

RESOURCE_TYPE_LBICMPMONITORPROFILE = 'LBIcmpMonitorProfile'¶

RESOURCE_TYPE_LBPASSIVEMONITORPROFILE = 'LBPassiveMonitorProfile'¶

RESOURCE_TYPE_LBTCPMONITORPROFILE = 'LBTcpMonitorProfile'¶

RESOURCE_TYPE_LBUDPMONITORPROFILE = 'LBUdpMonitorProfile'¶

property resource_type¶: Return the discriminator value

class com.vmware.nsx_policy.model_client.LBPassiveMonitorProfile(max_fails=None, timeout=None, links=None, schema=None, self_=None, revision=None, create_time=None, create_user=None, last_modified_time=None, last_modified_user=None, protection=None, system_owned=None, description=None, display_name=None, id=None, resource_type='LBPassiveMonitorProfile', tags=None, parent_path=None, path=None, relative_path=None, children=None, marked_for_delete=None)¶

Bases: vmware.vapi.bindings.struct.VapiStruct

The passive type of LBMonitorProfile.

Tip

The arguments are used to initialize data attributes with the same names.

Parameters

max_fails (long or None) – When the consecutive failures reach this value, then the member is considered temporarily unavailable for a configurable period format: int64
timeout (long or None) – After this timeout period, the member is tried again for a new connection to see if it is available. format: int64
links (list of ResourceLink or None) – The server will populate this field when returing the resource. Ignored on PUT and POST. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
schema (str or None) – Schema for this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
self (SelfResourceLink or None) – Link to this resource
revision (long or None) – The _revision property describes the current revision of the resource. To prevent clients from overwriting each other’s changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected. format: int32
create_time (long or None) – Timestamp of resource creation format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
create_user (str or None) – ID of the user who created this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
last_modified_time (long or None) – Timestamp of last modification format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
last_modified_user (str or None) – ID of the user who last modified this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
protection (str or None) – Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super user and can modify it, but only when providing the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this entity. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
system_owned (bool or None) – Indicates system owned resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
description (str or None) – Description of this resource
display_name (str or None) – Defaults to ID if not set
id (str or None) – Unique identifier of this resource
resource_type (str) –
Possible values are:
- LBMonitorProfile.RESOURCE_TYPE_LBTCPMONITORPROFILE
- LBMonitorProfile.RESOURCE_TYPE_LBUDPMONITORPROFILE
- LBMonitorProfile.RESOURCE_TYPE_LBICMPMONITORPROFILE
- LBMonitorProfile.RESOURCE_TYPE_LBHTTPMONITORPROFILE
- LBMonitorProfile.RESOURCE_TYPE_LBHTTPSMONITORPROFILE
- LBMonitorProfile.RESOURCE_TYPE_LBPASSIVEMONITORPROFILE
There are two types of healthchecks: active and passive. Passive healthchecks depend on failures in actual client traffic (e.g. RST from server in response to a client connection) to detect that the server or the application is down. In case of active healthchecks, load balancer itself initiates new connections (or sends ICMP ping) to the servers periodically to check their health, completely independent of any data traffic. Currently, active health monitors are supported for HTTP, HTTPS, TCP, UDP and ICMP protocols.
tags (list of Tag or None) – Opaque identifiers meaningful to the API user
parent_path (str or None) – Path of its parent This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
path (str or None) – Absolute path of this object This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
relative_path (str or None) – Path relative from its parent This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
children (list of vmware.vapi.struct.VapiStruct or None) – subtree for this type within policy tree containing nested elements. When clients pass a value of this class as a parameter, the attribute must contain all the attributes defined in ChildPolicyConfigResource. When methods return a value of this class as a return value, the attribute will contain all the attributes defined in ChildPolicyConfigResource.
marked_for_delete (bool or None) – Intent objects are not directly deleted from the system when a delete is invoked on them. They are marked for deletion and only when all the realized entities for that intent object gets deleted, the intent object is deleted. Objects that are marked for deletion are not returned in GET call. One can use the search API to get these objects. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.

property resource_type¶: Return the discriminator value

class com.vmware.nsx_policy.model_client.LBPersistenceCookieTime(cookie_max_idle=None, type='LBPersistenceCookieTime')¶

Bases: vmware.vapi.bindings.struct.VapiStruct

Persistence cookie time.

Tip

The arguments are used to initialize data attributes with the same names.

Parameters

cookie_max_idle (long) – HTTP cookie max-age to expire cookie, only available for insert mode. format: int64
type (str) –
Possible values are:
- LBCookieTime.TYPE_LBSESSIONCOOKIETIME
- LBCookieTime.TYPE_LBPERSISTENCECOOKIETIME
Both session cookie and persistence cookie are supported, Use LbSessionCookieTime for session cookie time setting, Use LbPersistenceCookieTime for persistence cookie time setting

property type¶: Return the discriminator value

class com.vmware.nsx_policy.model_client.LBPersistenceProfile(links=None, schema=None, self_=None, revision=None, create_time=None, create_user=None, last_modified_time=None, last_modified_user=None, protection=None, system_owned=None, description=None, display_name=None, id=None, resource_type='LBPersistenceProfile', tags=None, parent_path=None, path=None, relative_path=None, children=None, marked_for_delete=None, persistence_shared=None)¶

Bases: vmware.vapi.bindings.struct.VapiStruct

Some applications maintain state and require all relevant connections to be sent to the same server as the application state is not synchronized among servers. Persistence is enabled on a LBVirtualServer by binding a persistence profile to it. LBGenericPersistenceProfile cannot be attached to LBVirtualServer directly, it can be specified in LBVariablePersistenceOnAction or LBVariablePersistenceLearnAction in LBRule. If a user attaches a LBGenericPersistenceProfile directly to a virtual server, the operation is rejected.

Tip

The arguments are used to initialize data attributes with the same names.

Parameters

links (list of ResourceLink or None) – The server will populate this field when returing the resource. Ignored on PUT and POST. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
schema (str or None) – Schema for this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
self (SelfResourceLink or None) – Link to this resource
revision (long or None) – The _revision property describes the current revision of the resource. To prevent clients from overwriting each other’s changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected. format: int32
create_time (long or None) – Timestamp of resource creation format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
create_user (str or None) – ID of the user who created this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
last_modified_time (long or None) – Timestamp of last modification format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
last_modified_user (str or None) – ID of the user who last modified this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
protection (str or None) – Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super user and can modify it, but only when providing the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this entity. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
system_owned (bool or None) – Indicates system owned resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
description (str or None) – Description of this resource
display_name (str or None) – Defaults to ID if not set
id (str or None) – Unique identifier of this resource
resource_type (str) –
Possible values are:
- LBPersistenceProfile.RESOURCE_TYPE_LBSOURCEIPPERSISTENCEPROFILE
- LBPersistenceProfile.RESOURCE_TYPE_LBCOOKIEPERSISTENCEPROFILE
- LBPersistenceProfile.RESOURCE_TYPE_LBGENERICPERSISTENCEPROFILE
  
  The resource_type property identifies persistence profile type.
tags (list of Tag or None) – Opaque identifiers meaningful to the API user
parent_path (str or None) – Path of its parent This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
path (str or None) – Absolute path of this object This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
relative_path (str or None) – Path relative from its parent This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
children (list of vmware.vapi.struct.VapiStruct or None) – subtree for this type within policy tree containing nested elements. When clients pass a value of this class as a parameter, the attribute must contain all the attributes defined in ChildPolicyConfigResource. When methods return a value of this class as a return value, the attribute will contain all the attributes defined in ChildPolicyConfigResource.
marked_for_delete (bool or None) – Intent objects are not directly deleted from the system when a delete is invoked on them. They are marked for deletion and only when all the realized entities for that intent object gets deleted, the intent object is deleted. Objects that are marked for deletion are not returned in GET call. One can use the search API to get these objects. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
persistence_shared (bool or None) – Persistence shared setting indicates that all LBVirtualServers that consume this LBPersistenceProfile should share the same persistence mechanism when enabled. Meaning, persistence entries of a client accessing one virtual server will also affect the same client’s connections to a different virtual server. For example, say there are two virtual servers vip-ip1:80 and vip-ip1:8080 bound to the same Group g1 consisting of two servers (s11:80 and s12:80). By default, each virtual server will have its own persistence table or cookie. So, in the earlier example, there will be two tables (vip-ip1:80, p1) and (vip-ip1:8080, p1) or cookies. So, if a client connects to vip1:80 and later connects to vip1:8080, the second connection may be sent to a different server than the first. When persistence_shared is enabled, then the second connection will always connect to the same server as the original connection. For COOKIE persistence type, the same cookie will be shared by multiple virtual servers. For SOURCE_IP persistence type, the persistence table will be shared across virtual servers. For GENERIC persistence type, the persistence table will be shared across virtual servers which consume the same persistence profile in LBRule actions.

RESOURCE_TYPE_LBCOOKIEPERSISTENCEPROFILE = 'LBCookiePersistenceProfile'¶

RESOURCE_TYPE_LBGENERICPERSISTENCEPROFILE = 'LBGenericPersistenceProfile'¶

RESOURCE_TYPE_LBSOURCEIPPERSISTENCEPROFILE = 'LBSourceIpPersistenceProfile'¶

property resource_type¶: Return the discriminator value

class com.vmware.nsx_policy.model_client.LBPool(links=None, schema=None, self_=None, revision=None, create_time=None, create_user=None, last_modified_time=None, last_modified_user=None, protection=None, system_owned=None, description=None, display_name=None, id=None, resource_type=None, tags=None, parent_path=None, path=None, relative_path=None, children=None, marked_for_delete=None, active_monitor_paths=None, algorithm=None, member_group=None, members=None, min_active_members=None, passive_monitor_path=None, snat_translation=None, tcp_multiplexing_enabled=None, tcp_multiplexing_number=None)¶

Bases: vmware.vapi.bindings.struct.VapiStruct

Defining access of a Group from a LBVirtualServer and binding to LBMonitorProfile.

Tip

The arguments are used to initialize data attributes with the same names.

Parameters

links (list of ResourceLink or None) – The server will populate this field when returing the resource. Ignored on PUT and POST. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
schema (str or None) – Schema for this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
self (SelfResourceLink or None) – Link to this resource
revision (long or None) – The _revision property describes the current revision of the resource. To prevent clients from overwriting each other’s changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected. format: int32
create_time (long or None) – Timestamp of resource creation format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
create_user (str or None) – ID of the user who created this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
last_modified_time (long or None) – Timestamp of last modification format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
last_modified_user (str or None) – ID of the user who last modified this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
protection (str or None) – Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super user and can modify it, but only when providing the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this entity. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
system_owned (bool or None) – Indicates system owned resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
description (str or None) – Description of this resource
display_name (str or None) – Defaults to ID if not set
id (str or None) – Unique identifier of this resource
resource_type (str or None) – The type of this resource.
tags (list of Tag or None) – Opaque identifiers meaningful to the API user
parent_path (str or None) – Path of its parent This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
path (str or None) – Absolute path of this object This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
relative_path (str or None) – Path relative from its parent This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
children (list of vmware.vapi.struct.VapiStruct or None) – subtree for this type within policy tree containing nested elements. When clients pass a value of this class as a parameter, the attribute must contain all the attributes defined in ChildPolicyConfigResource. When methods return a value of this class as a return value, the attribute will contain all the attributes defined in ChildPolicyConfigResource.
marked_for_delete (bool or None) – Intent objects are not directly deleted from the system when a delete is invoked on them. They are marked for deletion and only when all the realized entities for that intent object gets deleted, the intent object is deleted. Objects that are marked for deletion are not returned in GET call. One can use the search API to get these objects. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
active_monitor_paths (list of str or None) – In case of active healthchecks, load balancer itself initiates new connections (or sends ICMP ping) to the servers periodically to check their health, completely independent of any data traffic. Active healthchecks are disabled by default and can be enabled for a server pool by binding a health monitor to the pool. Currently, only one active health monitor can be configured per server pool.
algorithm (str or None) –
Possible values are:
- LBPool.ALGORITHM_ROUND_ROBIN
- LBPool.ALGORITHM_WEIGHTED_ROUND_ROBIN
- LBPool.ALGORITHM_LEAST_CONNECTION
- LBPool.ALGORITHM_WEIGHTED_LEAST_CONNECTION
- LBPool.ALGORITHM_IP_HASH
Load Balancing algorithm chooses a server for each new connection by going through the list of servers in the pool. Currently, following load balancing algorithms are supported with ROUND_ROBIN as the default. ROUND_ROBIN means that a server is selected in a round-robin fashion. The weight would be ignored even if it is configured. WEIGHTED_ROUND_ROBIN means that a server is selected in a weighted round-robin fashion. Default weight of 1 is used if weight is not configured. LEAST_CONNECTION means that a server is selected when it has the least number of connections. The weight would be ignored even if it is configured. Slow start would be enabled by default. WEIGHTED_LEAST_CONNECTION means that a server is selected in a weighted least connection fashion. Default weight of 1 is used if weight is not configured. Slow start would be enabled by default. IP_HASH means that consistent hash is performed on the source IP address of the incoming connection. This ensures that the same client IP address will always reach the same server as long as no server goes down or up. It may be used on the Internet to provide a best-effort stickiness to clients which refuse session cookies.
member_group (LBPoolMemberGroup or None) – Load balancer pool support grouping object as dynamic pool members. When member group is defined, members setting should not be specified.
members (list of LBPoolMember or None) – Server pool consists of one or more pool members. Each pool member is identified, typically, by an IP address and a port.
min_active_members (long or None) – A pool is considered active if there are at least certain minimum number of members. format: int64
passive_monitor_path (str or None) – Passive healthchecks are disabled by default and can be enabled by attaching a passive health monitor to a server pool. Each time a client connection to a pool member fails, its failed count is incremented. For pools bound to L7 virtual servers, a connection is considered to be failed and failed count is incremented if any TCP connection errors (e.g. TCP RST or failure to send data) or SSL handshake failures occur. For pools bound to L4 virtual servers, if no response is received to a TCP SYN sent to the pool member or if a TCP RST is received in response to a TCP SYN, then the pool member is considered to have failed and the failed count is incremented.
snat_translation (vmware.vapi.struct.VapiStruct or None) – Depending on the topology, Source NAT (SNAT) may be required to ensure traffic from the server destined to the client is received by the load balancer. SNAT can be enabled per pool. If SNAT is not enabled for a pool, then load balancer uses the client IP and port (spoofing) while establishing connections to the servers. This is referred to as no-SNAT or TRANSPARENT mode. By default Source NAT is enabled as LBSnatAutoMap. When clients pass a value of this class as a parameter, the attribute must contain all the attributes defined in LBSnatTranslation. When methods return a value of this class as a return value, the attribute will contain all the attributes defined in LBSnatTranslation.
tcp_multiplexing_enabled (bool or None) – TCP multiplexing allows the same TCP connection between load balancer and the backend server to be used for sending multiple client requests from different client TCP connections.
tcp_multiplexing_number (long or None) – The maximum number of TCP connections per pool that are idly kept alive for sending future client requests. format: int64

ALGORITHM_IP_HASH = 'IP_HASH'¶

ALGORITHM_LEAST_CONNECTION = 'LEAST_CONNECTION'¶

ALGORITHM_ROUND_ROBIN = 'ROUND_ROBIN'¶

ALGORITHM_WEIGHTED_LEAST_CONNECTION = 'WEIGHTED_LEAST_CONNECTION'¶

ALGORITHM_WEIGHTED_ROUND_ROBIN = 'WEIGHTED_ROUND_ROBIN'¶

class com.vmware.nsx_policy.model_client.LBPoolMember(admin_state=None, backup_member=None, display_name=None, ip_address=None, max_concurrent_connections=None, port=None, weight=None)¶

Bases: vmware.vapi.bindings.struct.VapiStruct

Pool member.

Tip

The arguments are used to initialize data attributes with the same names.

Parameters

admin_state (str or None) –
Possible values are:
Member admin state.
backup_member (bool or None) – Backup servers are typically configured with a sorry page indicating to the user that the application is currently unavailable. While the pool is active (a specified minimum number of pool members are active) BACKUP members are skipped during server selection. When the pool is inactive, incoming connections are sent to only the BACKUP member(s).
display_name (str or None) – Pool member name.
ip_address (str) – Pool member IP address. format: ip
max_concurrent_connections (long or None) – To ensure members are not overloaded, connections to a member can be capped by the load balancer. When a member reaches this limit, it is skipped during server selection. If it is not specified, it means that connections are unlimited. format: int64
port (str or None) – If port is specified, all connections will be sent to this port. Only single port is supported. If unset, the same port the client connected to will be used, it could be overrode by default_pool_member_port setting in virtual server. The port should not specified for port range case. format: port-or-range
weight (long or None) – Pool member weight is used for WEIGHTED_ROUND_ROBIN balancing algorithm. The weight value would be ignored in other algorithms. format: int64

ADMIN_STATE_DISABLED = 'DISABLED'¶

ADMIN_STATE_ENABLED = 'ENABLED'¶

ADMIN_STATE_GRACEFUL_DISABLED = 'GRACEFUL_DISABLED'¶

class com.vmware.nsx_policy.model_client.LBPoolMemberGroup(customized_members=None, group_path=None, ip_revision_filter=None, max_ip_list_size=None, port=None)¶

Bases: vmware.vapi.bindings.struct.VapiStruct

Pool member group.

Tip

The arguments are used to initialize data attributes with the same names.

Parameters

customized_members (list of PoolMemberSetting or None) – The list is used to show the customized pool member settings. User can only user pool member action API to update the admin state for a specific IP address.
group_path (str) – Load balancer pool support Group as dynamic pool members. The IP list of the Group would be used as pool member IP setting.
ip_revision_filter (str or None) –
Possible values are:
Ip revision filter is used to filter IPv4 or IPv6 addresses from the grouping object. If the filter is not specified, both IPv4 and IPv6 addresses would be used as server IPs. The link local and loopback addresses would be always filtered out.
max_ip_list_size (long or None) – The size is used to define the maximum number of grouping object IP address list. These IP addresses would be used as pool members. If the grouping object includes more than certain number of IP addresses, the redundant parts would be ignored and those IP addresses would not be treated as pool members. If the size is not specified, one member is budgeted for this dynamic pool so that the pool has at least one member even if some other dynamic pools grow beyond the capacity of load balancer service. Other members are picked according to available dynamic capacity. The unused members would be set to DISABLED so that the load balancer system itself is not overloaded during runtime. format: int64
port (long or None) – If port is specified, all connections will be sent to this port. If unset, the same port the client connected to will be used, it could be overridden by default_pool_member_ports setting in virtual server. The port should not specified for multiple ports case. format: int32

IP_REVISION_FILTER_IPV4 = 'IPV4'¶

IP_REVISION_FILTER_IPV4_IPV6 = 'IPV4_IPV6'¶

IP_REVISION_FILTER_IPV6 = 'IPV6'¶

class com.vmware.nsx_policy.model_client.LBRule(actions=None, display_name=None, match_conditions=None, match_strategy=None, phase=None)¶

Bases: vmware.vapi.bindings.struct.VapiStruct

Binding of a LBPool and Group to a LBVirtualServer used to route application traffic passing through load balancers. LBRule uses match conditions to match application traffic passing through a LBVirtualServer using HTTP or HTTPS. Can bind multiple LBVirtualServers to a Group. Each LBRule consists of two optional match conditions, each match contidion defines a criterion for application traffic. If no match conditions are specified, then the LBRule will always match and it is used typically to define default rules. If more than one match condition is specified, then matching strategy determines if all conditions should match or any one condition should match for the LBRule to be considered a match. A match indicates that the LBVirtualServer should route the request to the Group (parent of LBRule).

Tip

The arguments are used to initialize data attributes with the same names.

Parameters

actions (list of vmware.vapi.struct.VapiStruct) – A list of actions to be executed at specified phase when load balancer rule matches. The actions are used to manipulate application traffic, such as rewrite URI of HTTP messages, redirect HTTP messages, etc. When clients pass a value of this class as a parameter, the attribute must contain all the attributes defined in LBRuleAction. When methods return a value of this class as a return value, the attribute will contain all the attributes defined in LBRuleAction.
display_name (str or None) – A display name useful for identifying an LBRule.
match_conditions (list of vmware.vapi.struct.VapiStruct or None) – A list of match conditions used to match application traffic. Multiple match conditions can be specified in one load balancer rule, each match condition defines a criterion to match application traffic. If no match conditions are specified, then the load balancer rule will always match and it is used typically to define default rules. If more than one match condition is specified, then match strategy determines if all conditions should match or any one condition should match for the load balancer rule to considered a match. When clients pass a value of this class as a parameter, the attribute must contain all the attributes defined in LBRuleCondition. When methods return a value of this class as a return value, the attribute will contain all the attributes defined in LBRuleCondition.
match_strategy (str or None) –
Possible values are:
- LBRule.MATCH_STRATEGY_ALL
- LBRule.MATCH_STRATEGY_ANY
If more than one match condition is specified, then matching strategy determines if all conditions should match or any one condition should match for the LB Rule to be considered a match. - ALL indicates that both host_match and path_match must match for this LBRule to be considered a match. - ANY indicates that either host_match or patch match may match for this LBRule to be considered a match.
phase (str or None) –
Possible values are:
Each load balancer rule is used at a specific phase of load balancer processing. Currently three phases are supported, HTTP_REQUEST_REWRITE, HTTP_FORWARDING and HTTP_RESPONSE_REWRITE. When an HTTP request message is received by load balancer, all HTTP_REQUEST_REWRITE rules, if present are executed in the order they are applied to virtual server. And then if HTTP_FORWARDING rules present, only first matching rule’s action is executed, remaining rules are not checked. HTTP_FORWARDING rules can have only one action. If the request is forwarded to a backend server and the response goes back to load balancer, all HTTP_RESPONSE_REWRITE rules, if present, are executed in the order they are applied to the virtual server.

MATCH_STRATEGY_ALL = 'ALL'¶

MATCH_STRATEGY_ANY = 'ANY'¶

PHASE_FORWARDING = 'HTTP_FORWARDING'¶

PHASE_REQUEST_REWRITE = 'HTTP_REQUEST_REWRITE'¶

PHASE_RESPONSE_REWRITE = 'HTTP_RESPONSE_REWRITE'¶

class com.vmware.nsx_policy.model_client.LBRuleAction(type='LBRuleAction')¶

Bases: vmware.vapi.bindings.struct.VapiStruct

Load balancer rule actions are used to manipulate application traffic. Currently load balancer rules can be used at three load balancer processing phases. Each phase has its own supported type of actions. Supported actions in HTTP_REQUST_REWRITE phase are: LBHttpRequestUriRewriteAction LBHttpRequestHeaderRewriteAction LBHttpRequestHeaderDeleteAction LBVariableAssignmentAction Supported actions in HTTP_FORWARDING phase are: LBHttpRejectAction LBHttpRedirectAction LBSelectPoolAction LBVariablePersistenceOnAction Supported action in HTTP_RESPONSE_REWRITE phase is: LBHttpResponseHeaderRewriteAction LBHttpResponseHeaderDeleteAction LBVariablePersistenceLearnAction If the match type of an LBRuleCondition field is specified as REGEX and named capturing groups are used in the specified regular expression. The groups can be used as variables in LBRuleAction fields. For example, define a rule with LBHttpRequestUriCondition as match condition and LBHttpRequestUriRewriteAction as action. Set match_type field of LBHttpRequestUriCondition to REGEX, and set uri field to “/news/(?<year>d+)/(?<month>d+)/(?<article>.*)”. Set uri field of LBHttpRequestUriRewriteAction to: “/news/$year-$month/$article” In uri field of LBHttpRequestUriCondition, the (?<year>d+), (?<month>d+) and (?<article>.*) are named capturing groups, they define variables named $year, $month and $article respectively. The defined variables are used in LBHttpRequestUriRewriteAction. For a matched HTTP request with URI “/news/2017/06/xyz.html”, the substring “2017” is captured in variable $year, “06” is captured in variable $month, and “xyz.html” is captured in variable $article. The LBHttpRequestUriRewriteAction will rewrite the URI to: “/news/2017-06/xyz.html” A set of built-in variables can be used in LBRuleAction as well. The name of built-in variables start with underscore, the name of user defined variables is not allowed to start with underscore. Following are some of the built-in variables: $_scheme: Reference the scheme part of matched HTTP messages, could be “http” or “https”. $_host: Host of matched HTTP messages, for example “www.example.com”. $_server_port: Port part of URI, it is also the port of the server which accepted a request. Default port is 80 for http and 443 for https. $_uri: The URI path, for example “/products/sample.html”. $_request_uri: Full original request URI with arguments, for example, “/products/sample.html?a=b&c=d”. $_args: URI arguments, for instance “a=b&c=d” $_is_args: “?” if a request has URI arguments, or an empty string otherwise. For the full list of built-in variables, please reference the NSX-T Administrator’s Guide.

Tip

The arguments are used to initialize data attributes with the same names.

Parameters

type (str) –

Possible values are:

LBRuleAction.TYPE_LBSELECTPOOLACTION
LBRuleAction.TYPE_LBHTTPREQUESTURIREWRITEACTION
LBRuleAction.TYPE_LBHTTPREQUESTHEADERREWRITEACTION
LBRuleAction.TYPE_LBHTTPREJECTACTION
LBRuleAction.TYPE_LBHTTPREDIRECTACTION
LBRuleAction.TYPE_LBHTTPRESPONSEHEADERREWRITEACTION
LBRuleAction.TYPE_LBHTTPREQUESTHEADERDELETEACTION
LBRuleAction.TYPE_LBHTTPRESPONSEHEADERDELETEACTION
LBRuleAction.TYPE_LBVARIABLEASSIGNMENTACTION
LBRuleAction.TYPE_LBVARIABLEPERSISTENCEONACTION
LBRuleAction.TYPE_LBVARIABLEPERSISTENCELEARNACTION

The property identifies the load balancer rule action type.

TYPE_LBHTTPREDIRECTACTION = 'LBHttpRedirectAction'¶

TYPE_LBHTTPREJECTACTION = 'LBHttpRejectAction'¶

TYPE_LBHTTPREQUESTHEADERDELETEACTION = 'LBHttpRequestHeaderDeleteAction'¶

TYPE_LBHTTPREQUESTHEADERREWRITEACTION = 'LBHttpRequestHeaderRewriteAction'¶

TYPE_LBHTTPREQUESTURIREWRITEACTION = 'LBHttpRequestUriRewriteAction'¶

TYPE_LBHTTPRESPONSEHEADERDELETEACTION = 'LBHttpResponseHeaderDeleteAction'¶

TYPE_LBHTTPRESPONSEHEADERREWRITEACTION = 'LBHttpResponseHeaderRewriteAction'¶

TYPE_LBSELECTPOOLACTION = 'LBSelectPoolAction'¶

TYPE_LBVARIABLEASSIGNMENTACTION = 'LBVariableAssignmentAction'¶

TYPE_LBVARIABLEPERSISTENCELEARNACTION = 'LBVariablePersistenceLearnAction'¶

TYPE_LBVARIABLEPERSISTENCEONACTION = 'LBVariablePersistenceOnAction'¶

property type¶: Return the discriminator value

class com.vmware.nsx_policy.model_client.LBRuleCondition(inverse=None, type='LBRuleCondition')¶

Bases: vmware.vapi.bindings.struct.VapiStruct

Match conditions are used to match application traffic passing through load balancers. Multiple match conditions can be specified in one load balancer rule, each match condition defines a criterion for application traffic. If inverse field is set to true, the match result of the condition is inverted. If more than one match condition is specified, match strategy determines if all conditions should match or any one condition should match for the load balancer rule to be considered a match. Currently only HTTP messages are supported by load balancer rules. Each load balancer rule is used at a specific phase of load balancer processing. Currently three phases are supported, HTTP_REQUEST_REWRITE, HTTP_FORWARDING and HTTP_RESPONSE_REWRITE. Each phase supports certain types of match conditions, supported match conditions in HTTP_REQUEST_REWRITE phase are: LBHttpRequestMethodCondition LBHttpRequestUriCondition LBHttpRequestUriArgumentsCondition LBHttpRequestVersionCondition LBHttpRequestHeaderCondition LBHttpRequestCookieCondition LBHttpRequestBodyCondition LBTcpHeaderCondition LBIpHeaderCondition LBVariableCondition LBHttpSslCondition Supported match conditions in HTTP_FORWARDING phase are: LBHttpRequestMethodCondition LBHttpRequestUriCondition LBHttpRequestUriArgumentsCondition LBHttpRequestVersionCondition LBHttpRequestHeaderCondition LBHttpRequestCookieCondition LBHttpRequestBodyCondition LBTcpHeaderCondition LBIpHeaderCondition LBVariableCondition LBHttpSslCondition Supported match conditions in HTTP_RESPONSE_REWRITE phase are: LBHttpResponseHeaderCondition LBHttpRequestMethodCondition LBHttpRequestUriCondition LBHttpRequestUriArgumentsCondition LBHttpRequestVersionCondition LBHttpRequestHeaderCondition LBHttpRequestCookieCondition LBTcpHeaderCondition LBIpHeaderCondition LBVariableCondition LBHttpSslCondition

Tip

The arguments are used to initialize data attributes with the same names.

Parameters

inverse (bool or None) – A flag to indicate whether reverse the match result of this condition
type (str) –
Possible values are:
Type of load balancer rule condition

TYPE_LBHTTPREQUESTBODYCONDITION = 'LBHttpRequestBodyCondition'¶

TYPE_LBHTTPREQUESTCOOKIECONDITION = 'LBHttpRequestCookieCondition'¶

TYPE_LBHTTPREQUESTHEADERCONDITION = 'LBHttpRequestHeaderCondition'¶

TYPE_LBHTTPREQUESTMETHODCONDITION = 'LBHttpRequestMethodCondition'¶

TYPE_LBHTTPREQUESTURIARGUMENTSCONDITION = 'LBHttpRequestUriArgumentsCondition'¶

TYPE_LBHTTPREQUESTURICONDITION = 'LBHttpRequestUriCondition'¶

TYPE_LBHTTPREQUESTVERSIONCONDITION = 'LBHttpRequestVersionCondition'¶

TYPE_LBHTTPRESPONSEHEADERCONDITION = 'LBHttpResponseHeaderCondition'¶

TYPE_LBHTTPSSLCONDITION = 'LBHttpSslCondition'¶

TYPE_LBIPHEADERCONDITION = 'LBIpHeaderCondition'¶

TYPE_LBTCPHEADERCONDITION = 'LBTcpHeaderCondition'¶

TYPE_LBVARIABLECONDITION = 'LBVariableCondition'¶

property type¶: Return the discriminator value

class com.vmware.nsx_policy.model_client.LBSelectPoolAction(pool_id=None, type='LBSelectPoolAction')¶

Bases: vmware.vapi.bindings.struct.VapiStruct

This action is used to select a pool for matched HTTP request messages. The pool is specified by path. The matched HTTP request messages are forwarded to the specified pool.

Tip

The arguments are used to initialize data attributes with the same names.

Parameters

pool_id (str) – Path of load balancer pool.
type (str) –
Possible values are:
The property identifies the load balancer rule action type.

property type¶: Return the discriminator value

class com.vmware.nsx_policy.model_client.LBServerSslProfile(links=None, schema=None, self_=None, revision=None, create_time=None, create_user=None, last_modified_time=None, last_modified_user=None, protection=None, system_owned=None, description=None, display_name=None, id=None, resource_type=None, tags=None, parent_path=None, path=None, relative_path=None, children=None, marked_for_delete=None, cipher_group_label=None, ciphers=None, is_fips=None, is_secure=None, protocols=None, session_cache_enabled=None)¶

Bases: vmware.vapi.bindings.struct.VapiStruct

Server SSL profile.

Tip

The arguments are used to initialize data attributes with the same names.

Parameters

links (list of ResourceLink or None) – The server will populate this field when returing the resource. Ignored on PUT and POST. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
schema (str or None) – Schema for this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
self (SelfResourceLink or None) – Link to this resource
revision (long or None) – The _revision property describes the current revision of the resource. To prevent clients from overwriting each other’s changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected. format: int32
create_time (long or None) – Timestamp of resource creation format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
create_user (str or None) – ID of the user who created this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
last_modified_time (long or None) – Timestamp of last modification format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
last_modified_user (str or None) – ID of the user who last modified this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
protection (str or None) – Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super user and can modify it, but only when providing the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this entity. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
system_owned (bool or None) – Indicates system owned resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
description (str or None) – Description of this resource
display_name (str or None) – Defaults to ID if not set
id (str or None) – Unique identifier of this resource
resource_type (str or None) – The type of this resource.
tags (list of Tag or None) – Opaque identifiers meaningful to the API user
parent_path (str or None) – Path of its parent This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
path (str or None) – Absolute path of this object This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
relative_path (str or None) – Path relative from its parent This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
children (list of vmware.vapi.struct.VapiStruct or None) – subtree for this type within policy tree containing nested elements. When clients pass a value of this class as a parameter, the attribute must contain all the attributes defined in ChildPolicyConfigResource. When methods return a value of this class as a return value, the attribute will contain all the attributes defined in ChildPolicyConfigResource.
marked_for_delete (bool or None) – Intent objects are not directly deleted from the system when a delete is invoked on them. They are marked for deletion and only when all the realized entities for that intent object gets deleted, the intent object is deleted. Objects that are marked for deletion are not returned in GET call. One can use the search API to get these objects. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
cipher_group_label (str or None) –
Possible values are:
- LBServerSslProfile.CIPHER_GROUP_LABEL_BALANCED
- LBServerSslProfile.CIPHER_GROUP_LABEL_HIGH_SECURITY
- LBServerSslProfile.CIPHER_GROUP_LABEL_HIGH_COMPATIBILITY
- LBServerSslProfile.CIPHER_GROUP_LABEL_CUSTOM
It is a label of cipher group which is mostly consumed by GUI.
ciphers (list of str or None) –
Possible values are:
- LBServerSslProfile.CIPHERS_ECDHE_RSA_WITH_AES_128_GCM_SHA256
- LBServerSslProfile.CIPHERS_ECDHE_RSA_WITH_AES_256_GCM_SHA384
- LBServerSslProfile.CIPHERS_ECDHE_RSA_WITH_AES_256_CBC_SHA
- LBServerSslProfile.CIPHERS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA
- LBServerSslProfile.CIPHERS_ECDH_ECDSA_WITH_AES_256_CBC_SHA
- LBServerSslProfile.CIPHERS_ECDH_RSA_WITH_AES_256_CBC_SHA
- LBServerSslProfile.CIPHERS_RSA_WITH_AES_256_CBC_SHA
- LBServerSslProfile.CIPHERS_RSA_WITH_AES_128_CBC_SHA
- LBServerSslProfile.CIPHERS_RSA_WITH_3DES_EDE_CBC_SHA
- LBServerSslProfile.CIPHERS_ECDHE_RSA_WITH_AES_128_CBC_SHA
- LBServerSslProfile.CIPHERS_ECDHE_RSA_WITH_AES_128_CBC_SHA256
- LBServerSslProfile.CIPHERS_ECDHE_RSA_WITH_AES_256_CBC_SHA384
- LBServerSslProfile.CIPHERS_RSA_WITH_AES_128_CBC_SHA256
- LBServerSslProfile.CIPHERS_RSA_WITH_AES_128_GCM_SHA256
- LBServerSslProfile.CIPHERS_RSA_WITH_AES_256_CBC_SHA256
- LBServerSslProfile.CIPHERS_RSA_WITH_AES_256_GCM_SHA384
- LBServerSslProfile.CIPHERS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA
- LBServerSslProfile.CIPHERS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA256
- LBServerSslProfile.CIPHERS_ECDHE_ECDSA_WITH_AES_128_GCM_SHA256
- LBServerSslProfile.CIPHERS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA384
- LBServerSslProfile.CIPHERS_ECDHE_ECDSA_WITH_AES_256_GCM_SHA384
- LBServerSslProfile.CIPHERS_ECDH_ECDSA_WITH_AES_128_CBC_SHA
- LBServerSslProfile.CIPHERS_ECDH_ECDSA_WITH_AES_128_CBC_SHA256
- LBServerSslProfile.CIPHERS_ECDH_ECDSA_WITH_AES_128_GCM_SHA256
- LBServerSslProfile.CIPHERS_ECDH_ECDSA_WITH_AES_256_CBC_SHA384
- LBServerSslProfile.CIPHERS_ECDH_ECDSA_WITH_AES_256_GCM_SHA384
- LBServerSslProfile.CIPHERS_ECDH_RSA_WITH_AES_128_CBC_SHA
- LBServerSslProfile.CIPHERS_ECDH_RSA_WITH_AES_128_CBC_SHA256
- LBServerSslProfile.CIPHERS_ECDH_RSA_WITH_AES_128_GCM_SHA256
- LBServerSslProfile.CIPHERS_ECDH_RSA_WITH_AES_256_CBC_SHA384
- LBServerSslProfile.CIPHERS_ECDH_RSA_WITH_AES_256_GCM_SHA384
  
  Supported SSL cipher list to client side.
is_fips (bool or None) – This flag is set to true when all the ciphers and protocols are FIPS compliant. It is set to false when one of the ciphers or protocols are not FIPS compliant. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
is_secure (bool or None) – This flag is set to true when all the ciphers and protocols are secure. It is set to false when one of the ciphers or protocols is insecure. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
protocols (list of str or None) –
Possible values are:
- LBServerSslProfile.PROTOCOLS_SSL_V2
- LBServerSslProfile.PROTOCOLS_SSL_V3
- LBServerSslProfile.PROTOCOLS_TLS_V1
- LBServerSslProfile.PROTOCOLS_TLS_V1_1
- LBServerSslProfile.PROTOCOLS_TLS_V1_2
SSL versions TLS1.1 and TLS1.2 are supported and enabled by default. SSLv2, SSLv3, and TLS1.0 are supported, but disabled by default.
session_cache_enabled (bool or None) – SSL session caching allows SSL client and server to reuse previously negotiated security parameters avoiding the expensive public key operation during handshake.

CIPHERS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA = 'TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA'¶

CIPHERS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA256 = 'TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA256'¶

CIPHERS_ECDHE_ECDSA_WITH_AES_128_GCM_SHA256 = 'TLS_ECDHE_ECDSA_WITH_AES_128_GCM_SHA256'¶

CIPHERS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA = 'TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA'¶

CIPHERS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA384 = 'TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA384'¶

CIPHERS_ECDHE_ECDSA_WITH_AES_256_GCM_SHA384 = 'TLS_ECDHE_ECDSA_WITH_AES_256_GCM_SHA384'¶

CIPHERS_ECDHE_RSA_WITH_AES_128_CBC_SHA = 'TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA'¶

CIPHERS_ECDHE_RSA_WITH_AES_128_CBC_SHA256 = 'TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA256'¶

CIPHERS_ECDHE_RSA_WITH_AES_128_GCM_SHA256 = 'TLS_ECDHE_RSA_WITH_AES_128_GCM_SHA256'¶

CIPHERS_ECDHE_RSA_WITH_AES_256_CBC_SHA = 'TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA'¶

CIPHERS_ECDHE_RSA_WITH_AES_256_CBC_SHA384 = 'TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA384'¶

CIPHERS_ECDHE_RSA_WITH_AES_256_GCM_SHA384 = 'TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384'¶

CIPHERS_ECDH_ECDSA_WITH_AES_128_CBC_SHA = 'TLS_ECDH_ECDSA_WITH_AES_128_CBC_SHA'¶

CIPHERS_ECDH_ECDSA_WITH_AES_128_CBC_SHA256 = 'TLS_ECDH_ECDSA_WITH_AES_128_CBC_SHA256'¶

CIPHERS_ECDH_ECDSA_WITH_AES_128_GCM_SHA256 = 'TLS_ECDH_ECDSA_WITH_AES_128_GCM_SHA256'¶

CIPHERS_ECDH_ECDSA_WITH_AES_256_CBC_SHA = 'TLS_ECDH_ECDSA_WITH_AES_256_CBC_SHA'¶

CIPHERS_ECDH_ECDSA_WITH_AES_256_CBC_SHA384 = 'TLS_ECDH_ECDSA_WITH_AES_256_CBC_SHA384'¶

CIPHERS_ECDH_ECDSA_WITH_AES_256_GCM_SHA384 = 'TLS_ECDH_ECDSA_WITH_AES_256_GCM_SHA384'¶

CIPHERS_ECDH_RSA_WITH_AES_128_CBC_SHA = 'TLS_ECDH_RSA_WITH_AES_128_CBC_SHA'¶

CIPHERS_ECDH_RSA_WITH_AES_128_CBC_SHA256 = 'TLS_ECDH_RSA_WITH_AES_128_CBC_SHA256'¶

CIPHERS_ECDH_RSA_WITH_AES_128_GCM_SHA256 = 'TLS_ECDH_RSA_WITH_AES_128_GCM_SHA256'¶

CIPHERS_ECDH_RSA_WITH_AES_256_CBC_SHA = 'TLS_ECDH_RSA_WITH_AES_256_CBC_SHA'¶

CIPHERS_ECDH_RSA_WITH_AES_256_CBC_SHA384 = 'TLS_ECDH_RSA_WITH_AES_256_CBC_SHA384'¶

CIPHERS_ECDH_RSA_WITH_AES_256_GCM_SHA384 = 'TLS_ECDH_RSA_WITH_AES_256_GCM_SHA384'¶

CIPHERS_RSA_WITH_3DES_EDE_CBC_SHA = 'TLS_RSA_WITH_3DES_EDE_CBC_SHA'¶

CIPHERS_RSA_WITH_AES_128_CBC_SHA = 'TLS_RSA_WITH_AES_128_CBC_SHA'¶

CIPHERS_RSA_WITH_AES_128_CBC_SHA256 = 'TLS_RSA_WITH_AES_128_CBC_SHA256'¶

CIPHERS_RSA_WITH_AES_128_GCM_SHA256 = 'TLS_RSA_WITH_AES_128_GCM_SHA256'¶

CIPHERS_RSA_WITH_AES_256_CBC_SHA = 'TLS_RSA_WITH_AES_256_CBC_SHA'¶

CIPHERS_RSA_WITH_AES_256_CBC_SHA256 = 'TLS_RSA_WITH_AES_256_CBC_SHA256'¶

CIPHERS_RSA_WITH_AES_256_GCM_SHA384 = 'TLS_RSA_WITH_AES_256_GCM_SHA384'¶

CIPHER_GROUP_LABEL_BALANCED = 'BALANCED'¶

CIPHER_GROUP_LABEL_CUSTOM = 'CUSTOM'¶

CIPHER_GROUP_LABEL_HIGH_COMPATIBILITY = 'HIGH_COMPATIBILITY'¶

CIPHER_GROUP_LABEL_HIGH_SECURITY = 'HIGH_SECURITY'¶

PROTOCOLS_SSL_V2 = 'SSL_V2'¶

PROTOCOLS_SSL_V3 = 'SSL_V3'¶

PROTOCOLS_TLS_V1 = 'TLS_V1'¶

PROTOCOLS_TLS_V1_1 = 'TLS_V1_1'¶

PROTOCOLS_TLS_V1_2 = 'TLS_V1_2'¶

class com.vmware.nsx_policy.model_client.LBServerSslProfileBinding(certificate_chain_depth=None, client_certificate_path=None, server_auth=None, server_auth_ca_paths=None, server_auth_crl_paths=None, ssl_profile_path=None)¶

Bases: vmware.vapi.bindings.struct.VapiStruct

Server SSL profile binding.

Tip

The arguments are used to initialize data attributes with the same names.

Parameters

certificate_chain_depth (long or None) – Authentication depth is used to set the verification depth in the server certificates chain. format: int64
client_certificate_path (str or None) – To support client authentication (load balancer acting as a client authenticating to the backend server), client certificate can be specified in the server-side SSL profile binding
server_auth (str or None) –
Possible values are:
Server authentication mode.
server_auth_ca_paths (list of str or None) – If server auth type is REQUIRED, server certificate must be signed by one of the trusted Certificate Authorities (CAs), also referred to as root CAs, whose self signed certificates are specified.
server_auth_crl_paths (list of str or None) – A Certificate Revocation List (CRL) can be specified in the server-side SSL profile binding to disallow compromised server certificates.
ssl_profile_path (str or None) – Server SSL profile defines reusable, application-independent server side SSL properties.

SERVER_AUTH_AUTO_APPLY = 'AUTO_APPLY'¶

SERVER_AUTH_IGNORE = 'IGNORE'¶

SERVER_AUTH_REQUIRED = 'REQUIRED'¶

class com.vmware.nsx_policy.model_client.LBService(links=None, schema=None, self_=None, revision=None, create_time=None, create_user=None, last_modified_time=None, last_modified_user=None, protection=None, system_owned=None, description=None, display_name=None, id=None, resource_type=None, tags=None, parent_path=None, path=None, relative_path=None, children=None, marked_for_delete=None, access_log_enabled=None, connectivity_path=None, enabled=None, error_log_level=None, size=None)¶

Bases: vmware.vapi.bindings.struct.VapiStruct

Loadbalancer Service.

Tip

The arguments are used to initialize data attributes with the same names.

Parameters

links (list of ResourceLink or None) – The server will populate this field when returing the resource. Ignored on PUT and POST. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
schema (str or None) – Schema for this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
self (SelfResourceLink or None) – Link to this resource
revision (long or None) – The _revision property describes the current revision of the resource. To prevent clients from overwriting each other’s changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected. format: int32
create_time (long or None) – Timestamp of resource creation format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
create_user (str or None) – ID of the user who created this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
last_modified_time (long or None) – Timestamp of last modification format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
last_modified_user (str or None) – ID of the user who last modified this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
protection (str or None) – Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super user and can modify it, but only when providing the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this entity. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
system_owned (bool or None) – Indicates system owned resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
description (str or None) – Description of this resource
display_name (str or None) – Defaults to ID if not set
id (str or None) – Unique identifier of this resource
resource_type (str or None) – The type of this resource.
tags (list of Tag or None) – Opaque identifiers meaningful to the API user
parent_path (str or None) – Path of its parent This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
path (str or None) – Absolute path of this object This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
relative_path (str or None) – Path relative from its parent This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
children (list of vmware.vapi.struct.VapiStruct or None) – subtree for this type within policy tree containing nested elements. When clients pass a value of this class as a parameter, the attribute must contain all the attributes defined in ChildPolicyConfigResource. When methods return a value of this class as a return value, the attribute will contain all the attributes defined in ChildPolicyConfigResource.
marked_for_delete (bool or None) – Intent objects are not directly deleted from the system when a delete is invoked on them. They are marked for deletion and only when all the realized entities for that intent object gets deleted, the intent object is deleted. Objects that are marked for deletion are not returned in GET call. One can use the search API to get these objects. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
access_log_enabled (bool or None) – Flag to enable access log
connectivity_path (str or None) – LBS could be instantiated (or created) on the Tier-1, etc. For now, only the Tier-1 object is supported.
enabled (bool or None) – Flag to enable the load balancer service.
error_log_level (str or None) –
Possible values are:
- LBService.ERROR_LOG_LEVEL_DEBUG
- LBService.ERROR_LOG_LEVEL_INFO
- LBService.ERROR_LOG_LEVEL_WARNING
- LBService.ERROR_LOG_LEVEL_ERROR
- LBService.ERROR_LOG_LEVEL_CRITICAL
- LBService.ERROR_LOG_LEVEL_ALERT
- LBService.ERROR_LOG_LEVEL_EMERGENCY
Load balancer engine writes information about encountered issues of different severity levels to the error log. This setting is used to define the severity level of the error log.
size (str or None) –
Possible values are:
- LBService.SIZE_SMALL
- LBService.SIZE_MEDIUM
- LBService.SIZE_LARGE
- LBService.SIZE_DLB
Load balancer service size.

ERROR_LOG_LEVEL_ALERT = 'ALERT'¶

ERROR_LOG_LEVEL_CRITICAL = 'CRITICAL'¶

ERROR_LOG_LEVEL_DEBUG = 'DEBUG'¶

ERROR_LOG_LEVEL_EMERGENCY = 'EMERGENCY'¶

ERROR_LOG_LEVEL_ERROR = 'ERROR'¶

ERROR_LOG_LEVEL_INFO = 'INFO'¶

ERROR_LOG_LEVEL_WARNING = 'WARNING'¶

SIZE_DLB = 'DLB'¶

SIZE_LARGE = 'LARGE'¶

SIZE_MEDIUM = 'MEDIUM'¶

SIZE_SMALL = 'SMALL'¶

class com.vmware.nsx_policy.model_client.LBSessionCookieTime(cookie_max_idle=None, cookie_max_life=None, type='LBSessionCookieTime')¶

Bases: vmware.vapi.bindings.struct.VapiStruct

Session cookie time.

Tip

The arguments are used to initialize data attributes with the same names.

Parameters

cookie_max_idle (long or None) – Instead of using HTTP Cookie max-age and relying on client to expire the cookie, max idle time and/or max lifetime of the cookie can be used. Max idle time, if configured, specifies the maximum interval the cookie is valid for from the last time it was seen in a request. It is available for insert mode. format: int64
cookie_max_life (long or None) – Max life time, if configured, specifies the maximum interval the cookie is valid for from the first time the cookie was seen in a request. It is available for insert mode. format: int64
type (str) –
Possible values are:
- LBCookieTime.TYPE_LBSESSIONCOOKIETIME
- LBCookieTime.TYPE_LBPERSISTENCECOOKIETIME
Both session cookie and persistence cookie are supported, Use LbSessionCookieTime for session cookie time setting, Use LbPersistenceCookieTime for persistence cookie time setting

property type¶: Return the discriminator value

class com.vmware.nsx_policy.model_client.LBSnatAutoMap(type='LBSnatAutoMap')¶

Bases: vmware.vapi.bindings.struct.VapiStruct

Snat auto map.

Tip

The arguments are used to initialize data attributes with the same names.

Parameters

type (str) –

Possible values are:

LBSnatTranslation.TYPE_LBSNATAUTOMAP
LBSnatTranslation.TYPE_LBSNATIPPOOL
LBSnatTranslation.TYPE_LBSNATDISABLED

Snat translation type.

property type¶: Return the discriminator value

class com.vmware.nsx_policy.model_client.LBSnatDisabled(type='LBSnatDisabled')¶

Bases: vmware.vapi.bindings.struct.VapiStruct

Snat disabled.

Tip

The arguments are used to initialize data attributes with the same names.

Parameters

type (str) –

Possible values are:

LBSnatTranslation.TYPE_LBSNATAUTOMAP
LBSnatTranslation.TYPE_LBSNATIPPOOL
LBSnatTranslation.TYPE_LBSNATDISABLED

Snat translation type.

property type¶: Return the discriminator value

class com.vmware.nsx_policy.model_client.LBSnatIpElement(ip_address=None, prefix_length=None)¶

Bases: vmware.vapi.bindings.struct.VapiStruct

Snat Ip element.

Tip

The arguments are used to initialize data attributes with the same names.

Parameters

ip_address (str) – Ip address or ip range such as 1.1.1.1 or 1.1.1.101-1.1.1.160. format: address-or-block-or-range
prefix_length (long or None) – Subnet prefix length should be not specified if there is only one single IP address or IP range. format: int64

class com.vmware.nsx_policy.model_client.LBSnatIpPool(ip_addresses=None, type='LBSnatIpPool')¶

Bases: vmware.vapi.bindings.struct.VapiStruct

Snat Ip pool.

Tip

The arguments are used to initialize data attributes with the same names.

Parameters

ip_addresses (list of LBSnatIpElement) – Currently, only one single IP address or IP range is supported. If an IP range is specified, the range may contain no more than 64 IP addresses.
type (str) –
Possible values are:
Snat translation type.

property type¶: Return the discriminator value

class com.vmware.nsx_policy.model_client.LBSnatTranslation(type='LBSnatTranslation')¶

Bases: vmware.vapi.bindings.struct.VapiStruct

Snat Translation.

Tip

The arguments are used to initialize data attributes with the same names.

Parameters

type (str) –

Possible values are:

LBSnatTranslation.TYPE_LBSNATAUTOMAP
LBSnatTranslation.TYPE_LBSNATIPPOOL
LBSnatTranslation.TYPE_LBSNATDISABLED

Snat translation type.

TYPE_LBSNATAUTOMAP = 'LBSnatAutoMap'¶

TYPE_LBSNATDISABLED = 'LBSnatDisabled'¶

TYPE_LBSNATIPPOOL = 'LBSnatIpPool'¶

property type¶: Return the discriminator value

class com.vmware.nsx_policy.model_client.LBSourceIpPersistenceProfile(ha_persistence_mirroring_enabled=None, purge=None, timeout=None, links=None, schema=None, self_=None, revision=None, create_time=None, create_user=None, last_modified_time=None, last_modified_user=None, protection=None, system_owned=None, description=None, display_name=None, id=None, resource_type='LBSourceIpPersistenceProfile', tags=None, parent_path=None, path=None, relative_path=None, children=None, marked_for_delete=None, persistence_shared=None)¶

Bases: vmware.vapi.bindings.struct.VapiStruct

Some applications maintain state and require all relevant connections to be sent to the same server as the application state is not synchronized among servers. Persistence is enabled on a LBVirtualServer by binding a persistence profile to it.

Tip

The arguments are used to initialize data attributes with the same names.

Parameters

ha_persistence_mirroring_enabled (bool or None) – Persistence entries are not synchronized to the HA peer by default.
purge (str or None) –
Possible values are:
- LBSourceIpPersistenceProfile.PURGE_NO_PURGE
- LBSourceIpPersistenceProfile.PURGE_FULL
Persistence purge setting.
timeout (long or None) – When all connections complete (reference count reaches 0), persistence entry timer is started with the expiration time. format: int64
links (list of ResourceLink or None) – The server will populate this field when returing the resource. Ignored on PUT and POST. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
schema (str or None) – Schema for this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
self (SelfResourceLink or None) – Link to this resource
revision (long or None) – The _revision property describes the current revision of the resource. To prevent clients from overwriting each other’s changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected. format: int32
create_time (long or None) – Timestamp of resource creation format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
create_user (str or None) – ID of the user who created this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
last_modified_time (long or None) – Timestamp of last modification format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
last_modified_user (str or None) – ID of the user who last modified this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
protection (str or None) – Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super user and can modify it, but only when providing the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this entity. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
system_owned (bool or None) – Indicates system owned resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
description (str or None) – Description of this resource
display_name (str or None) – Defaults to ID if not set
id (str or None) – Unique identifier of this resource
resource_type (str) –
Possible values are:
- LBPersistenceProfile.RESOURCE_TYPE_LBSOURCEIPPERSISTENCEPROFILE
- LBPersistenceProfile.RESOURCE_TYPE_LBCOOKIEPERSISTENCEPROFILE
- LBPersistenceProfile.RESOURCE_TYPE_LBGENERICPERSISTENCEPROFILE
  
  The resource_type property identifies persistence profile type.
tags (list of Tag or None) – Opaque identifiers meaningful to the API user
parent_path (str or None) – Path of its parent This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
path (str or None) – Absolute path of this object This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
relative_path (str or None) – Path relative from its parent This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
children (list of vmware.vapi.struct.VapiStruct or None) – subtree for this type within policy tree containing nested elements. When clients pass a value of this class as a parameter, the attribute must contain all the attributes defined in ChildPolicyConfigResource. When methods return a value of this class as a return value, the attribute will contain all the attributes defined in ChildPolicyConfigResource.
marked_for_delete (bool or None) – Intent objects are not directly deleted from the system when a delete is invoked on them. They are marked for deletion and only when all the realized entities for that intent object gets deleted, the intent object is deleted. Objects that are marked for deletion are not returned in GET call. One can use the search API to get these objects. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
persistence_shared (bool or None) – Persistence shared setting indicates that all LBVirtualServers that consume this LBPersistenceProfile should share the same persistence mechanism when enabled. Meaning, persistence entries of a client accessing one virtual server will also affect the same client’s connections to a different virtual server. For example, say there are two virtual servers vip-ip1:80 and vip-ip1:8080 bound to the same Group g1 consisting of two servers (s11:80 and s12:80). By default, each virtual server will have its own persistence table or cookie. So, in the earlier example, there will be two tables (vip-ip1:80, p1) and (vip-ip1:8080, p1) or cookies. So, if a client connects to vip1:80 and later connects to vip1:8080, the second connection may be sent to a different server than the first. When persistence_shared is enabled, then the second connection will always connect to the same server as the original connection. For COOKIE persistence type, the same cookie will be shared by multiple virtual servers. For SOURCE_IP persistence type, the persistence table will be shared across virtual servers. For GENERIC persistence type, the persistence table will be shared across virtual servers which consume the same persistence profile in LBRule actions.

PURGE_FULL = 'FULL'¶

PURGE_NO_PURGE = 'NO_PURGE'¶

property resource_type¶: Return the discriminator value

class com.vmware.nsx_policy.model_client.LBSslProfile(links=None, schema=None, self_=None, revision=None, create_time=None, create_user=None, last_modified_time=None, last_modified_user=None, protection=None, system_owned=None, description=None, display_name=None, id=None, resource_type=None, tags=None, parent_path=None, path=None, relative_path=None, children=None, marked_for_delete=None)¶

Bases: vmware.vapi.bindings.struct.VapiStruct

Load balancer abstract SSL profile.

Tip

The arguments are used to initialize data attributes with the same names.

Parameters

links (list of ResourceLink or None) – The server will populate this field when returing the resource. Ignored on PUT and POST. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
schema (str or None) – Schema for this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
self (SelfResourceLink or None) – Link to this resource
revision (long or None) – The _revision property describes the current revision of the resource. To prevent clients from overwriting each other’s changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected. format: int32
create_time (long or None) – Timestamp of resource creation format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
create_user (str or None) – ID of the user who created this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
last_modified_time (long or None) – Timestamp of last modification format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
last_modified_user (str or None) – ID of the user who last modified this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
protection (str or None) – Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super user and can modify it, but only when providing the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this entity. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
system_owned (bool or None) – Indicates system owned resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
description (str or None) – Description of this resource
display_name (str or None) – Defaults to ID if not set
id (str or None) – Unique identifier of this resource
resource_type (str or None) – The type of this resource.
tags (list of Tag or None) – Opaque identifiers meaningful to the API user
parent_path (str or None) – Path of its parent This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
path (str or None) – Absolute path of this object This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
relative_path (str or None) – Path relative from its parent This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
children (list of vmware.vapi.struct.VapiStruct or None) – subtree for this type within policy tree containing nested elements. When clients pass a value of this class as a parameter, the attribute must contain all the attributes defined in ChildPolicyConfigResource. When methods return a value of this class as a return value, the attribute will contain all the attributes defined in ChildPolicyConfigResource.
marked_for_delete (bool or None) – Intent objects are not directly deleted from the system when a delete is invoked on them. They are marked for deletion and only when all the realized entities for that intent object gets deleted, the intent object is deleted. Objects that are marked for deletion are not returned in GET call. One can use the search API to get these objects. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.

class com.vmware.nsx_policy.model_client.LBTcpHeaderCondition(source_port=None, inverse=None, type='LBTcpHeaderCondition')¶

Bases: vmware.vapi.bindings.struct.VapiStruct

This condition is used to match TCP header fields of HTTP messages. Currently, only the TCP source port is supported. Ports can be expressed as a single port number like 80, or a port range like 1024-1030.

Tip

The arguments are used to initialize data attributes with the same names.

Parameters

source_port (str) – TCP source port of HTTP message format: port-or-range
inverse (bool or None) – A flag to indicate whether reverse the match result of this condition
type (str) –
Possible values are:
Type of load balancer rule condition

property type¶: Return the discriminator value

class com.vmware.nsx_policy.model_client.LBTcpMonitorProfile(receive=None, send=None, fall_count=None, interval=None, monitor_port=None, rise_count=None, timeout=None, links=None, schema=None, self_=None, revision=None, create_time=None, create_user=None, last_modified_time=None, last_modified_user=None, protection=None, system_owned=None, description=None, display_name=None, id=None, resource_type=None, tags=None, parent_path=None, path=None, relative_path=None, children=None, marked_for_delete=None)¶

Bases: vmware.vapi.bindings.struct.VapiStruct

Active healthchecks are disabled by default and can be enabled for a server pool by binding a health monitor to the Group through the LBRule object. This represents active health monitoring over TCP. Active healthchecks are initiated periodically, at a configurable interval, to each member of the Group. Only if a healthcheck fails consecutively for a specified number of times (fall_count) to a member will the member status be marked DOWN. Once a member is DOWN, a specified number of consecutive successful healthchecks (rise_count) will bring the member back to UP state. After a healthcheck is initiated, if it does not complete within a certain period, then also the healthcheck is considered to be unsuccessful. Completing a healthcheck within timeout means establishing a connection (TCP or SSL), if applicable, sending the request and receiving the response, all within the configured timeout.

Tip

The arguments are used to initialize data attributes with the same names.

Parameters

receive (str or None) – Expected data, if specified, can be anywhere in the response and it has to be a string, regular expressions are not supported.
send (str or None) – If both send and receive are not specified, then just a TCP connection is established (3-way handshake) to validate server is healthy, no data is sent.
fall_count (long or None) – Only if a healthcheck fails consecutively for a specified number of times, given with fall_count, to a member will the member status be marked DOWN. format: int64
interval (long or None) – Active healthchecks are initiated periodically, at a configurable interval (in seconds), to each member of the Group. format: int64
monitor_port (long or None) – Typically, monitors perform healthchecks to Group members using the member IP address and pool_port. However, in some cases, customers prefer to run healthchecks against a different port than the pool member port which handles actual application traffic. In such cases, the port to run healthchecks against can be specified in the monitor_port value. For ICMP monitor, monitor_port is not required. format: int32
rise_count (long or None) – Once a member is DOWN, a specified number of consecutive successful healthchecks specified by rise_count will bring the member back to UP state. format: int64
timeout (long or None) – Timeout specified in seconds. After a healthcheck is initiated, if it does not complete within a certain period, then also the healthcheck is considered to be unsuccessful. Completing a healthcheck within timeout means establishing a connection (TCP or SSL), if applicable, sending the request and receiving the response, all within the configured timeout. format: int64
links (list of ResourceLink or None) – The server will populate this field when returing the resource. Ignored on PUT and POST. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
schema (str or None) – Schema for this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
self (SelfResourceLink or None) – Link to this resource
revision (long or None) – The _revision property describes the current revision of the resource. To prevent clients from overwriting each other’s changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected. format: int32
create_time (long or None) – Timestamp of resource creation format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
create_user (str or None) – ID of the user who created this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
last_modified_time (long or None) – Timestamp of last modification format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
last_modified_user (str or None) – ID of the user who last modified this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
protection (str or None) – Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super user and can modify it, but only when providing the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this entity. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
system_owned (bool or None) – Indicates system owned resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
description (str or None) – Description of this resource
display_name (str or None) – Defaults to ID if not set
id (str or None) – Unique identifier of this resource
resource_type (str) –
Possible values are:
- LBMonitorProfile.RESOURCE_TYPE_LBTCPMONITORPROFILE
- LBMonitorProfile.RESOURCE_TYPE_LBUDPMONITORPROFILE
- LBMonitorProfile.RESOURCE_TYPE_LBICMPMONITORPROFILE
- LBMonitorProfile.RESOURCE_TYPE_LBHTTPMONITORPROFILE
- LBMonitorProfile.RESOURCE_TYPE_LBHTTPSMONITORPROFILE
- LBMonitorProfile.RESOURCE_TYPE_LBPASSIVEMONITORPROFILE
There are two types of healthchecks: active and passive. Passive healthchecks depend on failures in actual client traffic (e.g. RST from server in response to a client connection) to detect that the server or the application is down. In case of active healthchecks, load balancer itself initiates new connections (or sends ICMP ping) to the servers periodically to check their health, completely independent of any data traffic. Currently, active health monitors are supported for HTTP, HTTPS, TCP, UDP and ICMP protocols.
tags (list of Tag or None) – Opaque identifiers meaningful to the API user
parent_path (str or None) – Path of its parent This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
path (str or None) – Absolute path of this object This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
relative_path (str or None) – Path relative from its parent This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
children (list of vmware.vapi.struct.VapiStruct or None) – subtree for this type within policy tree containing nested elements. When clients pass a value of this class as a parameter, the attribute must contain all the attributes defined in ChildPolicyConfigResource. When methods return a value of this class as a return value, the attribute will contain all the attributes defined in ChildPolicyConfigResource.
marked_for_delete (bool or None) – Intent objects are not directly deleted from the system when a delete is invoked on them. They are marked for deletion and only when all the realized entities for that intent object gets deleted, the intent object is deleted. Objects that are marked for deletion are not returned in GET call. One can use the search API to get these objects. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.

property resource_type¶: Return the discriminator value

class com.vmware.nsx_policy.model_client.LBUdpMonitorProfile(receive=None, send=None, fall_count=None, interval=None, monitor_port=None, rise_count=None, timeout=None, links=None, schema=None, self_=None, revision=None, create_time=None, create_user=None, last_modified_time=None, last_modified_user=None, protection=None, system_owned=None, description=None, display_name=None, id=None, resource_type=None, tags=None, parent_path=None, path=None, relative_path=None, children=None, marked_for_delete=None)¶

Bases: vmware.vapi.bindings.struct.VapiStruct

Active healthchecks are disabled by default and can be enabled for a server pool by binding a health monitor to the Group through the LBRule object. This represents active health monitoring over UDP. Active healthchecks are initiated periodically, at a configurable interval, to each member of the Group. Only if a healthcheck fails consecutively for a specified number of times (fall_count) to a member will the member status be marked DOWN. Once a member is DOWN, a specified number of consecutive successful healthchecks (rise_count) will bring the member back to UP state. After a healthcheck is initiated, if it does not complete within a certain period, then also the healthcheck is considered to be unsuccessful. Completing a healthcheck within timeout means establishing a connection (TCP or SSL), if applicable, sending the request and receiving the response, all within the configured timeout.

Tip

The arguments are used to initialize data attributes with the same names.

Parameters

receive (str) – Expected data, can be anywhere in the response and it has to be a string, regular expressions are not supported. UDP healthcheck is considered failed if there is no server response within the timeout period.
send (str) – The data to be sent to the monitored server.
fall_count (long or None) – Only if a healthcheck fails consecutively for a specified number of times, given with fall_count, to a member will the member status be marked DOWN. format: int64
interval (long or None) – Active healthchecks are initiated periodically, at a configurable interval (in seconds), to each member of the Group. format: int64
monitor_port (long or None) – Typically, monitors perform healthchecks to Group members using the member IP address and pool_port. However, in some cases, customers prefer to run healthchecks against a different port than the pool member port which handles actual application traffic. In such cases, the port to run healthchecks against can be specified in the monitor_port value. For ICMP monitor, monitor_port is not required. format: int32
rise_count (long or None) – Once a member is DOWN, a specified number of consecutive successful healthchecks specified by rise_count will bring the member back to UP state. format: int64
timeout (long or None) – Timeout specified in seconds. After a healthcheck is initiated, if it does not complete within a certain period, then also the healthcheck is considered to be unsuccessful. Completing a healthcheck within timeout means establishing a connection (TCP or SSL), if applicable, sending the request and receiving the response, all within the configured timeout. format: int64
links (list of ResourceLink or None) – The server will populate this field when returing the resource. Ignored on PUT and POST. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
schema (str or None) – Schema for this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
self (SelfResourceLink or None) – Link to this resource
revision (long or None) – The _revision property describes the current revision of the resource. To prevent clients from overwriting each other’s changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected. format: int32
create_time (long or None) – Timestamp of resource creation format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
create_user (str or None) – ID of the user who created this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
last_modified_time (long or None) – Timestamp of last modification format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
last_modified_user (str or None) – ID of the user who last modified this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
protection (str or None) – Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super user and can modify it, but only when providing the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this entity. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
system_owned (bool or None) – Indicates system owned resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
description (str or None) – Description of this resource
display_name (str or None) – Defaults to ID if not set
id (str or None) – Unique identifier of this resource
resource_type (str) –
Possible values are:
- LBMonitorProfile.RESOURCE_TYPE_LBTCPMONITORPROFILE
- LBMonitorProfile.RESOURCE_TYPE_LBUDPMONITORPROFILE
- LBMonitorProfile.RESOURCE_TYPE_LBICMPMONITORPROFILE
- LBMonitorProfile.RESOURCE_TYPE_LBHTTPMONITORPROFILE
- LBMonitorProfile.RESOURCE_TYPE_LBHTTPSMONITORPROFILE
- LBMonitorProfile.RESOURCE_TYPE_LBPASSIVEMONITORPROFILE
There are two types of healthchecks: active and passive. Passive healthchecks depend on failures in actual client traffic (e.g. RST from server in response to a client connection) to detect that the server or the application is down. In case of active healthchecks, load balancer itself initiates new connections (or sends ICMP ping) to the servers periodically to check their health, completely independent of any data traffic. Currently, active health monitors are supported for HTTP, HTTPS, TCP, UDP and ICMP protocols.
tags (list of Tag or None) – Opaque identifiers meaningful to the API user
parent_path (str or None) – Path of its parent This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
path (str or None) – Absolute path of this object This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
relative_path (str or None) – Path relative from its parent This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
children (list of vmware.vapi.struct.VapiStruct or None) – subtree for this type within policy tree containing nested elements. When clients pass a value of this class as a parameter, the attribute must contain all the attributes defined in ChildPolicyConfigResource. When methods return a value of this class as a return value, the attribute will contain all the attributes defined in ChildPolicyConfigResource.
marked_for_delete (bool or None) – Intent objects are not directly deleted from the system when a delete is invoked on them. They are marked for deletion and only when all the realized entities for that intent object gets deleted, the intent object is deleted. Objects that are marked for deletion are not returned in GET call. One can use the search API to get these objects. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.

property resource_type¶: Return the discriminator value

class com.vmware.nsx_policy.model_client.LBVariableAssignmentAction(variable_name=None, variable_value=None, type='LBVariableAssignmentAction')¶

Bases: vmware.vapi.bindings.struct.VapiStruct

This action is used to create a new variable and assign value to it. One action can be used to create one variable. To create multiple variables, multiple actions must be defined. The variables can be used by LBVariableCondition, etc.

Tip

The arguments are used to initialize data attributes with the same names.

Parameters

variable_name (str) – Name of the variable to be assigned.
variable_value (str) – Value of variable.
type (str) –
Possible values are:
The property identifies the load balancer rule action type.

property type¶: Return the discriminator value

class com.vmware.nsx_policy.model_client.LBVariableCondition(case_sensitive=None, match_type=None, variable_name=None, variable_value=None, inverse=None, type='LBVariableCondition')¶

Bases: vmware.vapi.bindings.struct.VapiStruct

This condition is used to match variable’s name and value at all phases. The variables could be captured from REGEX or assigned by LBVariableAssignmentAction or system embedded variable. Varialbe_name and variable_value should be matched at the same time.

Tip

The arguments are used to initialize data attributes with the same names.

Parameters

case_sensitive (bool or None) – If true, case is significant when comparing variable value.
match_type (str or None) –
Possible values are:
Match type of variable value
variable_name (str) – Name of the variable to be matched
variable_value (str) – Value of variable to be matched
inverse (bool or None) – A flag to indicate whether reverse the match result of this condition
type (str) –
Possible values are:
Type of load balancer rule condition

MATCH_TYPE_CONTAINS = 'CONTAINS'¶

MATCH_TYPE_ENDS_WITH = 'ENDS_WITH'¶

MATCH_TYPE_EQUALS = 'EQUALS'¶

MATCH_TYPE_REGEX = 'REGEX'¶

MATCH_TYPE_STARTS_WITH = 'STARTS_WITH'¶

property type¶: Return the discriminator value

class com.vmware.nsx_policy.model_client.LBVariablePersistenceLearnAction(persistence_profile_path=None, variable_hash_enabled=None, variable_name=None, type='LBVariablePersistenceLearnAction')¶

Bases: vmware.vapi.bindings.struct.VapiStruct

This action is performed in HTTP response rewrite phase. It is used to learn the value of variable from the HTTP response, and insert an entry into the persistence table if the entry doesn’t exist.

Tip

The arguments are used to initialize data attributes with the same names.

Parameters

persistence_profile_path (str or None) – If the persistence profile path is not specified, a default persistence table is created per virtual server. Currently, only LBGenericPersistenceProfile is supported.
variable_hash_enabled (bool or None) – The property is used to enable a hash operation for variable value when composing the persistence key.
variable_name (str) – The property is the name of variable to be learnt. It is used to identify which variable’s value is learnt from HTTP response. The variable can be a built-in variable such as “_cookie_JSESSIONID”, a customized variable defined in LBVariableAssignmentAction or a captured variable in regular expression such as “article”. For the full list of built-in variables, please reference the NSX-T Administrator’s Guide.
type (str) –
Possible values are:
The property identifies the load balancer rule action type.

property type¶: Return the discriminator value

class com.vmware.nsx_policy.model_client.LBVariablePersistenceOnAction(persistence_profile_path=None, variable_hash_enabled=None, variable_name=None, type='LBVariablePersistenceOnAction')¶

Bases: vmware.vapi.bindings.struct.VapiStruct

This action is performed in HTTP forwarding phase. It is used to inspect the variable of HTTP request, and look up the persistence entry with its value and pool uuid as key. If the persistence entry is found, the HTTP request is forwarded to the recorded backend server according to the persistence entry. If the persistence entry is not found, a new entry is created in the table after backend server is selected.

Tip

The arguments are used to initialize data attributes with the same names.

Parameters

persistence_profile_path (str or None) – If the persistence profile path is not specified, a default persistence table is created per virtual server. Currently, only LBGenericPersistenceProfile is supported.
variable_hash_enabled (bool or None) – The property is used to enable a hash operation for variable value when composing the persistence key.
variable_name (str) – The property is the name of variable to be used. It specifies which variable’s value of a HTTP Request will be used in the key of persistence entry. The variable can be a built-in variable such as “_cookie_JSESSIONID”, a customized variable defined in LBVariableAssignmentAction or a captured variable in regular expression such as “article”. For the full list of built-in variables, please reference the NSX-T Administrator’s Guide.
type (str) –
Possible values are:
The property identifies the load balancer rule action type.

property type¶: Return the discriminator value

class com.vmware.nsx_policy.model_client.LBVirtualServer(links=None, schema=None, self_=None, revision=None, create_time=None, create_user=None, last_modified_time=None, last_modified_user=None, protection=None, system_owned=None, description=None, display_name=None, id=None, resource_type=None, tags=None, parent_path=None, path=None, relative_path=None, children=None, marked_for_delete=None, access_log_enabled=None, application_profile_path=None, client_ssl_profile_binding=None, default_pool_member_ports=None, enabled=None, ip_address=None, lb_persistence_profile_path=None, lb_service_path=None, max_concurrent_connections=None, max_new_connection_rate=None, pool_path=None, ports=None, rules=None, server_ssl_profile_binding=None, sorry_pool_path=None)¶

Bases: vmware.vapi.bindings.struct.VapiStruct

All the types of LBVirtualServer extend from this abstract class. This is present for extensibility.

Tip

The arguments are used to initialize data attributes with the same names.

Parameters

links (list of ResourceLink or None) – The server will populate this field when returing the resource. Ignored on PUT and POST. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
schema (str or None) – Schema for this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
self (SelfResourceLink or None) – Link to this resource
revision (long or None) – The _revision property describes the current revision of the resource. To prevent clients from overwriting each other’s changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected. format: int32
create_time (long or None) – Timestamp of resource creation format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
create_user (str or None) – ID of the user who created this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
last_modified_time (long or None) – Timestamp of last modification format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
last_modified_user (str or None) – ID of the user who last modified this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
protection (str or None) – Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super user and can modify it, but only when providing the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this entity. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
system_owned (bool or None) – Indicates system owned resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
description (str or None) – Description of this resource
display_name (str or None) – Defaults to ID if not set
id (str or None) – Unique identifier of this resource
resource_type (str or None) – The type of this resource.
tags (list of Tag or None) – Opaque identifiers meaningful to the API user
parent_path (str or None) – Path of its parent This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
path (str or None) – Absolute path of this object This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
relative_path (str or None) – Path relative from its parent This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
children (list of vmware.vapi.struct.VapiStruct or None) – subtree for this type within policy tree containing nested elements. When clients pass a value of this class as a parameter, the attribute must contain all the attributes defined in ChildPolicyConfigResource. When methods return a value of this class as a return value, the attribute will contain all the attributes defined in ChildPolicyConfigResource.
marked_for_delete (bool or None) – Intent objects are not directly deleted from the system when a delete is invoked on them. They are marked for deletion and only when all the realized entities for that intent object gets deleted, the intent object is deleted. Objects that are marked for deletion are not returned in GET call. One can use the search API to get these objects. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
access_log_enabled (bool or None) – If access log is enabled, all HTTP requests sent to an L7 virtual server are logged to the access log file. Both successful requests (backend server returns 2xx) and unsuccessful requests (backend server returns 4xx or 5xx) are logged to access log, if enabled.
application_profile_path (str) – The application profile defines the application protocol characteristics. It is used to influence how load balancing is performed. Currently, LBFastTCPProfile, LBFastUDPProfile and LBHttpProfile, etc are supported.
client_ssl_profile_binding (LBClientSslProfileBinding or None) – The setting is used when load balancer acts as an SSL server and terminating the client SSL connection
default_pool_member_ports (list of str or None) – Default pool member ports when member port is not defined. format: port-or-range
enabled (bool or None) – Flag to enable the load balancer virtual server.
ip_address (str) – Configures the IP address of the LBVirtualServer where it receives all client connections and distributes them among the backend servers. format: ip
lb_persistence_profile_path (str or None) – Path to optional object that enables persistence on a virtual server allowing related client connections to be sent to the same backend server. Persistence is disabled by default.
lb_service_path (str or None) – virtual servers can be associated to LBService(which is similar to physical/virtual load balancer), LB virtual servers, pools and other entities could be defined independently, the LBService identifier list here would be used to maintain the relationship of LBService and other LB entities.
max_concurrent_connections (long or None) – To ensure one virtual server does not over consume resources, affecting other applications hosted on the same LBS, connections to a virtual server can be capped. If it is not specified, it means that connections are unlimited. format: int64
max_new_connection_rate (long or None) – To ensure one virtual server does not over consume resources, connections to a member can be rate limited. If it is not specified, it means that connection rate is unlimited. format: int64
pool_path (str or None) – The server pool(LBPool) contains backend servers. Server pool consists of one or more servers, also referred to as pool members, that are similarly configured and are running the same application.
ports (list of str) – Ports contains a list of at least one port or port range such as “80”, “1234-1236”. Each port element in the list should be a single port or a single port range. format: port-or-range
rules (list of LBRule or None) – Load balancer rules allow customization of load balancing behavior using match/action rules. Currently, load balancer rules are supported for only layer 7 virtual servers with LBHttpProfile.
server_ssl_profile_binding (LBServerSslProfileBinding or None) – The setting is used when load balancer acts as an SSL client and establishing a connection to the backend server.
sorry_pool_path (str or None) – When load balancer can not select a backend server to serve the request in default pool or pool in rules, the request would be served by sorry server pool.

class com.vmware.nsx_policy.model_client.Label(condition=None, hover=None, icons=None, navigation=None, text=None)¶

Bases: vmware.vapi.bindings.struct.VapiStruct

Label that will be displayed for a UI element.

Tip

The arguments are used to initialize data attributes with the same names.

Parameters

condition (str or None) – If the condition is met then the label will be applied. Examples of expression syntax are provided under example_request section of CreateWidgetConfiguration API.
hover (bool or None) – If true, displays the label only on hover
icons (list of Icon or None) – Icons to be applied at dashboard for the label
navigation (str or None) – Hyperlink of the specified UI page that provides details.
text (str) – Text to be displayed at the label.

class com.vmware.nsx_policy.model_client.LabelValueConfiguration(layout=None, navigation=None, properties=None, sub_type=None, links=None, schema=None, self_=None, revision=None, create_time=None, create_user=None, last_modified_time=None, last_modified_user=None, protection=None, system_owned=None, description=None, display_name=None, id=None, resource_type='LabelValueConfiguration', tags=None, datasources=None, drilldown_id=None, footer=None, icons=None, is_drilldown=None, legend=None, shared=None, weight=None)¶

Bases: vmware.vapi.bindings.struct.VapiStruct

Represents a Label-Value widget configuration

Tip

The arguments are used to initialize data attributes with the same names.

Parameters

layout (Layout or None) – Layout of properties can be vertical or grid. If layout is not specified a default vertical layout is applied.
navigation (str or None) – Hyperlink of the specified UI page that provides details.
properties (list of PropertyItem) – An array of label-value properties.
sub_type (str or None) –
Possible values are:
- LabelValueConfiguration.SUB_TYPE_ALIGNED
A sub-type of LabelValueConfiguration. If sub-type is not specified the parent type is rendered. For VERTICALLY_ALIGNED sub_type, the value is placed below the label.
links (list of ResourceLink or None) – The server will populate this field when returing the resource. Ignored on PUT and POST. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
schema (str or None) – Schema for this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
self (SelfResourceLink or None) – Link to this resource
revision (long or None) – The _revision property describes the current revision of the resource. To prevent clients from overwriting each other’s changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected. format: int32
create_time (long or None) – Timestamp of resource creation format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
create_user (str or None) – ID of the user who created this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
last_modified_time (long or None) – Timestamp of last modification format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
last_modified_user (str or None) – ID of the user who last modified this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
protection (str or None) – Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super user and can modify it, but only when providing the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this entity. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
system_owned (bool or None) – Indicates system owned resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
description (str or None) – Description of this resource
display_name (str or None) – Title of the widget. If display_name is omitted, the widget will be shown without a title.
id (str or None) – Unique identifier of this resource
resource_type (str) –
Possible values are:
- WidgetConfiguration.RESOURCE_TYPE_LABELVALUECONFIGURATION
- WidgetConfiguration.RESOURCE_TYPE_DONUTCONFIGURATION
- WidgetConfiguration.RESOURCE_TYPE_MULTIWIDGETCONFIGURATION
- WidgetConfiguration.RESOURCE_TYPE_CONTAINERCONFIGURATION
- WidgetConfiguration.RESOURCE_TYPE_STATSCONFIGURATION
- WidgetConfiguration.RESOURCE_TYPE_GRIDCONFIGURATION
- WidgetConfiguration.RESOURCE_TYPE_GRAPHCONFIGURATION
Supported visualization types are LabelValueConfiguration, DonutConfiguration, GridConfiguration, StatsConfiguration, MultiWidgetConfiguration, GraphConfiguration and ContainerConfiguration.
tags (list of Tag or None) – Opaque identifiers meaningful to the API user
datasources (list of Datasource or None) – The ‘datasources’ represent the sources from which data will be fetched. Currently, only NSX-API is supported as a ‘default’ datasource. An example of specifying ‘default’ datasource along with the urls to fetch data from is given at ‘example_request’ section of ‘CreateWidgetConfiguration’ API.
drilldown_id (str or None) – Id of drilldown widget, if any. Id should be a valid id of an existing widget. A widget is considered as drilldown widget when it is associated with any other widget and provides more detailed information about any data item from the parent widget.
footer (Footer or None) –
icons (list of Icon or None) – Icons to be applied at dashboard for widgets and UI elements.
is_drilldown (bool or None) – Set to true if this widget should be used as a drilldown.
legend (Legend or None) – Legend to be displayed. If legend is not needed, do not include it.
shared (bool or None) – Please use the property ‘shared’ of View instead of this. The widgets of a shared view are visible to other users.
weight (long or None) – Specify relavite weight in WidgetItem for placement in a view. Please see WidgetItem for details. format: int32

SUB_TYPE_ALIGNED = 'VERTICALLY_ALIGNED'¶

property resource_type¶: Return the discriminator value

class com.vmware.nsx_policy.model_client.Layout(properties=None, type=None)¶

Bases: vmware.vapi.bindings.struct.VapiStruct

Represents layout of a container or widget

Tip

The arguments are used to initialize data attributes with the same names.

Parameters

properties (LayoutProperties or None) –
type (str or None) –
Possible values are:
Describes layout of a container or widget. Layout describes how individual widgets are placed inside the container. For example, if HORIZONTAL is chosen widgets are placed side by side inside the container. If VERTICAL is chosen then widgets are placed one below the other. If GRID is chosen then the container or widget display area is divided into a grid of m rows and n columns, as specified in the properties, and the widgets are placed inside the grid.

TYPE_GRID = 'GRID'¶

TYPE_HORIZONTAL = 'HORIZONTAL'¶

TYPE_VERTICAL = 'VERTICAL'¶

class com.vmware.nsx_policy.model_client.LayoutProperties(num_columns=None, num_rows=None)¶

Bases: vmware.vapi.bindings.struct.VapiStruct

Properties of the layout of a container or widget

Tip

The arguments are used to initialize data attributes with the same names.

Parameters

num_columns (long or None) – Describes the number of columns of grid layout of a container or widget. This property is applicable for grid layout only. format: int32
num_rows (long or None) – Describes the number of rows of grid layout of a container or widget. This property is applicable for grid layout only. format: int32

class com.vmware.nsx_policy.model_client.LbHttpRequestHeader(header_name=None, header_value=None)¶

Bases: vmware.vapi.bindings.struct.VapiStruct

Tip

The arguments are used to initialize data attributes with the same names.

Parameters

header_name (str) – Name of HTTP request header
header_value (str) – Value of HTTP request header

class com.vmware.nsx_policy.model_client.Legend(alignment=None, display_count=None, position=None, type=None)¶

Bases: vmware.vapi.bindings.struct.VapiStruct

Represents legend that describes the entities of the widget.

Tip

The arguments are used to initialize data attributes with the same names.

Parameters

alignment (str or None) –
Possible values are:
- Legend.ALIGNMENT_HORIZONTAL
- Legend.ALIGNMENT_VERTICAL
Describes the alignment of legend. Alignment of a legend denotes how individual items of the legend are aligned in a container. For example, if VERTICAL is chosen then the items of the legend will appear one below the other and if HORIZONTAL is chosen then the items will appear side by side.
display_count (bool or None) – If set to true, it will display the counts in legend. If set to false, counts of entities are not displayed in the legend.
position (str or None) –
Possible values are:
Describes the relative placement of legend. The legend of a widget can be placed either to the TOP or BOTTOM or LEFT or RIGHT relative to the widget. For example, if RIGHT is chosen then legend is placed to the right of the widget.
type (str or None) –
Possible values are:
- Legend.TYPE_CIRCLE
Describes the render type for the legend. The legend for an entity describes the entity in the widget. The supported legend type is a circle against which the entity’s details such as display_name are shown. The color of the circle denotes the color of the entity shown inside the widget.

ALIGNMENT_HORIZONTAL = 'HORIZONTAL'¶

ALIGNMENT_VERTICAL = 'VERTICAL'¶

POSITION_BOTTOM = 'BOTTOM'¶

POSITION_LEFT = 'LEFT'¶

POSITION_RIGHT = 'RIGHT'¶

POSITION_TOP = 'TOP'¶

POSITION_TOP_RIGHT = 'TOP_RIGHT'¶

TYPE_CIRCLE = 'CIRCLE'¶

class com.vmware.nsx_policy.model_client.ListResult(links=None, schema=None, self_=None, cursor=None, result_count=None, sort_ascending=None, sort_by=None)¶

Bases: vmware.vapi.bindings.struct.VapiStruct

Base class for list results from collections

Tip

The arguments are used to initialize data attributes with the same names.

Parameters

links (list of ResourceLink or None) – The server will populate this field when returing the resource. Ignored on PUT and POST. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
schema (str or None) – Schema for this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
self (SelfResourceLink or None) – Link to this resource
cursor (str or None) – Opaque cursor to be used for getting next page of records (supplied by current result page) This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
result_count (long or None) – Count of results found (across all pages), set only on first page format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
sort_ascending (bool or None) – If true, results are sorted in ascending order This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
sort_by (str or None) – Field by which records are sorted This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.

class com.vmware.nsx_policy.model_client.LocaleServices(links=None, schema=None, self_=None, revision=None, create_time=None, create_user=None, last_modified_time=None, last_modified_user=None, protection=None, system_owned=None, description=None, display_name=None, id=None, resource_type=None, tags=None, parent_path=None, path=None, relative_path=None, children=None, marked_for_delete=None, edge_cluster_path=None, ha_vip_configs=None, preferred_edge_paths=None, route_redistribution_types=None)¶

Bases: vmware.vapi.bindings.struct.VapiStruct

Site specific configuration of Tier0 in multi-site scenario

Tip

The arguments are used to initialize data attributes with the same names.

Parameters

links (list of ResourceLink or None) – The server will populate this field when returing the resource. Ignored on PUT and POST. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
schema (str or None) – Schema for this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
self (SelfResourceLink or None) – Link to this resource
revision (long or None) – The _revision property describes the current revision of the resource. To prevent clients from overwriting each other’s changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected. format: int32
create_time (long or None) – Timestamp of resource creation format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
create_user (str or None) – ID of the user who created this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
last_modified_time (long or None) – Timestamp of last modification format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
last_modified_user (str or None) – ID of the user who last modified this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
protection (str or None) – Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super user and can modify it, but only when providing the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this entity. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
system_owned (bool or None) – Indicates system owned resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
description (str or None) – Description of this resource
display_name (str or None) – Defaults to ID if not set
id (str or None) – Unique identifier of this resource
resource_type (str or None) – The type of this resource.
tags (list of Tag or None) – Opaque identifiers meaningful to the API user
parent_path (str or None) – Path of its parent This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
path (str or None) – Absolute path of this object This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
relative_path (str or None) – Path relative from its parent This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
children (list of vmware.vapi.struct.VapiStruct or None) – subtree for this type within policy tree containing nested elements. When clients pass a value of this class as a parameter, the attribute must contain all the attributes defined in ChildPolicyConfigResource. When methods return a value of this class as a return value, the attribute will contain all the attributes defined in ChildPolicyConfigResource.
marked_for_delete (bool or None) – Intent objects are not directly deleted from the system when a delete is invoked on them. They are marked for deletion and only when all the realized entities for that intent object gets deleted, the intent object is deleted. Objects that are marked for deletion are not returned in GET call. One can use the search API to get these objects. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
edge_cluster_path (str or None) – Policy path to edge cluster. Auto-assigned on Tier0 if associated enforcement-point has only one edge cluster.
ha_vip_configs (list of Tier0HaVipConfig or None) – This configuration can be defined only for Active-Standby Tier0 gateway to provide redundancy. For mulitple external interfaces, multiple HA VIP configs must be defined and each config will pair exactly two external interfaces. The VIP will move and will always be owned by the Active node. When this property is configured, configuration of dynamic-routing is not allowed.
preferred_edge_paths (list of str or None) – Policy paths to edge nodes. Specified edge is used as preferred edge cluster member when failover mode is set to PREEMPTIVE, not applicable otherwise.
route_redistribution_types (list of str or None) –
Possible values are:
- LocaleServices.ROUTE_REDISTRIBUTION_TYPES_TIER0_STATIC
- LocaleServices.ROUTE_REDISTRIBUTION_TYPES_TIER0_CONNECTED
- LocaleServices.ROUTE_REDISTRIBUTION_TYPES_TIER0_EXTERNAL_INTERFACE
- LocaleServices.ROUTE_REDISTRIBUTION_TYPES_TIER0_SEGMENT
- LocaleServices.ROUTE_REDISTRIBUTION_TYPES_TIER0_ROUTER_LINK
- LocaleServices.ROUTE_REDISTRIBUTION_TYPES_TIER0_SERVICE_INTERFACE
- LocaleServices.ROUTE_REDISTRIBUTION_TYPES_TIER0_LOOPBACK_INTERFACE
- LocaleServices.ROUTE_REDISTRIBUTION_TYPES_TIER0_DNS_FORWARDER_IP
- LocaleServices.ROUTE_REDISTRIBUTION_TYPES_TIER0_IPSEC_LOCAL_IP
- LocaleServices.ROUTE_REDISTRIBUTION_TYPES_TIER0_NAT
- LocaleServices.ROUTE_REDISTRIBUTION_TYPES_TIER1_NAT
- LocaleServices.ROUTE_REDISTRIBUTION_TYPES_TIER1_STATIC
- LocaleServices.ROUTE_REDISTRIBUTION_TYPES_TIER1_LB_VIP
- LocaleServices.ROUTE_REDISTRIBUTION_TYPES_TIER1_LB_SNAT
- LocaleServices.ROUTE_REDISTRIBUTION_TYPES_TIER1_DNS_FORWARDER_IP
- LocaleServices.ROUTE_REDISTRIBUTION_TYPES_TIER1_CONNECTED
- LocaleServices.ROUTE_REDISTRIBUTION_TYPES_TIER1_SERVICE_INTERFACE
- LocaleServices.ROUTE_REDISTRIBUTION_TYPES_TIER1_SEGMENT
- LocaleServices.ROUTE_REDISTRIBUTION_TYPES_TIER1_IPSEC_LOCAL_ENDPOINT
Enable redistribution of different types of routes on Tier-0. This property is only valid for locale-service under Tier-0.

ROUTE_REDISTRIBUTION_TYPES_TIER0_CONNECTED = 'TIER0_CONNECTED'¶

ROUTE_REDISTRIBUTION_TYPES_TIER0_DNS_FORWARDER_IP = 'TIER0_DNS_FORWARDER_IP'¶

ROUTE_REDISTRIBUTION_TYPES_TIER0_EXTERNAL_INTERFACE = 'TIER0_EXTERNAL_INTERFACE'¶

ROUTE_REDISTRIBUTION_TYPES_TIER0_IPSEC_LOCAL_IP = 'TIER0_IPSEC_LOCAL_IP'¶

ROUTE_REDISTRIBUTION_TYPES_TIER0_LOOPBACK_INTERFACE = 'TIER0_LOOPBACK_INTERFACE'¶

ROUTE_REDISTRIBUTION_TYPES_TIER0_NAT = 'TIER0_NAT'¶

ROUTE_REDISTRIBUTION_TYPES_TIER0_ROUTER_LINK = 'TIER0_ROUTER_LINK'¶

ROUTE_REDISTRIBUTION_TYPES_TIER0_SEGMENT = 'TIER0_SEGMENT'¶

ROUTE_REDISTRIBUTION_TYPES_TIER0_SERVICE_INTERFACE = 'TIER0_SERVICE_INTERFACE'¶

ROUTE_REDISTRIBUTION_TYPES_TIER0_STATIC = 'TIER0_STATIC'¶

ROUTE_REDISTRIBUTION_TYPES_TIER1_CONNECTED = 'TIER1_CONNECTED'¶

ROUTE_REDISTRIBUTION_TYPES_TIER1_DNS_FORWARDER_IP = 'TIER1_DNS_FORWARDER_IP'¶

ROUTE_REDISTRIBUTION_TYPES_TIER1_IPSEC_LOCAL_ENDPOINT = 'TIER1_IPSEC_LOCAL_ENDPOINT'¶

ROUTE_REDISTRIBUTION_TYPES_TIER1_LB_SNAT = 'TIER1_LB_SNAT'¶

ROUTE_REDISTRIBUTION_TYPES_TIER1_LB_VIP = 'TIER1_LB_VIP'¶

ROUTE_REDISTRIBUTION_TYPES_TIER1_NAT = 'TIER1_NAT'¶

ROUTE_REDISTRIBUTION_TYPES_TIER1_SEGMENT = 'TIER1_SEGMENT'¶

ROUTE_REDISTRIBUTION_TYPES_TIER1_SERVICE_INTERFACE = 'TIER1_SERVICE_INTERFACE'¶

ROUTE_REDISTRIBUTION_TYPES_TIER1_STATIC = 'TIER1_STATIC'¶

class com.vmware.nsx_policy.model_client.LocaleServicesListResult(links=None, schema=None, self_=None, cursor=None, result_count=None, sort_ascending=None, sort_by=None, results=None)¶

Bases: vmware.vapi.bindings.struct.VapiStruct

Paged collection of LocaleServices

Tip

The arguments are used to initialize data attributes with the same names.

Parameters

links (list of ResourceLink or None) – The server will populate this field when returing the resource. Ignored on PUT and POST. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
schema (str or None) – Schema for this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
self (SelfResourceLink or None) – Link to this resource
cursor (str or None) – Opaque cursor to be used for getting next page of records (supplied by current result page) This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
result_count (long or None) – Count of results found (across all pages), set only on first page format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
sort_ascending (bool or None) – If true, results are sorted in ascending order This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
sort_by (str or None) – Field by which records are sorted This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
results (list of LocaleServices) – LocaleServices results

class com.vmware.nsx_policy.model_client.LogicalPortStatistics(rx_bytes=None, rx_packets=None, tx_bytes=None, tx_packets=None, dropped_by_security_packets=None, mac_learning=None, last_update_timestamp=None, logical_port_id=None)¶

Bases: vmware.vapi.bindings.struct.VapiStruct

Tip

The arguments are used to initialize data attributes with the same names.

Parameters

rx_bytes (DataCounter or None) –
rx_packets (DataCounter or None) –
tx_bytes (DataCounter or None) –
tx_packets (DataCounter or None) –
dropped_by_security_packets (PacketsDroppedBySecurity or None) –
mac_learning (MacLearningCounters or None) –
last_update_timestamp (long or None) – Timestamp when the data was last updated; unset if data source has never updated the data. format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
logical_port_id (str or None) – The id of the logical port This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.

class com.vmware.nsx_policy.model_client.LogicalRouterPortCounters(dropped_packets=None, total_bytes=None, total_packets=None)¶

Bases: vmware.vapi.bindings.struct.VapiStruct

Tip

The arguments are used to initialize data attributes with the same names.

Parameters

dropped_packets (long or None) – The number of dropped packets format: int64
total_bytes (long or None) – The total number of bytes format: int64
total_packets (long or None) – The total number of packets format: int64

class com.vmware.nsx_policy.model_client.LogicalRouterPortStatistics(logical_router_port_id=None, per_node_statistics=None)¶

Bases: vmware.vapi.bindings.struct.VapiStruct

Tip

The arguments are used to initialize data attributes with the same names.

Parameters

logical_router_port_id (str) – The ID of the logical router port
per_node_statistics (list of LogicalRouterPortStatisticsPerNode or None) – Per Node Statistics This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.

class com.vmware.nsx_policy.model_client.LogicalRouterPortStatisticsPerNode(last_update_timestamp=None, rx=None, tx=None, transport_node_id=None)¶

Bases: vmware.vapi.bindings.struct.VapiStruct

Tip

The arguments are used to initialize data attributes with the same names.

Parameters

last_update_timestamp (long or None) – Timestamp when the data was last updated; unset if data source has never updated the data. format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
rx (LogicalRouterPortCounters or None) –
tx (LogicalRouterPortCounters or None) –
transport_node_id (str or None) – The ID of the TransportNode This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.

class com.vmware.nsx_policy.model_client.LogicalRouterState(details=None, failure_code=None, failure_message=None, state=None)¶

Bases: vmware.vapi.bindings.struct.VapiStruct

Tip

The arguments are used to initialize data attributes with the same names.

Parameters

details (list of ConfigurationStateElement or None) – Array of configuration state of various sub systems This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
failure_code (long or None) – Error code format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
failure_message (str or None) – Error message in case of failure This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
state (str or None) –
Possible values are:
Gives details of state of desired configuration. Additional enums with more details on progress/success/error states are sent for edge node. The success states are NODE_READY and TRANSPORT_NODE_READY, pending states are {VM_DEPLOYMENT_QUEUED, VM_DEPLOYMENT_IN_PROGRESS, REGISTRATION_PENDING} and other values indicate failures. “in_sync” state indicates that the desired configuration has been received by the host to which it applies, but is not yet in effect. When the configuration is actually in effect, the state will change to “success”. Please note, failed state is deprecated. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.

STATE_APPLIANCE_INTERNAL_ERROR = 'APPLIANCE_INTERNAL_ERROR'¶

STATE_EDGE_CONFIG_ERROR = 'EDGE_CONFIG_ERROR'¶

STATE_EDGE_HARDWARE_NOT_SUPPORTED = 'EDGE_HARDWARE_NOT_SUPPORTED'¶

STATE_EDGE_NODE_VERSION_NOT_SUPPORTED = 'EDGE_NODE_VERSION_NOT_SUPPORTED'¶

STATE_ERROR = 'error'¶

STATE_FAILED = 'failed'¶

STATE_HOSTSWITCH_PROFILE_NOT_FOUND = 'HOSTSWITCH_PROFILE_NOT_FOUND'¶

STATE_INVALID_PNIC_DEVICE_NAME = 'INVALID_PNIC_DEVICE_NAME'¶

STATE_IN_PROGRESS = 'in_progress'¶

STATE_IN_SYNC = 'in_sync'¶

STATE_LACP_NOT_SUPPORTED_FOR_EDGE_VM = 'LACP_NOT_SUPPORTED_FOR_EDGE_VM'¶

STATE_LBSRCID_NOT_SUPPORTED_FOR_EDGE_VM = 'LBSRCID_NOT_SUPPORTED_FOR_EDGE_VM'¶

STATE_LLDP_SEND_ENABLED_NOT_SUPPORTED = 'LLDP_SEND_ENABLED_NOT_SUPPORTED'¶

STATE_MPA_DISCONNECTED = 'MPA_DISCONNECTED'¶

STATE_MULTIPLE_ACTIVE_UPLINKS_NOT_SUPPORTED_FOR_EDGE = 'MULTIPLE_ACTIVE_UPLINKS_NOT_SUPPORTED_FOR_EDGE'¶

STATE_MULTIPLE_OVERLAY_TZS_NOT_SUPPORTED = 'MULTIPLE_OVERLAY_TZS_NOT_SUPPORTED'¶

STATE_NODE_NOT_READY = 'NODE_NOT_READY'¶

STATE_NODE_READY = 'NODE_READY'¶

STATE_NOT_AVAILABLE = 'NOT_AVAILABLE'¶

STATE_NO_PNIC_PREPARED_IN_EDGE = 'NO_PNIC_PREPARED_IN_EDGE'¶

STATE_NO_PNIC_SPECIFIED_IN_TN = 'NO_PNIC_SPECIFIED_IN_TN'¶

STATE_ORPHANED = 'orphaned'¶

STATE_PARTIAL_SUCCESS = 'partial_success'¶

STATE_PENDING = 'pending'¶

STATE_REGISTRATION_FAILED = 'REGISTRATION_FAILED'¶

STATE_REGISTRATION_PENDING = 'REGISTRATION_PENDING'¶

STATE_STANDBY_UPLINKS_NOT_SUPPORTED_FOR_EDGE_VM = 'STANDBY_UPLINKS_NOT_SUPPORTED_FOR_EDGE_VM'¶

STATE_SUCCESS = 'success'¶

STATE_TN_OVERLAY_TZ_IN_USE_BY_EDGE_CLUSTER = 'TN_OVERLAY_TZ_IN_USE_BY_EDGE_CLUSTER'¶

STATE_TRANSPORT_NODE_CONFIGURATION_MISSING = 'TRANSPORT_NODE_CONFIGURATION_MISSING'¶

STATE_TRANSPORT_NODE_READY = 'TRANSPORT_NODE_READY'¶

STATE_TRANSPORT_NODE_SYNC_PENDING = 'TRANSPORT_NODE_SYNC_PENDING'¶

STATE_TZ_ENDPOINTS_NOT_SPECIFIED = 'TZ_ENDPOINTS_NOT_SPECIFIED'¶

STATE_UNKNOWN = 'unknown'¶

STATE_UNSUPPORTED_DEFAULT_TEAMING_POLICY = 'UNSUPPORTED_DEFAULT_TEAMING_POLICY'¶

STATE_UNSUPPORTED_HOST_SWITCH_PROFILE = 'UNSUPPORTED_HOST_SWITCH_PROFILE'¶

STATE_UNSUPPORTED_LACP_LB_ALGO_FOR_NODE = 'UNSUPPORTED_LACP_LB_ALGO_FOR_NODE'¶

STATE_UNSUPPORTED_NAMED_TEAMING_POLICY = 'UNSUPPORTED_NAMED_TEAMING_POLICY'¶

STATE_UPLINK_HOST_SWITCH_PROFILE_NOT_SPECIFIED = 'UPLINK_HOST_SWITCH_PROFILE_NOT_SPECIFIED'¶

STATE_VM_CONFIG_DISCREPANCY = 'VM_CONFIG_DISCREPANCY'¶

STATE_VM_CONFIG_EDIT_FAILED = 'VM_CONFIG_EDIT_FAILED'¶

STATE_VM_CONFIG_EDIT_PENDING = 'VM_CONFIG_EDIT_PENDING'¶

STATE_VM_DEPLOYMENT_FAILED = 'VM_DEPLOYMENT_FAILED'¶

STATE_VM_DEPLOYMENT_IN_PROGRESS = 'VM_DEPLOYMENT_IN_PROGRESS'¶

STATE_VM_DEPLOYMENT_QUEUED = 'VM_DEPLOYMENT_QUEUED'¶

STATE_VM_DEPLOYMENT_RESTARTED = 'VM_DEPLOYMENT_RESTARTED'¶

STATE_VM_NETWORK_EDIT_FAILED = 'VM_NETWORK_EDIT_FAILED'¶

STATE_VM_NETWORK_EDIT_PENDING = 'VM_NETWORK_EDIT_PENDING'¶

STATE_VM_NODE_REFRESH_FAILED = 'VM_NODE_REFRESH_FAILED'¶

STATE_VM_PLACEMENT_REFRESH_FAILED = 'VM_PLACEMENT_REFRESH_FAILED'¶

STATE_VM_POWER_OFF_FAILED = 'VM_POWER_OFF_FAILED'¶

STATE_VM_POWER_OFF_IN_PROGRESS = 'VM_POWER_OFF_IN_PROGRESS'¶

STATE_VM_POWER_ON_FAILED = 'VM_POWER_ON_FAILED'¶

STATE_VM_POWER_ON_IN_PROGRESS = 'VM_POWER_ON_IN_PROGRESS'¶

STATE_VM_RENAME_FAILED = 'VM_RENAME_FAILED'¶

STATE_VM_RENAME_PENDING = 'VM_RENAME_PENDING'¶

STATE_VM_UNDEPLOY_FAILED = 'VM_UNDEPLOY_FAILED'¶

STATE_VM_UNDEPLOY_IN_PROGRESS = 'VM_UNDEPLOY_IN_PROGRESS'¶

STATE_VM_UNDEPLOY_SUCCESSFUL = 'VM_UNDEPLOY_SUCCESSFUL'¶

STATE_VTEP_DHCP_NOT_SUPPORTED = 'VTEP_DHCP_NOT_SUPPORTED'¶

class com.vmware.nsx_policy.model_client.LogicalRouterStatus(last_update_timestamp=None, logical_router_id=None, per_node_status=None)¶

Bases: vmware.vapi.bindings.struct.VapiStruct

Tip

The arguments are used to initialize data attributes with the same names.

Parameters

last_update_timestamp (long or None) – Timestamp when the data was last updated; unset if data source has never updated the data. format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
logical_router_id (str) – The id of the logical router
per_node_status (list of LogicalRouterStatusPerNode or None) – Per Node Status This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.

class com.vmware.nsx_policy.model_client.LogicalRouterStatusPerNode(high_availability_status=None, service_router_id=None, transport_node_id=None)¶

Bases: vmware.vapi.bindings.struct.VapiStruct

Tip

The arguments are used to initialize data attributes with the same names.

Parameters

high_availability_status (str) –
Possible values are:
- LogicalRouterStatusPerNode.HIGH_AVAILABILITY_STATUS_ACTIVE
- LogicalRouterStatusPerNode.HIGH_AVAILABILITY_STATUS_STANDBY
- LogicalRouterStatusPerNode.HIGH_AVAILABILITY_STATUS_DOWN
- LogicalRouterStatusPerNode.HIGH_AVAILABILITY_STATUS_SYNC
- LogicalRouterStatusPerNode.HIGH_AVAILABILITY_STATUS_UNKNOWN
  
  A service router’s HA status on an edge node
service_router_id (str or None) – id of the service router where the router status is retrieved.
transport_node_id (str) – id of the transport node where the router status is retrieved.

HIGH_AVAILABILITY_STATUS_ACTIVE = 'ACTIVE'¶

HIGH_AVAILABILITY_STATUS_DOWN = 'DOWN'¶

HIGH_AVAILABILITY_STATUS_STANDBY = 'STANDBY'¶

HIGH_AVAILABILITY_STATUS_SYNC = 'SYNC'¶

HIGH_AVAILABILITY_STATUS_UNKNOWN = 'UNKNOWN'¶

class com.vmware.nsx_policy.model_client.LogicalSwitchStatistics(rx_bytes=None, rx_packets=None, tx_bytes=None, tx_packets=None, dropped_by_security_packets=None, mac_learning=None, last_update_timestamp=None, logical_switch_id=None)¶

Bases: vmware.vapi.bindings.struct.VapiStruct

Tip

The arguments are used to initialize data attributes with the same names.

Parameters

rx_bytes (DataCounter or None) –
rx_packets (DataCounter or None) –
tx_bytes (DataCounter or None) –
tx_packets (DataCounter or None) –
dropped_by_security_packets (PacketsDroppedBySecurity or None) –
mac_learning (MacLearningCounters or None) –
last_update_timestamp (long or None) – Timestamp when the data was last updated; unset if data source has never updated the data. format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
logical_switch_id (str or None) – The id of the logical Switch This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.

class com.vmware.nsx_policy.model_client.MACAddressExpression(mac_addresses=None, links=None, schema=None, self_=None, revision=None, create_time=None, create_user=None, last_modified_time=None, last_modified_user=None, protection=None, system_owned=None, description=None, display_name=None, id=None, resource_type='MACAddressExpression', tags=None, parent_path=None, path=None, relative_path=None, children=None, marked_for_delete=None)¶

Bases: vmware.vapi.bindings.struct.VapiStruct

Represents MAC address expressions in the form of an array, to support addition of MAC addresses in a group.

Tip

The arguments are used to initialize data attributes with the same names.

Parameters

mac_addresses (list of str) – This array can consist of one or more MAC addresses.
links (list of ResourceLink or None) – The server will populate this field when returing the resource. Ignored on PUT and POST. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
schema (str or None) – Schema for this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
self (SelfResourceLink or None) – Link to this resource
revision (long or None) – The _revision property describes the current revision of the resource. To prevent clients from overwriting each other’s changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected. format: int32
create_time (long or None) – Timestamp of resource creation format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
create_user (str or None) – ID of the user who created this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
last_modified_time (long or None) – Timestamp of last modification format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
last_modified_user (str or None) – ID of the user who last modified this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
protection (str or None) – Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super user and can modify it, but only when providing the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this entity. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
system_owned (bool or None) – Indicates system owned resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
description (str or None) – Description of this resource
display_name (str or None) – Defaults to ID if not set
id (str or None) – Unique identifier of this resource
resource_type (str) –
Possible values are:
- Expression.RESOURCE_TYPE_CONDITION
- Expression.RESOURCE_TYPE_CONJUNCTIONOPERATOR
- Expression.RESOURCE_TYPE_NESTEDEXPRESSION
- Expression.RESOURCE_TYPE_IPADDRESSEXPRESSION
- Expression.RESOURCE_TYPE_MACADDRESSEXPRESSION
- Expression.RESOURCE_TYPE_EXTERNALIDEXPRESSION
- Expression.RESOURCE_TYPE_PATHEXPRESSION
- Expression.RESOURCE_TYPE_IDENTITYGROUPEXPRESSION
tags (list of Tag or None) – Opaque identifiers meaningful to the API user
parent_path (str or None) – Path of its parent This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
path (str or None) – Absolute path of this object This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
relative_path (str or None) – Path relative from its parent This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
children (list of vmware.vapi.struct.VapiStruct or None) – subtree for this type within policy tree containing nested elements. When clients pass a value of this class as a parameter, the attribute must contain all the attributes defined in ChildPolicyConfigResource. When methods return a value of this class as a return value, the attribute will contain all the attributes defined in ChildPolicyConfigResource.
marked_for_delete (bool or None) – Intent objects are not directly deleted from the system when a delete is invoked on them. They are marked for deletion and only when all the realized entities for that intent object gets deleted, the intent object is deleted. Objects that are marked for deletion are not returned in GET call. One can use the search API to get these objects. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.

property resource_type¶: Return the discriminator value

class com.vmware.nsx_policy.model_client.MacDiscoveryProfile(links=None, schema=None, self_=None, revision=None, create_time=None, create_user=None, last_modified_time=None, last_modified_user=None, protection=None, system_owned=None, description=None, display_name=None, id=None, resource_type=None, tags=None, parent_path=None, path=None, relative_path=None, children=None, marked_for_delete=None, mac_change_enabled=None, mac_learning_aging_time=None, mac_learning_enabled=None, mac_limit=None, mac_limit_policy=None, unknown_unicast_flooding_enabled=None)¶

Bases: vmware.vapi.bindings.struct.VapiStruct

Mac Discovery Profile

Tip

The arguments are used to initialize data attributes with the same names.

Parameters

links (list of ResourceLink or None) – The server will populate this field when returing the resource. Ignored on PUT and POST. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
schema (str or None) – Schema for this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
self (SelfResourceLink or None) – Link to this resource
revision (long or None) – The _revision property describes the current revision of the resource. To prevent clients from overwriting each other’s changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected. format: int32
create_time (long or None) – Timestamp of resource creation format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
create_user (str or None) – ID of the user who created this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
last_modified_time (long or None) – Timestamp of last modification format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
last_modified_user (str or None) – ID of the user who last modified this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
protection (str or None) – Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super user and can modify it, but only when providing the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this entity. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
system_owned (bool or None) – Indicates system owned resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
description (str or None) – Description of this resource
display_name (str or None) – Defaults to ID if not set
id (str or None) – Unique identifier of this resource
resource_type (str or None) – The type of this resource.
tags (list of Tag or None) – Opaque identifiers meaningful to the API user
parent_path (str or None) – Path of its parent This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
path (str or None) – Absolute path of this object This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
relative_path (str or None) – Path relative from its parent This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
children (list of vmware.vapi.struct.VapiStruct or None) – subtree for this type within policy tree containing nested elements. When clients pass a value of this class as a parameter, the attribute must contain all the attributes defined in ChildPolicyConfigResource. When methods return a value of this class as a return value, the attribute will contain all the attributes defined in ChildPolicyConfigResource.
marked_for_delete (bool or None) – Intent objects are not directly deleted from the system when a delete is invoked on them. They are marked for deletion and only when all the realized entities for that intent object gets deleted, the intent object is deleted. Objects that are marked for deletion are not returned in GET call. One can use the search API to get these objects. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
mac_change_enabled (bool or None) – Allowing source MAC address change
mac_learning_aging_time (long or None) – Indicates how long learned MAC address remain. format: int32 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
mac_learning_enabled (bool) – Allowing source MAC address learning
mac_limit (long or None) – The maximum number of MAC addresses that can be learned on this port format: int32
mac_limit_policy (str or None) –
Possible values are:
- MacDiscoveryProfile.MAC_LIMIT_POLICY_ALLOW
- MacDiscoveryProfile.MAC_LIMIT_POLICY_DROP
The policy after MAC Limit is exceeded
unknown_unicast_flooding_enabled (bool or None) – Allowing flooding for unlearned MAC for ingress traffic

MAC_LIMIT_POLICY_ALLOW = 'ALLOW'¶

MAC_LIMIT_POLICY_DROP = 'DROP'¶

class com.vmware.nsx_policy.model_client.MacDiscoveryProfileListResult(links=None, schema=None, self_=None, cursor=None, result_count=None, sort_ascending=None, sort_by=None, results=None)¶

Bases: vmware.vapi.bindings.struct.VapiStruct

Paged collection of Mac Discovery Profiles

Tip

The arguments are used to initialize data attributes with the same names.

Parameters

links (list of ResourceLink or None) – The server will populate this field when returing the resource. Ignored on PUT and POST. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
schema (str or None) – Schema for this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
self (SelfResourceLink or None) – Link to this resource
cursor (str or None) – Opaque cursor to be used for getting next page of records (supplied by current result page) This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
result_count (long or None) – Count of results found (across all pages), set only on first page format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
sort_ascending (bool or None) – If true, results are sorted in ascending order This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
sort_by (str or None) – Field by which records are sorted This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
results (list of MacDiscoveryProfile) – Mac Discovery profile list results

class com.vmware.nsx_policy.model_client.MacLearningCounters(mac_not_learned_packets_allowed=None, mac_not_learned_packets_dropped=None, macs_learned=None)¶

Bases: vmware.vapi.bindings.struct.VapiStruct

Tip

The arguments are used to initialize data attributes with the same names.

Parameters

mac_not_learned_packets_allowed (long or None) – The number of packets with unknown source MAC address that are dispatched without learning the source MAC address. Applicable only when the MAC limit is reached and MAC Limit policy is MAC_LEARNING_LIMIT_POLICY_ALLOW. format: int64
mac_not_learned_packets_dropped (long or None) – The number of packets with unknown source MAC address that are dropped without learning the source MAC address. Applicable only when the MAC limit is reached and MAC Limit policy is MAC_LEARNING_LIMIT_POLICY_DROP. format: int64
macs_learned (long or None) – Number of MACs learned format: int64

class com.vmware.nsx_policy.model_client.ManagedResource(links=None, schema=None, self_=None, revision=None, create_time=None, create_user=None, last_modified_time=None, last_modified_user=None, protection=None, system_owned=None, description=None, display_name=None, id=None, resource_type=None, tags=None)¶

Bases: vmware.vapi.bindings.struct.VapiStruct

Base type for resources that are managed by API clients

Tip

The arguments are used to initialize data attributes with the same names.

Parameters

links (list of ResourceLink or None) – The server will populate this field when returing the resource. Ignored on PUT and POST. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
schema (str or None) – Schema for this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
self (SelfResourceLink or None) – Link to this resource
revision (long or None) – The _revision property describes the current revision of the resource. To prevent clients from overwriting each other’s changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected. format: int32
create_time (long or None) – Timestamp of resource creation format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
create_user (str or None) – ID of the user who created this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
last_modified_time (long or None) – Timestamp of last modification format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
last_modified_user (str or None) – ID of the user who last modified this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
protection (str or None) – Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super user and can modify it, but only when providing the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this entity. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
system_owned (bool or None) – Indicates system owned resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
description (str or None) – Description of this resource
display_name (str or None) – Defaults to ID if not set
id (str or None) – Unique identifier of this resource
resource_type (str or None) – The type of this resource.
tags (list of Tag or None) – Opaque identifiers meaningful to the API user

class com.vmware.nsx_policy.model_client.MonitoringProfileBindingMap(links=None, schema=None, self_=None, revision=None, create_time=None, create_user=None, last_modified_time=None, last_modified_user=None, protection=None, system_owned=None, description=None, display_name=None, id=None, resource_type=None, tags=None, parent_path=None, path=None, relative_path=None, children=None, marked_for_delete=None)¶

Bases: vmware.vapi.bindings.struct.VapiStruct

Base Monitoring Profile Binding Map

Tip

The arguments are used to initialize data attributes with the same names.

Parameters

links (list of ResourceLink or None) – The server will populate this field when returing the resource. Ignored on PUT and POST. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
schema (str or None) – Schema for this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
self (SelfResourceLink or None) – Link to this resource
revision (long or None) – The _revision property describes the current revision of the resource. To prevent clients from overwriting each other’s changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected. format: int32
create_time (long or None) – Timestamp of resource creation format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
create_user (str or None) – ID of the user who created this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
last_modified_time (long or None) – Timestamp of last modification format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
last_modified_user (str or None) – ID of the user who last modified this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
protection (str or None) – Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super user and can modify it, but only when providing the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this entity. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
system_owned (bool or None) – Indicates system owned resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
description (str or None) – Description of this resource
display_name (str or None) – Defaults to ID if not set
id (str or None) – Unique identifier of this resource
resource_type (str or None) – The type of this resource.
tags (list of Tag or None) – Opaque identifiers meaningful to the API user
parent_path (str or None) – Path of its parent This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
path (str or None) – Absolute path of this object This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
relative_path (str or None) – Path relative from its parent This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
children (list of vmware.vapi.struct.VapiStruct or None) – subtree for this type within policy tree containing nested elements. When clients pass a value of this class as a parameter, the attribute must contain all the attributes defined in ChildPolicyConfigResource. When methods return a value of this class as a return value, the attribute will contain all the attributes defined in ChildPolicyConfigResource.
marked_for_delete (bool or None) – Intent objects are not directly deleted from the system when a delete is invoked on them. They are marked for deletion and only when all the realized entities for that intent object gets deleted, the intent object is deleted. Objects that are marked for deletion are not returned in GET call. One can use the search API to get these objects. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.

class com.vmware.nsx_policy.model_client.MultiWidgetConfiguration(navigation=None, widgets=None, links=None, schema=None, self_=None, revision=None, create_time=None, create_user=None, last_modified_time=None, last_modified_user=None, protection=None, system_owned=None, description=None, display_name=None, id=None, resource_type='MultiWidgetConfiguration', tags=None, datasources=None, drilldown_id=None, footer=None, icons=None, is_drilldown=None, legend=None, shared=None, weight=None)¶

Bases: vmware.vapi.bindings.struct.VapiStruct

Combines two or more widgetconfigurations into a multi-widget

Tip

The arguments are used to initialize data attributes with the same names.

Parameters

navigation (str or None) – Hyperlink of the specified UI page that provides details.
widgets (list of WidgetItem) – Array of widgets that are part of the multi-widget.
links (list of ResourceLink or None) – The server will populate this field when returing the resource. Ignored on PUT and POST. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
schema (str or None) – Schema for this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
self (SelfResourceLink or None) – Link to this resource
revision (long or None) – The _revision property describes the current revision of the resource. To prevent clients from overwriting each other’s changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected. format: int32
create_time (long or None) – Timestamp of resource creation format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
create_user (str or None) – ID of the user who created this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
last_modified_time (long or None) – Timestamp of last modification format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
last_modified_user (str or None) – ID of the user who last modified this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
protection (str or None) – Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super user and can modify it, but only when providing the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this entity. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
system_owned (bool or None) – Indicates system owned resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
description (str or None) – Description of this resource
display_name (str or None) – Title of the widget. If display_name is omitted, the widget will be shown without a title.
id (str or None) – Unique identifier of this resource
resource_type (str) –
Possible values are:
- WidgetConfiguration.RESOURCE_TYPE_LABELVALUECONFIGURATION
- WidgetConfiguration.RESOURCE_TYPE_DONUTCONFIGURATION
- WidgetConfiguration.RESOURCE_TYPE_MULTIWIDGETCONFIGURATION
- WidgetConfiguration.RESOURCE_TYPE_CONTAINERCONFIGURATION
- WidgetConfiguration.RESOURCE_TYPE_STATSCONFIGURATION
- WidgetConfiguration.RESOURCE_TYPE_GRIDCONFIGURATION
- WidgetConfiguration.RESOURCE_TYPE_GRAPHCONFIGURATION
Supported visualization types are LabelValueConfiguration, DonutConfiguration, GridConfiguration, StatsConfiguration, MultiWidgetConfiguration, GraphConfiguration and ContainerConfiguration.
tags (list of Tag or None) – Opaque identifiers meaningful to the API user
datasources (list of Datasource or None) – The ‘datasources’ represent the sources from which data will be fetched. Currently, only NSX-API is supported as a ‘default’ datasource. An example of specifying ‘default’ datasource along with the urls to fetch data from is given at ‘example_request’ section of ‘CreateWidgetConfiguration’ API.
drilldown_id (str or None) – Id of drilldown widget, if any. Id should be a valid id of an existing widget. A widget is considered as drilldown widget when it is associated with any other widget and provides more detailed information about any data item from the parent widget.
footer (Footer or None) –
icons (list of Icon or None) – Icons to be applied at dashboard for widgets and UI elements.
is_drilldown (bool or None) – Set to true if this widget should be used as a drilldown.
legend (Legend or None) – Legend to be displayed. If legend is not needed, do not include it.
shared (bool or None) – Please use the property ‘shared’ of View instead of this. The widgets of a shared view are visible to other users.
weight (long or None) – Specify relavite weight in WidgetItem for placement in a view. Please see WidgetItem for details. format: int32

property resource_type¶: Return the discriminator value

class com.vmware.nsx_policy.model_client.NSXTConnectionInfo(edge_cluster_ids=None, password=None, thumbprint=None, transport_zone_ids=None, username=None, enforcement_point_address=None, resource_type='NSXTConnectionInfo')¶

Bases: vmware.vapi.bindings.struct.VapiStruct

Credential info to connect to NSXT enforcement type

Tip

The arguments are used to initialize data attributes with the same names.

Parameters

edge_cluster_ids (list of str or None) – Edge Cluster UUIDs on enforcement point. Edge cluster information is required for creating logical L2, L3 constructs on enforcement point. Max 1 edge cluster ID. This is a deprecated property. The edge cluster id is now auto populated from enforcement point and its value can be read using APIs GET /infra/sites/site-id/enforcement-points/enforcementpoint-id/edge-clusters and GET /infra/sites/site-id/enforcement-points/enforcementpoint-1/edge-clusters/edge-cluster-id. The value passed through this property will be ignored.
password (str or None) – Password
thumbprint (str or None) – Thumbprint of EnforcementPoint. sha-256 hash represented in lower case hex.
transport_zone_ids (list of str or None) – Transport Zone UUIDs on enforcement point. Transport zone information is required for creating logical L2, L3 constructs on enforcement point. Max 1 transport zone ID. This is a deprecated property. The transport zone id is now auto populated from enforcement point and its value can be read using APIs GET /infra/sites/site-id/enforcement-points/enforcementpoint-id/transport-zones and GET /infra/sites/site-id/enforcement-points/enforcementpoint-id/transport-zones/transport-zone-id. The value passed through this property will be ignored.
username (str or None) – UserName
enforcement_point_address (str) – Value of this property could be hostname or ip. eg. For NSX-T manager running on default port the value can be “10.192.1.1”, for NSX-T manager running on custom port value can be “192.168.1.1:32789”. For NSX-T manager in VMC deployments value can have url prefix eg. “192.168.1.1:5480/nsxapi”
resource_type (str) –
Possible values are:

property resource_type¶: Return the discriminator value

class com.vmware.nsx_policy.model_client.NSXVConnectionInfo(password=None, thumbprint=None, username=None, enforcement_point_address=None, resource_type='NSXVConnectionInfo')¶

Bases: vmware.vapi.bindings.struct.VapiStruct

Credential info to connect to NSXV enforcement type

Tip

The arguments are used to initialize data attributes with the same names.

Parameters

password (str or None) – Password
thumbprint (str) – Thumbprint of EnforcementPoint. sha-256 hash represented in lower case hex.
username (str or None) – UserName
enforcement_point_address (str) – Value of this property could be hostname or ip. eg. For NSX-T manager running on default port the value can be “10.192.1.1”, for NSX-T manager running on custom port value can be “192.168.1.1:32789”. For NSX-T manager in VMC deployments value can have url prefix eg. “192.168.1.1:5480/nsxapi”
resource_type (str) –
Possible values are:

property resource_type¶: Return the discriminator value

class com.vmware.nsx_policy.model_client.NdSnoopingConfig(nd_snooping_enabled=None, nd_snooping_limit=None)¶

Bases: vmware.vapi.bindings.struct.VapiStruct

Contains Neighbor Discovery Protocol (ND) snooping related configuration.

Tip

The arguments are used to initialize data attributes with the same names.

Parameters

nd_snooping_enabled (bool or None) – Enable this method will snoop the NS (Neighbor Solicitation) and NA (Neighbor Advertisement) messages in the ND (Neighbor Discovery Protocol) family of messages which are transmitted by a VM. From the NS messages, we will learn about the source which sent this NS message. From the NA message, we will learn the resolved address in the message which the VM is a recipient of. Addresses snooped by this method are subject to TOFU (Trust on First Use) policies as enforced by the system.
nd_snooping_limit (long or None) – Maximum number of ND (Neighbor Discovery Protocol) snooped IPv6 addresses format: int32

class com.vmware.nsx_policy.model_client.NestedExpression(expressions=None, links=None, schema=None, self_=None, revision=None, create_time=None, create_user=None, last_modified_time=None, last_modified_user=None, protection=None, system_owned=None, description=None, display_name=None, id=None, resource_type='NestedExpression', tags=None, parent_path=None, path=None, relative_path=None, children=None, marked_for_delete=None)¶

Bases: vmware.vapi.bindings.struct.VapiStruct

Nested expressions is a list of condition expressions that must follow the below criteria: 0. Only allowed expressions in a NestedExpression are Condition and ConjunctionOperator. 1. A non-empty expression list, must be of odd size. In a list, with indices starting from 0, all condition expressions must be at even indices, separated by the conjunction expressions AND at odd indices. 2. There may be at most 5 condition expressions inside a list. 3. NestedExpressions are homogeneous in nature, i.e, all expressions inside a nested expression must have the same member type.

Tip

The arguments are used to initialize data attributes with the same names.

Parameters

expressions (list of vmware.vapi.struct.VapiStruct) – Expression. When clients pass a value of this class as a parameter, the attribute must contain all the attributes defined in Expression. When methods return a value of this class as a return value, the attribute will contain all the attributes defined in Expression.
links (list of ResourceLink or None) – The server will populate this field when returing the resource. Ignored on PUT and POST. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
schema (str or None) – Schema for this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
self (SelfResourceLink or None) – Link to this resource
revision (long or None) – The _revision property describes the current revision of the resource. To prevent clients from overwriting each other’s changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected. format: int32
create_time (long or None) – Timestamp of resource creation format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
create_user (str or None) – ID of the user who created this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
last_modified_time (long or None) – Timestamp of last modification format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
last_modified_user (str or None) – ID of the user who last modified this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
protection (str or None) – Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super user and can modify it, but only when providing the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this entity. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
system_owned (bool or None) – Indicates system owned resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
description (str or None) – Description of this resource
display_name (str or None) – Defaults to ID if not set
id (str or None) – Unique identifier of this resource
resource_type (str) –
Possible values are:
- Expression.RESOURCE_TYPE_CONDITION
- Expression.RESOURCE_TYPE_CONJUNCTIONOPERATOR
- Expression.RESOURCE_TYPE_NESTEDEXPRESSION
- Expression.RESOURCE_TYPE_IPADDRESSEXPRESSION
- Expression.RESOURCE_TYPE_MACADDRESSEXPRESSION
- Expression.RESOURCE_TYPE_EXTERNALIDEXPRESSION
- Expression.RESOURCE_TYPE_PATHEXPRESSION
- Expression.RESOURCE_TYPE_IDENTITYGROUPEXPRESSION
tags (list of Tag or None) – Opaque identifiers meaningful to the API user
parent_path (str or None) – Path of its parent This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
path (str or None) – Absolute path of this object This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
relative_path (str or None) – Path relative from its parent This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
children (list of vmware.vapi.struct.VapiStruct or None) – subtree for this type within policy tree containing nested elements. When clients pass a value of this class as a parameter, the attribute must contain all the attributes defined in ChildPolicyConfigResource. When methods return a value of this class as a return value, the attribute will contain all the attributes defined in ChildPolicyConfigResource.
marked_for_delete (bool or None) – Intent objects are not directly deleted from the system when a delete is invoked on them. They are marked for deletion and only when all the realized entities for that intent object gets deleted, the intent object is deleted. Objects that are marked for deletion are not returned in GET call. One can use the search API to get these objects. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.

property resource_type¶: Return the discriminator value

class com.vmware.nsx_policy.model_client.NicMetadata(interface_index=None, interface_label=None, interface_type=None, transports=None, user_configurable=None)¶

Bases: vmware.vapi.bindings.struct.VapiStruct

Information on the Network interfaces present on the partner appliance that needs to be configured by the NSX Manager.

Tip

The arguments are used to initialize data attributes with the same names.

Parameters

interface_index (long) – Network Interface index. format: int64
interface_label (str) – Network Interface label.
interface_type (str) –
Possible values are:
Interface that needs to be configured on the partner appliance. Ex. MANAGEMENT, DATA1, DATA2, HA1, HA2, CONTROL.
transports (list of str or None) –
Possible values are:
Transport Type of the service, which is the mechanism of redirecting the traffic to the the partner appliance. Transport type is required if Service caters to any functionality other than EPP. Here, the transports array specifies the kinds of transport where this particular NIC is user configurable. If nothing is specified, and the “user_configurable” flag is true, then user configuration will be allowed for all transports. If any transport is/are specified, then it will be considered as user configurable for the specified transports only.”
user_configurable (bool or None) – Used to specify if the given interface needs configuration. Management nics will always need the configuration, for others it will be use case specific. For example, a DATA NIC may be user configurable if the appliance is deployed in certain mode, such as L3_ROUTED.

INTERFACE_TYPE_CONTROL = 'CONTROL'¶

INTERFACE_TYPE_DATA1 = 'DATA1'¶

INTERFACE_TYPE_DATA2 = 'DATA2'¶

INTERFACE_TYPE_HA1 = 'HA1'¶

INTERFACE_TYPE_HA2 = 'HA2'¶

INTERFACE_TYPE_MANAGEMENT = 'MANAGEMENT'¶

TRANSPORTS_L2_BRIDGE = 'L2_BRIDGE'¶

TRANSPORTS_L3_ROUTED = 'L3_ROUTED'¶

TRANSPORTS_NSH = 'NSH'¶

class com.vmware.nsx_policy.model_client.NsxTDNSForwarderStatistics(cached_entries=None, conditional_forwarder_statistics=None, configured_cache_size=None, default_forwarder_statistics=None, queries_answered_locally=None, queries_forwarded=None, timestamp=None, total_queries=None, used_cache_statistics=None, enforcement_point_path=None, resource_type='NsxTDNSForwarderStatistics')¶

Bases: vmware.vapi.bindings.struct.VapiStruct

The current statistics counters of the DNS forwarder including cache usages and query numbers per forwarders, on an NSX-T type of enforcement point.

Tip

The arguments are used to initialize data attributes with the same names.

Parameters

cached_entries (long or None) – The total number of cached entries format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
conditional_forwarder_statistics (list of NsxTDNSForwarderZoneStatistics or None) – The statistics of conditional forwarder zones This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
configured_cache_size (long or None) – The configured cache size, in kb format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
default_forwarder_statistics (NsxTDNSForwarderZoneStatistics or None) – The statistics of default forwarder zone
queries_answered_locally (long or None) – The total number of queries answered from local cache format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
queries_forwarded (long or None) – The total number of forwarded DNS queries format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
timestamp (long or None) – Time stamp of the current statistics, in ms format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
total_queries (long or None) – The total number of received DNS queries format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
used_cache_statistics (list of NsxtPerNodeUsedCacheStatistics or None) – The statistics of used cache This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
enforcement_point_path (str or None) – Policy path referencing the enforcement point from where the statistics are fetched. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
resource_type (str) –
Possible values are:
- DNSForwarderStatisticsPerEnforcementPoint.RESOURCE_TYPE_NSXTDNSFORWARDERSTATISTICS

property resource_type¶: Return the discriminator value

class com.vmware.nsx_policy.model_client.NsxTDNSForwarderStatus(extra_message=None, status=None, timestamp=None, enforcement_point_path=None, resource_type='NsxTDNSForwarderStatus')¶

Bases: vmware.vapi.bindings.struct.VapiStruct

The current runtime status of the DNS forwarder.

Tip

The arguments are used to initialize data attributes with the same names.

Parameters

extra_message (str or None) – Extra message, if available This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
status (str or None) –
Possible values are:
UP means the DNS forwarder is working correctly on the active transport node and the stand-by transport node (if present). Failover will occur if either node goes down. DOWN means the DNS forwarder is down on both active transport node and standby node (if present). The DNS forwarder does not function in this situation. Error means there is some error on one or both transport node, or no status was reported from one or both transport nodes. The DNS forwarder may be working (or not working). NO_BACKUP means DNS forwarder is working in only one transport node, either because it is down on the standby node, or no standby is configured. An forwarder outage will occur if the active node goes down. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
timestamp (long or None) – Time stamp of the current status, in ms format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
enforcement_point_path (str or None) – Policy path referencing the enforcement point from where the status is fetched. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
resource_type (str) –
Possible values are:
- DNSForwarderStatusPerEnforcementPoint.RESOURCE_TYPE_NSXTDNSFORWARDERSTATUS

STATUS_DOWN = 'DOWN'¶

STATUS_ERROR = 'ERROR'¶

STATUS_NO_BACKUP = 'NO_BACKUP'¶

STATUS_UNKNOWN = 'UNKNOWN'¶

STATUS_UP = 'UP'¶

property resource_type¶: Return the discriminator value

class com.vmware.nsx_policy.model_client.NsxTDNSForwarderZoneStatistics(domain_names=None, upstream_statistics=None)¶

Bases: vmware.vapi.bindings.struct.VapiStruct

Statistics counters of the DNS forwarder zone.

Tip

The arguments are used to initialize data attributes with the same names.

Parameters

domain_names (list of str or None) – Domain names configured for the forwarder. Empty if this is the default forwarder. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
upstream_statistics (list of NsxtUpstreamServerStatistics or None) – Statistics per upstream server. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.

class com.vmware.nsx_policy.model_client.NsxtDnsAnswer(authoritative_answers=None, dns_server=None, edge_node_id=None, non_authoritative_answers=None, raw_answer=None, enforcement_point_path=None, resource_type='NsxTDnsAnswer')¶

Bases: vmware.vapi.bindings.struct.VapiStruct

Answer of dns nslookup

Tip

The arguments are used to initialize data attributes with the same names.

Parameters

authoritative_answers (list of NsxtDnsQueryAnswer or None) – Authoritative answers
dns_server (str) – Dns server ip address and port, format is “ip address#port”.
edge_node_id (str) – ID of the edge node that performed the query.
non_authoritative_answers (list of NsxtDnsQueryAnswer or None) – Non authoritative answers
raw_answer (str or None) – It can be NXDOMAIN or error message which is not consisted of authoritative_answer or non_authoritative_answer.
enforcement_point_path (str or None) – Policy path referencing the enforcement point from where the DNS forwarder nslookup answer is fetched. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
resource_type (str) –
Possible values are:
- PolicyDnsAnswerPerEnforcementPoint.RESOURCE_TYPE_NSXTDNSANSWER
  
  Resource type of the DNS forwarder nslookup answer.

property resource_type¶: Return the discriminator value

class com.vmware.nsx_policy.model_client.NsxtDnsQueryAnswer(address=None, name=None)¶

Bases: vmware.vapi.bindings.struct.VapiStruct

Answer of nslookup

Tip

The arguments are used to initialize data attributes with the same names.

Parameters

address (str or None) – Resolved IP address matched with the nslookup address provided as a request parameter.
name (str or None) – Matched name of the given address.

class com.vmware.nsx_policy.model_client.NsxtPerNodeUsedCacheStatistics(cached_entries=None, node_id=None, used_cache_size=None)¶

Bases: vmware.vapi.bindings.struct.VapiStruct

Query statistics counters of used cache from node

Tip

The arguments are used to initialize data attributes with the same names.

Parameters

cached_entries (long or None) – The total number of cached entries format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
node_id (str or None) – UUID of active/standby transport node This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
used_cache_size (long or None) – The memory size used in cache, in kb format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.

class com.vmware.nsx_policy.model_client.NsxtUpstreamServerStatistics(queries_failed=None, queries_succeeded=None, upstream_server=None)¶

Bases: vmware.vapi.bindings.struct.VapiStruct

Query statistics counters to an upstream server including successfully forwarded queries and failed queries.

Tip

The arguments are used to initialize data attributes with the same names.

Parameters

queries_failed (long or None) – Queries failed to forward. format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
queries_succeeded (long or None) – Queries forwarded successfully format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
upstream_server (str or None) – Upstream server ip format: ip This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.

class com.vmware.nsx_policy.model_client.ObjectRolePermissionGroup(links=None, schema=None, self_=None, revision=None, create_time=None, create_user=None, last_modified_time=None, last_modified_user=None, protection=None, system_owned=None, description=None, display_name=None, id=None, resource_type=None, tags=None, inheritance_disabled=None, operation=None, path_prefix=None, role_name=None, rule_disabled=None)¶

Bases: vmware.vapi.bindings.struct.VapiStruct

RBAC Objects qualifier

Tip

The arguments are used to initialize data attributes with the same names.

Parameters

links (list of ResourceLink or None) – The server will populate this field when returing the resource. Ignored on PUT and POST. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
schema (str or None) – Schema for this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
self (SelfResourceLink or None) – Link to this resource
revision (long or None) – The _revision property describes the current revision of the resource. To prevent clients from overwriting each other’s changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected. format: int32
create_time (long or None) – Timestamp of resource creation format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
create_user (str or None) – ID of the user who created this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
last_modified_time (long or None) – Timestamp of last modification format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
last_modified_user (str or None) – ID of the user who last modified this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
protection (str or None) – Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super user and can modify it, but only when providing the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this entity. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
system_owned (bool or None) – Indicates system owned resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
description (str or None) – Description of this resource
display_name (str or None) – Defaults to ID if not set
id (str or None) – Unique identifier of this resource
resource_type (str or None) – The type of this resource.
tags (list of Tag or None) – Opaque identifiers meaningful to the API user
inheritance_disabled (bool or None) – Does children of this object inherit this rule
operation (str or None) –
Possible values are:
- ObjectRolePermissionGroup.OPERATION_CRUD
- ObjectRolePermissionGroup.OPERATION_READ
- ObjectRolePermissionGroup.OPERATION_EXECUTE
- ObjectRolePermissionGroup.OPERATION_NONE
Allowed operation
path_prefix (str) – Path prefix
role_name (str) – Role name
rule_disabled (bool or None) – Is rule disabled or not

OPERATION_CRUD = 'crud'¶

OPERATION_EXECUTE = 'execute'¶

OPERATION_NONE = 'none'¶

OPERATION_READ = 'read'¶

class com.vmware.nsx_policy.model_client.ObjectRolePermissionGroupListResult(links=None, schema=None, self_=None, cursor=None, result_count=None, sort_ascending=None, sort_by=None, results=None)¶

Bases: vmware.vapi.bindings.struct.VapiStruct

Paged collection of RBAC Objects

Tip

The arguments are used to initialize data attributes with the same names.

Parameters

links (list of ResourceLink or None) – The server will populate this field when returing the resource. Ignored on PUT and POST. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
schema (str or None) – Schema for this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
self (SelfResourceLink or None) – Link to this resource
cursor (str or None) – Opaque cursor to be used for getting next page of records (supplied by current result page) This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
result_count (long or None) – Count of results found (across all pages), set only on first page format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
sort_ascending (bool or None) – If true, results are sorted in ascending order This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
sort_by (str or None) – Field by which records are sorted This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
results (list of ObjectRolePermissionGroup) – ObjectRolePermissionGroup list results

class com.vmware.nsx_policy.model_client.PacketTypeAndCounter(counter=None, packet_type=None)¶

Bases: vmware.vapi.bindings.struct.VapiStruct

Tip

The arguments are used to initialize data attributes with the same names.

Parameters

counter (long) – The number of packets. format: int64
packet_type (str) – The type of the packets

class com.vmware.nsx_policy.model_client.PacketsDroppedBySecurity(bpdu_filter_dropped=None, dhcp_client_dropped_ipv4=None, dhcp_client_dropped_ipv6=None, dhcp_server_dropped_ipv4=None, dhcp_server_dropped_ipv6=None, spoof_guard_dropped=None)¶

Bases: vmware.vapi.bindings.struct.VapiStruct

Tip

The arguments are used to initialize data attributes with the same names.

Parameters

bpdu_filter_dropped (long or None) – The number of packets dropped by “BPDU filter”. format: int64
dhcp_client_dropped_ipv4 (long or None) – The number of IPv4 packets dropped by “DHCP client block”. format: int64
dhcp_client_dropped_ipv6 (long or None) – The number of IPv6 packets dropped by “DHCP client block”. format: int64
dhcp_server_dropped_ipv4 (long or None) – The number of IPv4 packets dropped by “DHCP server block”. format: int64
dhcp_server_dropped_ipv6 (long or None) – The number of IPv6 packets dropped by “DHCP server block”. format: int64
spoof_guard_dropped (list of PacketTypeAndCounter or None) – The packets dropped by “Spoof Guard”; supported packet types are IPv4, IPv6, ARP, ND, non-IP.

class com.vmware.nsx_policy.model_client.PatchResources(body=None, injections=None, resource_type='PatchResources')¶

Bases: vmware.vapi.bindings.struct.VapiStruct

Patch Resources is an action to create/patch resources in response to an event.

Tip

The arguments are used to initialize data attributes with the same names.

Parameters

body (vmware.vapi.struct.VapiStruct) – Patch body representing a Hierarchical Patch payload. The resources included in the body are patched replacing the injections’ keys with their actual values.
injections (list of Injection or None) – Injections holding keys (variables) and their corresponding values.
resource_type (str) –
Possible values are:
- Action.RESOURCE_TYPE_PATCHRESOURCES
- Action.RESOURCE_TYPE_SETFIELDS
Reaction Action resource type.

property resource_type¶: Return the discriminator value

class com.vmware.nsx_policy.model_client.PathExpression(paths=None, links=None, schema=None, self_=None, revision=None, create_time=None, create_user=None, last_modified_time=None, last_modified_user=None, protection=None, system_owned=None, description=None, display_name=None, id=None, resource_type='PathExpression', tags=None, parent_path=None, path=None, relative_path=None, children=None, marked_for_delete=None)¶

Bases: vmware.vapi.bindings.struct.VapiStruct

Represents policy path expressions in the form of an array, to support addition of objects like groups, segments and policy logical ports in a group.

Tip

The arguments are used to initialize data attributes with the same names.

Parameters

paths (list of str) – This array can consist of one or more policy paths. Only policy paths of groups, segments and policy logical ports are allowed.
links (list of ResourceLink or None) – The server will populate this field when returing the resource. Ignored on PUT and POST. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
schema (str or None) – Schema for this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
self (SelfResourceLink or None) – Link to this resource
revision (long or None) – The _revision property describes the current revision of the resource. To prevent clients from overwriting each other’s changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected. format: int32
create_time (long or None) – Timestamp of resource creation format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
create_user (str or None) – ID of the user who created this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
last_modified_time (long or None) – Timestamp of last modification format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
last_modified_user (str or None) – ID of the user who last modified this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
protection (str or None) – Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super user and can modify it, but only when providing the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this entity. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
system_owned (bool or None) – Indicates system owned resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
description (str or None) – Description of this resource
display_name (str or None) – Defaults to ID if not set
id (str or None) – Unique identifier of this resource
resource_type (str) –
Possible values are:
- Expression.RESOURCE_TYPE_CONDITION
- Expression.RESOURCE_TYPE_CONJUNCTIONOPERATOR
- Expression.RESOURCE_TYPE_NESTEDEXPRESSION
- Expression.RESOURCE_TYPE_IPADDRESSEXPRESSION
- Expression.RESOURCE_TYPE_MACADDRESSEXPRESSION
- Expression.RESOURCE_TYPE_EXTERNALIDEXPRESSION
- Expression.RESOURCE_TYPE_PATHEXPRESSION
- Expression.RESOURCE_TYPE_IDENTITYGROUPEXPRESSION
tags (list of Tag or None) – Opaque identifiers meaningful to the API user
parent_path (str or None) – Path of its parent This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
path (str or None) – Absolute path of this object This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
relative_path (str or None) – Path relative from its parent This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
children (list of vmware.vapi.struct.VapiStruct or None) – subtree for this type within policy tree containing nested elements. When clients pass a value of this class as a parameter, the attribute must contain all the attributes defined in ChildPolicyConfigResource. When methods return a value of this class as a return value, the attribute will contain all the attributes defined in ChildPolicyConfigResource.
marked_for_delete (bool or None) – Intent objects are not directly deleted from the system when a delete is invoked on them. They are marked for deletion and only when all the realized entities for that intent object gets deleted, the intent object is deleted. Objects that are marked for deletion are not returned in GET call. One can use the search API to get these objects. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.

property resource_type¶: Return the discriminator value

class com.vmware.nsx_policy.model_client.PathPermissionGroup(object_path=None, operation=None)¶

Bases: vmware.vapi.bindings.struct.VapiStruct

RBAC Objects qualifier

Tip

The arguments are used to initialize data attributes with the same names.

Parameters

object_path (str) – Full Object Path
operation (str) –
Possible values are:
Allowed operation

OPERATION_CRUD = 'crud'¶

OPERATION_EXECUTE = 'execute'¶

OPERATION_NONE = 'none'¶

OPERATION_READ = 'read'¶

class com.vmware.nsx_policy.model_client.PointDefinition(drilldown_id=None, field=None, navigation=None, tooltip=None, x_value=None, y_value=None)¶

Bases: vmware.vapi.bindings.struct.VapiStruct

Defines the point of a graph.

Tip

The arguments are used to initialize data attributes with the same names.

Parameters

drilldown_id (str or None) – Id of drilldown widget, if any. Id should be a valid id of an existing widget. A widget is considered as drilldown widget when it is associated with any other widget and provides more detailed information about any data item from the parent widget.
field (str) – An expression that represents the points of the graph
navigation (str or None) – Hyperlink of the specified UI page that provides details.
tooltip (list of Tooltip or None) – Multi-line text to be shown on tooltip while hovering over the point of a graph.
x_value (str) – Represents the variable for the X value of points that are plotted on the graph.
y_value (str) – Represents the variable for the Y value of points that are plotted on the graph.

class com.vmware.nsx_policy.model_client.Policy(links=None, schema=None, self_=None, revision=None, create_time=None, create_user=None, last_modified_time=None, last_modified_user=None, protection=None, system_owned=None, description=None, display_name=None, id=None, resource_type=None, tags=None, parent_path=None, path=None, relative_path=None, children=None, marked_for_delete=None, category=None, comments=None, lock_modified_by=None, lock_modified_time=None, locked=None, scope=None, sequence_number=None, stateful=None, tcp_strict=None)¶

Bases: vmware.vapi.bindings.struct.VapiStruct

Ordered list of Rules. This object is created by default along with the Domain.

Tip

The arguments are used to initialize data attributes with the same names.

Parameters

links (list of ResourceLink or None) – The server will populate this field when returing the resource. Ignored on PUT and POST. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
schema (str or None) – Schema for this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
self (SelfResourceLink or None) – Link to this resource
revision (long or None) – The _revision property describes the current revision of the resource. To prevent clients from overwriting each other’s changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected. format: int32
create_time (long or None) – Timestamp of resource creation format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
create_user (str or None) – ID of the user who created this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
last_modified_time (long or None) – Timestamp of last modification format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
last_modified_user (str or None) – ID of the user who last modified this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
protection (str or None) – Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super user and can modify it, but only when providing the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this entity. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
system_owned (bool or None) – Indicates system owned resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
description (str or None) – Description of this resource
display_name (str or None) – Defaults to ID if not set
id (str or None) – Unique identifier of this resource
resource_type (str or None) – The type of this resource.
tags (list of Tag or None) – Opaque identifiers meaningful to the API user
parent_path (str or None) – Path of its parent This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
path (str or None) – Absolute path of this object This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
relative_path (str or None) – Path relative from its parent This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
children (list of vmware.vapi.struct.VapiStruct or None) – subtree for this type within policy tree containing nested elements. When clients pass a value of this class as a parameter, the attribute must contain all the attributes defined in ChildPolicyConfigResource. When methods return a value of this class as a return value, the attribute will contain all the attributes defined in ChildPolicyConfigResource.
marked_for_delete (bool or None) – Intent objects are not directly deleted from the system when a delete is invoked on them. They are marked for deletion and only when all the realized entities for that intent object gets deleted, the intent object is deleted. Objects that are marked for deletion are not returned in GET call. One can use the search API to get these objects. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
category (str or None) –
- Distributed Firewall - Policy framework provides five pre-defined
categories for classifying a security policy. They are “Ethernet”,”Emergency”, “Infrastructure” “Environment” and “Application”. There is a pre-determined order in which the policy framework manages the priority of these security policies. Ethernet category is for supporting layer 2 firewall rules. The other four categories are applicable for layer 3 rules. Amongst them, the Emergency category has the highest priority followed by Infrastructure, Environment and then Application rules. Administrator can choose to categorize a security policy into the above categories or can choose to leave it empty. If empty it will have the least precedence w.r.t the above four categories. - Edge Firewall - Policy Framework for Edge Firewall provides six pre-defined categories “Emergency”, “SystemRules”, “SharedPreRules”, “LocalGatewayRules”, “AutoServiceRules” and “Default”, in order of priority of rules. All categories are allowed for Gatetway Policies that belong to ‘default’ Domain. However, for user created domains, category is restricted to “SharedPreRules” or “LocalGatewayRules” only. Also, the users can add/modify/delete rules from only the “SharedPreRules” and “LocalGatewayRules” categories. If user doesn’t specify the category then defaulted to “Rules”. System generated category is used by NSX created rules, for example BFD rules. Autoplumbed category used by NSX verticals to autoplumb data path rules. Finally, “Default” category is the placeholder default rules with lowest in the order of priority.
comments (str or None) – Comments for security policy lock/unlock.
lock_modified_by (str or None) – ID of the user who last modified the lock for the secruity policy. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
lock_modified_time (long or None) – SecurityPolicy locked/unlocked time in epoch milliseconds. format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
locked (bool or None) – Indicates whether a security policy should be locked. If the security policy is locked by a user, then no other user would be able to modify this security policy. Once the user releases the lock, other users can update this security policy.
scope (list of str or None) – The list of group paths where the rules in this policy will get applied. This scope will take precedence over rule level scope. Supported only for security policies.
sequence_number (long or None) – This field is used to resolve conflicts between security policies across domains. In order to change the sequence number of a policy one can fire a POST request on the policy entity with a query parameter action=revise The sequence number field will reflect the value of the computed sequence number upon execution of the above mentioned POST request. For scenarios where the administrator is using a template to update several security policies, the only way to set the sequence number is to explicitly specify the sequence number for each security policy. If no sequence number is specified in the payload, a value of 0 is assigned by default. If there are multiple policies with the same sequence number then their order is not deterministic. If a specific order of policies is desired, then one has to specify unique sequence numbers or use the POST request on the policy entity with a query parameter action=revise to let the framework assign a sequence number format: int32
stateful (bool or None) – Stateful or Stateless nature of security policy is enforced on all rules in this security policy. When it is stateful, the state of the network connects are tracked and a stateful packet inspection is performed. Layer3 security policies can be stateful or stateless. By default, they are stateful. Layer2 security policies can only be stateless.
tcp_strict (bool or None) – Ensures that a 3 way TCP handshake is done before the data packets are sent. tcp_strict=true is supported only for stateful security policies.

class com.vmware.nsx_policy.model_client.PolicyAlarmResource(links=None, schema=None, self_=None, revision=None, create_time=None, create_user=None, last_modified_time=None, last_modified_user=None, protection=None, system_owned=None, description=None, display_name=None, id=None, resource_type=None, tags=None, parent_path=None, path=None, relative_path=None, error_details=None, message=None, source_reference=None)¶

Bases: vmware.vapi.bindings.struct.VapiStruct

Alarm base class of realized policy object

Tip

The arguments are used to initialize data attributes with the same names.

Parameters

links (list of ResourceLink or None) – The server will populate this field when returing the resource. Ignored on PUT and POST. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
schema (str or None) – Schema for this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
self (SelfResourceLink or None) – Link to this resource
revision (long or None) – The _revision property describes the current revision of the resource. To prevent clients from overwriting each other’s changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected. format: int32
create_time (long or None) – Timestamp of resource creation format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
create_user (str or None) – ID of the user who created this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
last_modified_time (long or None) – Timestamp of last modification format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
last_modified_user (str or None) – ID of the user who last modified this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
protection (str or None) – Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super user and can modify it, but only when providing the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this entity. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
system_owned (bool or None) – Indicates system owned resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
description (str or None) – Description of this resource
display_name (str or None) – Defaults to ID if not set
id (str or None) – Unique identifier of this resource
resource_type (str or None) – The type of this resource.
tags (list of Tag or None) – Opaque identifiers meaningful to the API user
parent_path (str or None) – Path of its parent This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
path (str or None) – Absolute path of this object This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
relative_path (str or None) – Path relative from its parent This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
error_details (PolicyApiError or None) – Detailed information about errors from an API call made to the enforcement point, if any.
message (str or None) – error message to describe the issue
source_reference (str or None) – path of the object on which alarm is created

class com.vmware.nsx_policy.model_client.PolicyAlarmResourceListResult(links=None, schema=None, self_=None, cursor=None, result_count=None, sort_ascending=None, sort_by=None, results=None)¶

Bases: vmware.vapi.bindings.struct.VapiStruct

PolicyAlarmResource list result

Tip

The arguments are used to initialize data attributes with the same names.

Parameters

links (list of ResourceLink or None) – The server will populate this field when returing the resource. Ignored on PUT and POST. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
schema (str or None) – Schema for this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
self (SelfResourceLink or None) – Link to this resource
cursor (str or None) – Opaque cursor to be used for getting next page of records (supplied by current result page) This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
result_count (long or None) – Count of results found (across all pages), set only on first page format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
sort_ascending (bool or None) – If true, results are sorted in ascending order This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
sort_by (str or None) – Field by which records are sorted This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
results (list of PolicyAlarmResource or None) – List of alarm resources

class com.vmware.nsx_policy.model_client.PolicyApiError(details=None, error_code=None, error_data=None, error_message=None, module_name=None, related_errors=None)¶

Bases: vmware.vapi.bindings.struct.VapiStruct

Detailed information about an API Error

Tip

The arguments are used to initialize data attributes with the same names.

Parameters

details (str or None) – Further details about the error
error_code (long or None) – A numeric error code format: int64
error_data (vmware.vapi.struct.VapiStruct or None) – Additional data about the error
error_message (str or None) – A description of the error
module_name (str or None) – The module name where the error occurred
related_errors (list of PolicyRelatedApiError or None) – Other errors related to this error

class com.vmware.nsx_policy.model_client.PolicyAttributes(datatype=None, description=None, is_alg_type=None, key=None, sub_attributes=None, value=None)¶

Bases: vmware.vapi.bindings.struct.VapiStruct

Policy Attributes data holder

Tip

The arguments are used to initialize data attributes with the same names.

Parameters

datatype (str) –
Possible values are:
- PolicyAttributes.DATATYPE_STRING
Datatype for attribute
description (str or None) – Description for attribute value
is_alg_type (bool or None) – Describes whether the APP_ID value is ALG type or not.
key (str) –
Possible values are:
- PolicyAttributes.KEY_APP_ID
- PolicyAttributes.KEY_DOMAIN_NAME
Key for attribute
sub_attributes (list of PolicySubAttributes or None) – Reference to sub attributes for the attribute
value (list of str) – Multiple attribute values can be specified as elements of array.

DATATYPE_STRING = 'STRING'¶

KEY_APP_ID = 'APP_ID'¶

KEY_DOMAIN_NAME = 'DOMAIN_NAME'¶

class com.vmware.nsx_policy.model_client.PolicyBasedIPSecVpnSession(rules=None, links=None, schema=None, self_=None, revision=None, create_time=None, create_user=None, last_modified_time=None, last_modified_user=None, protection=None, system_owned=None, description=None, display_name=None, id=None, resource_type='PolicyBasedIPSecVpnSession', tags=None, parent_path=None, path=None, relative_path=None, children=None, marked_for_delete=None, authentication_mode=None, compliance_suite=None, connection_initiation_mode=None, dpd_profile_path=None, enabled=None, ike_profile_path=None, local_endpoint_path=None, peer_address=None, peer_id=None, psk=None, tcp_mss_clamping=None, tunnel_profile_path=None)¶

Bases: vmware.vapi.bindings.struct.VapiStruct

A Policy Based VPN requires to define protect rules that match local and peer subnets. IPSec security associations is negotiated for each pair of local and peer subnet.

Tip

The arguments are used to initialize data attributes with the same names.

Parameters

rules (list of IPSecVpnRule) – Rules
links (list of ResourceLink or None) – The server will populate this field when returing the resource. Ignored on PUT and POST. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
schema (str or None) – Schema for this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
self (SelfResourceLink or None) – Link to this resource
revision (long or None) – The _revision property describes the current revision of the resource. To prevent clients from overwriting each other’s changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected. format: int32
create_time (long or None) – Timestamp of resource creation format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
create_user (str or None) – ID of the user who created this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
last_modified_time (long or None) – Timestamp of last modification format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
last_modified_user (str or None) – ID of the user who last modified this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
protection (str or None) – Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super user and can modify it, but only when providing the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this entity. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
system_owned (bool or None) – Indicates system owned resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
description (str or None) – Description of this resource
display_name (str or None) – Defaults to ID if not set
id (str or None) – Unique identifier of this resource
resource_type (str) –
Possible values are:
- IPSecVpnSession.RESOURCE_TYPE_POLICYBASEDIPSECVPNSESSION
- IPSecVpnSession.RESOURCE_TYPE_ROUTEBASEDIPSECVPNSESSION
A Policy Based VPN requires to define protect rules that match local and peer subnets. IPSec security associations is negotiated for each pair of local and peer subnet. A Route Based VPN is more flexible, more powerful and recommended over policy based VPN. IP Tunnel port is created and all traffic routed via tunnel port is protected. Routes can be configured statically or can be learned through BGP. A route based VPN is must for establishing redundant VPN session to remote site.
tags (list of Tag or None) – Opaque identifiers meaningful to the API user
parent_path (str or None) – Path of its parent This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
path (str or None) – Absolute path of this object This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
relative_path (str or None) – Path relative from its parent This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
children (list of vmware.vapi.struct.VapiStruct or None) – subtree for this type within policy tree containing nested elements. When clients pass a value of this class as a parameter, the attribute must contain all the attributes defined in ChildPolicyConfigResource. When methods return a value of this class as a return value, the attribute will contain all the attributes defined in ChildPolicyConfigResource.
marked_for_delete (bool or None) – Intent objects are not directly deleted from the system when a delete is invoked on them. They are marked for deletion and only when all the realized entities for that intent object gets deleted, the intent object is deleted. Objects that are marked for deletion are not returned in GET call. One can use the search API to get these objects. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
authentication_mode (str or None) –
Possible values are:
- IPSecVpnSession.AUTHENTICATION_MODE_PSK
- IPSecVpnSession.AUTHENTICATION_MODE_CERTIFICATE
Peer authentication mode. PSK - In this mode a secret key shared between local and peer sites is to be used for authentication. The secret key can be a string with a maximum length of 128 characters. CERTIFICATE - In this mode a certificate defined at the global level is to be used for authentication.
compliance_suite (str or None) –
Possible values are:
- IPSecVpnSession.COMPLIANCE_SUITE_CNSA
- IPSecVpnSession.COMPLIANCE_SUITE_SUITE_B_GCM_128
- IPSecVpnSession.COMPLIANCE_SUITE_SUITE_B_GCM_256
- IPSecVpnSession.COMPLIANCE_SUITE_PRIME
- IPSecVpnSession.COMPLIANCE_SUITE_FOUNDATION
- IPSecVpnSession.COMPLIANCE_SUITE_FIPS
- IPSecVpnSession.COMPLIANCE_SUITE_NONE
Compliance suite.
connection_initiation_mode (str or None) –
Possible values are:
- IPSecVpnSession.CONNECTION_INITIATION_MODE_INITIATOR
- IPSecVpnSession.CONNECTION_INITIATION_MODE_RESPOND_ONLY
- IPSecVpnSession.CONNECTION_INITIATION_MODE_ON_DEMAND
Connection initiation mode used by local endpoint to establish ike connection with peer site. INITIATOR - In this mode local endpoint initiates tunnel setup and will also respond to incoming tunnel setup requests from peer gateway. RESPOND_ONLY - In this mode, local endpoint shall only respond to incoming tunnel setup requests. It shall not initiate the tunnel setup. ON_DEMAND - In this mode local endpoint will initiate tunnel creation once first packet matching the policy rule is received and will also respond to incoming initiation request.
dpd_profile_path (str or None) – Policy path referencing Dead Peer Detection (DPD) profile. Default is set to system default profile.
enabled (bool or None) – Enable/Disable IPSec VPN session.
ike_profile_path (str or None) – Policy path referencing IKE profile to be used. Default is set according to system default profile.
local_endpoint_path (str) – Policy path referencing Local endpoint.
peer_address (str) – Public IPV4 address of the remote device terminating the VPN connection.
peer_id (str) – Peer ID to uniquely identify the peer site. The peer ID is the public IP address of the remote device terminating the VPN tunnel. When NAT is configured for the peer, enter the private IP address of the peer.
psk (str or None) – IPSec Pre-shared key. Maximum length of this field is 128 characters.
tcp_mss_clamping (TcpMaximumSegmentSizeClamping or None) – TCP Maximum Segment Size Clamping Direction and Value.
tunnel_profile_path (str or None) – Policy path referencing Tunnel profile to be used. Default is set to system default profile.

property resource_type¶: Return the discriminator value

class com.vmware.nsx_policy.model_client.PolicyBasedL3VpnSession(rules=None, resource_type='PolicyBasedL3VpnSession')¶

Bases: vmware.vapi.bindings.struct.VapiStruct

A Policy-based L3Vpn session is a configuration in which a specific vpn tunnel is referenced in a policy whose action is set as tunnel.

Tip

The arguments are used to initialize data attributes with the same names.

Parameters

rules (list of L3VpnRule or None) – L3Vpn rules that are specific to the L3Vpn. Only L3Vpn rules with PROTECT action are supported.
resource_type (str) –
Possible values are:
- L3VpnSession.RESOURCE_TYPE_POLICYBASEDL3VPNSESSION
- L3VpnSession.RESOURCE_TYPE_ROUTEBASEDL3VPNSESSION
- A Policy Based L3Vpn is a configuration in which protect rules to
match local and remote subnet needs to be defined. Tunnel is established for each pair of local and remote subnet defined in protect rules. - A Route Based L3Vpn is more flexible, more powerful and recommended over policy based. IP Tunnel subnet is created and all traffic routed through tunnel subnet (commonly known as VTI) is sent over tunnel. Routes can be learned through BGP. A route based L3Vpn is required when using redundant L3Vpn.

property resource_type¶: Return the discriminator value

class com.vmware.nsx_policy.model_client.PolicyComplianceStatus(last_updated_time=None, non_compliant_configs=None)¶

Bases: vmware.vapi.bindings.struct.VapiStruct

Tip

The arguments are used to initialize data attributes with the same names.

Parameters

last_updated_time (long or None) – Timestamp of last update format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
non_compliant_configs (list of PolicyNonCompliantConfig or None) – List of non compliant configuration and impacted services This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.

class com.vmware.nsx_policy.model_client.PolicyConfigResource(links=None, schema=None, self_=None, revision=None, create_time=None, create_user=None, last_modified_time=None, last_modified_user=None, protection=None, system_owned=None, description=None, display_name=None, id=None, resource_type=None, tags=None, parent_path=None, path=None, relative_path=None, children=None, marked_for_delete=None)¶

Bases: vmware.vapi.bindings.struct.VapiStruct

Represents an object on the desired state.

Tip

The arguments are used to initialize data attributes with the same names.

Parameters

links (list of ResourceLink or None) – The server will populate this field when returing the resource. Ignored on PUT and POST. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
schema (str or None) – Schema for this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
self (SelfResourceLink or None) – Link to this resource
revision (long or None) – The _revision property describes the current revision of the resource. To prevent clients from overwriting each other’s changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected. format: int32
create_time (long or None) – Timestamp of resource creation format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
create_user (str or None) – ID of the user who created this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
last_modified_time (long or None) – Timestamp of last modification format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
last_modified_user (str or None) – ID of the user who last modified this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
protection (str or None) – Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super user and can modify it, but only when providing the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this entity. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
system_owned (bool or None) – Indicates system owned resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
description (str or None) – Description of this resource
display_name (str or None) – Defaults to ID if not set
id (str or None) – Unique identifier of this resource
resource_type (str or None) – The type of this resource.
tags (list of Tag or None) – Opaque identifiers meaningful to the API user
parent_path (str or None) – Path of its parent This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
path (str or None) – Absolute path of this object This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
relative_path (str or None) – Path relative from its parent This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
children (list of vmware.vapi.struct.VapiStruct or None) – subtree for this type within policy tree containing nested elements. When clients pass a value of this class as a parameter, the attribute must contain all the attributes defined in ChildPolicyConfigResource. When methods return a value of this class as a return value, the attribute will contain all the attributes defined in ChildPolicyConfigResource.
marked_for_delete (bool or None) – Intent objects are not directly deleted from the system when a delete is invoked on them. They are marked for deletion and only when all the realized entities for that intent object gets deleted, the intent object is deleted. Objects that are marked for deletion are not returned in GET call. One can use the search API to get these objects. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.

class com.vmware.nsx_policy.model_client.PolicyContextProfile(links=None, schema=None, self_=None, revision=None, create_time=None, create_user=None, last_modified_time=None, last_modified_user=None, protection=None, system_owned=None, description=None, display_name=None, id=None, resource_type=None, tags=None, parent_path=None, path=None, relative_path=None, children=None, marked_for_delete=None, attributes=None)¶

Bases: vmware.vapi.bindings.struct.VapiStruct

An entity that encapsulates attributes and sub-attributes of various network services (eg. L7 services, domain name, encryption algorithm) The entity will be consumed in firewall rules and can be added in new tuple called profile in firewall rules. To get a list of supported attributes and sub-attributes fire the following REST API GET https://<policy-mgr>/policy/api/v1/infra/context-profiles/attributes

Tip

The arguments are used to initialize data attributes with the same names.

Parameters

links (list of ResourceLink or None) – The server will populate this field when returing the resource. Ignored on PUT and POST. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
schema (str or None) – Schema for this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
self (SelfResourceLink or None) – Link to this resource
revision (long or None) – The _revision property describes the current revision of the resource. To prevent clients from overwriting each other’s changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected. format: int32
create_time (long or None) – Timestamp of resource creation format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
create_user (str or None) – ID of the user who created this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
last_modified_time (long or None) – Timestamp of last modification format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
last_modified_user (str or None) – ID of the user who last modified this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
protection (str or None) – Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super user and can modify it, but only when providing the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this entity. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
system_owned (bool or None) – Indicates system owned resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
description (str or None) – Description of this resource
display_name (str or None) – Defaults to ID if not set
id (str or None) – Unique identifier of this resource
resource_type (str or None) – The type of this resource.
tags (list of Tag or None) – Opaque identifiers meaningful to the API user
parent_path (str or None) – Path of its parent This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
path (str or None) – Absolute path of this object This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
relative_path (str or None) – Path relative from its parent This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
children (list of vmware.vapi.struct.VapiStruct or None) – subtree for this type within policy tree containing nested elements. When clients pass a value of this class as a parameter, the attribute must contain all the attributes defined in ChildPolicyConfigResource. When methods return a value of this class as a return value, the attribute will contain all the attributes defined in ChildPolicyConfigResource.
marked_for_delete (bool or None) – Intent objects are not directly deleted from the system when a delete is invoked on them. They are marked for deletion and only when all the realized entities for that intent object gets deleted, the intent object is deleted. Objects that are marked for deletion are not returned in GET call. One can use the search API to get these objects. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
attributes (list of PolicyAttributes) – Property containing attributes/sub-attributes for Policy Context Profile.

class com.vmware.nsx_policy.model_client.PolicyContextProfileListResult(links=None, schema=None, self_=None, cursor=None, result_count=None, sort_ascending=None, sort_by=None, results=None)¶

Bases: vmware.vapi.bindings.struct.VapiStruct

List result of PolicyContextProfiles

Tip

The arguments are used to initialize data attributes with the same names.

Parameters

links (list of ResourceLink or None) – The server will populate this field when returing the resource. Ignored on PUT and POST. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
schema (str or None) – Schema for this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
self (SelfResourceLink or None) – Link to this resource
cursor (str or None) – Opaque cursor to be used for getting next page of records (supplied by current result page) This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
result_count (long or None) – Count of results found (across all pages), set only on first page format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
sort_ascending (bool or None) – If true, results are sorted in ascending order This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
sort_by (str or None) – Field by which records are sorted This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
results (list of PolicyContextProfile or None) – Paged collection of PolicyContextProfiles This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.

class com.vmware.nsx_policy.model_client.PolicyDnsAnswerPerEnforcementPoint(enforcement_point_path=None, resource_type='PolicyDnsAnswerPerEnforcementPoint')¶

Bases: vmware.vapi.bindings.struct.VapiStruct

DNS forwarder nslookup answer per enforcement point.

Tip

The arguments are used to initialize data attributes with the same names.

Parameters

enforcement_point_path (str or None) – Policy path referencing the enforcement point from where the DNS forwarder nslookup answer is fetched. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
resource_type (str) –
Possible values are:
- PolicyDnsAnswerPerEnforcementPoint.RESOURCE_TYPE_NSXTDNSANSWER
  
  Resource type of the DNS forwarder nslookup answer.

RESOURCE_TYPE_NSXTDNSANSWER = 'NsxTDnsAnswer'¶

property resource_type¶: Return the discriminator value

class com.vmware.nsx_policy.model_client.PolicyDnsForwarder(links=None, schema=None, self_=None, revision=None, create_time=None, create_user=None, last_modified_time=None, last_modified_user=None, protection=None, system_owned=None, description=None, display_name=None, id=None, resource_type=None, tags=None, parent_path=None, path=None, relative_path=None, children=None, marked_for_delete=None, conditional_forwarder_zone_paths=None, default_forwarder_zone_path=None, enabled=None, listener_ip=None, log_level=None)¶

Bases: vmware.vapi.bindings.struct.VapiStruct

Used to configure DNS Forwarder

Tip

The arguments are used to initialize data attributes with the same names.

Parameters

links (list of ResourceLink or None) – The server will populate this field when returing the resource. Ignored on PUT and POST. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
schema (str or None) – Schema for this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
self (SelfResourceLink or None) – Link to this resource
revision (long or None) – The _revision property describes the current revision of the resource. To prevent clients from overwriting each other’s changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected. format: int32
create_time (long or None) – Timestamp of resource creation format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
create_user (str or None) – ID of the user who created this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
last_modified_time (long or None) – Timestamp of last modification format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
last_modified_user (str or None) – ID of the user who last modified this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
protection (str or None) – Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super user and can modify it, but only when providing the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this entity. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
system_owned (bool or None) – Indicates system owned resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
description (str or None) – Description of this resource
display_name (str or None) – Defaults to ID if not set
id (str or None) – Unique identifier of this resource
resource_type (str or None) – The type of this resource.
tags (list of Tag or None) – Opaque identifiers meaningful to the API user
parent_path (str or None) – Path of its parent This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
path (str or None) – Absolute path of this object This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
relative_path (str or None) – Path relative from its parent This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
children (list of vmware.vapi.struct.VapiStruct or None) – subtree for this type within policy tree containing nested elements. When clients pass a value of this class as a parameter, the attribute must contain all the attributes defined in ChildPolicyConfigResource. When methods return a value of this class as a return value, the attribute will contain all the attributes defined in ChildPolicyConfigResource.
marked_for_delete (bool or None) – Intent objects are not directly deleted from the system when a delete is invoked on them. They are marked for deletion and only when all the realized entities for that intent object gets deleted, the intent object is deleted. Objects that are marked for deletion are not returned in GET call. One can use the search API to get these objects. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
conditional_forwarder_zone_paths (list of str or None) – Max of 5 DNS servers can be configured
default_forwarder_zone_path (str) – This is the zone to which DNS requests are forwarded by default
enabled (bool or None) – The flag, which suggests whether the DNS forwarder is enabled or disabled. The default is True.
listener_ip (str) – This is the IP on which the DNS Forwarder listens. format: ipv4
log_level (str or None) –
Possible values are:
- PolicyDnsForwarder.LOG_LEVEL_DEBUG
- PolicyDnsForwarder.LOG_LEVEL_INFO
- PolicyDnsForwarder.LOG_LEVEL_WARNING
- PolicyDnsForwarder.LOG_LEVEL_ERROR
- PolicyDnsForwarder.LOG_LEVEL_FATAL
Set log_level to DISABLED will stop dumping fowarder log.

LOG_LEVEL_DEBUG = 'DEBUG'¶

LOG_LEVEL_ERROR = 'ERROR'¶

LOG_LEVEL_FATAL = 'FATAL'¶

LOG_LEVEL_INFO = 'INFO'¶

LOG_LEVEL_WARNING = 'WARNING'¶

class com.vmware.nsx_policy.model_client.PolicyDnsForwarderZone(links=None, schema=None, self_=None, revision=None, create_time=None, create_user=None, last_modified_time=None, last_modified_user=None, protection=None, system_owned=None, description=None, display_name=None, id=None, resource_type=None, tags=None, parent_path=None, path=None, relative_path=None, children=None, marked_for_delete=None, dns_domain_names=None, source_ip=None, upstream_servers=None)¶

Bases: vmware.vapi.bindings.struct.VapiStruct

Used to configure zones on DNS Forwarder

Tip

The arguments are used to initialize data attributes with the same names.

Parameters

links (list of ResourceLink or None) – The server will populate this field when returing the resource. Ignored on PUT and POST. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
schema (str or None) – Schema for this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
self (SelfResourceLink or None) – Link to this resource
revision (long or None) – The _revision property describes the current revision of the resource. To prevent clients from overwriting each other’s changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected. format: int32
create_time (long or None) – Timestamp of resource creation format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
create_user (str or None) – ID of the user who created this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
last_modified_time (long or None) – Timestamp of last modification format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
last_modified_user (str or None) – ID of the user who last modified this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
protection (str or None) – Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super user and can modify it, but only when providing the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this entity. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
system_owned (bool or None) – Indicates system owned resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
description (str or None) – Description of this resource
display_name (str or None) – Defaults to ID if not set
id (str or None) – Unique identifier of this resource
resource_type (str or None) – The type of this resource.
tags (list of Tag or None) – Opaque identifiers meaningful to the API user
parent_path (str or None) – Path of its parent This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
path (str or None) – Absolute path of this object This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
relative_path (str or None) – Path relative from its parent This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
children (list of vmware.vapi.struct.VapiStruct or None) – subtree for this type within policy tree containing nested elements. When clients pass a value of this class as a parameter, the attribute must contain all the attributes defined in ChildPolicyConfigResource. When methods return a value of this class as a return value, the attribute will contain all the attributes defined in ChildPolicyConfigResource.
marked_for_delete (bool or None) – Intent objects are not directly deleted from the system when a delete is invoked on them. They are marked for deletion and only when all the realized entities for that intent object gets deleted, the intent object is deleted. Objects that are marked for deletion are not returned in GET call. One can use the search API to get these objects. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
dns_domain_names (list of str or None) – List of domain names on which conditional forwarding is based. This field is required if the DNS Zone is being used for a conditional forwarder. This field will also be used for conditional reverse lookup. Example 1, if for one of the zones, one of the entries in the fqdn is example.com, all the DNS requests under the domain example.com will be served by the corresponding upstream DNS server. Example 2, if for one of the zones, one of the entries in the fqdn list is “13.12.30.in-addr.arpa”, reverse lookup for 30.12.13.0/24 will go to the corresponding DNS server.
source_ip (str or None) – The source IP used by the DNS Forwarder zone. format: ipv4
upstream_servers (list of str) – Max of 3 DNS servers can be configured format: ipv4

class com.vmware.nsx_policy.model_client.PolicyDnsForwarderZoneListResult(links=None, schema=None, self_=None, cursor=None, result_count=None, sort_ascending=None, sort_by=None, results=None)¶

Bases: vmware.vapi.bindings.struct.VapiStruct

Paged Collection of DNS Forwarder Zones

Tip

The arguments are used to initialize data attributes with the same names.

Parameters

links (list of ResourceLink or None) – The server will populate this field when returing the resource. Ignored on PUT and POST. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
schema (str or None) – Schema for this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
self (SelfResourceLink or None) – Link to this resource
cursor (str or None) – Opaque cursor to be used for getting next page of records (supplied by current result page) This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
result_count (long or None) – Count of results found (across all pages), set only on first page format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
sort_ascending (bool or None) – If true, results are sorted in ascending order This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
sort_by (str or None) – Field by which records are sorted This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
results (list of PolicyDnsForwarderZone) – Dns Forwarder Zone list results

class com.vmware.nsx_policy.model_client.PolicyDraft(links=None, schema=None, self_=None, revision=None, create_time=None, create_user=None, last_modified_time=None, last_modified_user=None, protection=None, system_owned=None, description=None, display_name=None, id=None, resource_type=None, tags=None, parent_path=None, path=None, relative_path=None, children=None, marked_for_delete=None, is_auto_draft=None, lock_comments=None, lock_modified_by=None, lock_modified_time=None, locked=None, ref_draft_path=None, system_area=None, user_area=None)¶

Bases: vmware.vapi.bindings.struct.VapiStruct

A draft which stores the system generated as well as user intended changes in a hierarchical body format.

Tip

The arguments are used to initialize data attributes with the same names.

Parameters

links (list of ResourceLink or None) – The server will populate this field when returing the resource. Ignored on PUT and POST. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
schema (str or None) – Schema for this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
self (SelfResourceLink or None) – Link to this resource
revision (long or None) – The _revision property describes the current revision of the resource. To prevent clients from overwriting each other’s changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected. format: int32
create_time (long or None) – Timestamp of resource creation format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
create_user (str or None) – ID of the user who created this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
last_modified_time (long or None) – Timestamp of last modification format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
last_modified_user (str or None) – ID of the user who last modified this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
protection (str or None) – Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super user and can modify it, but only when providing the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this entity. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
system_owned (bool or None) – Indicates system owned resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
description (str or None) – Description of this resource
display_name (str or None) – Defaults to ID if not set
id (str or None) – Unique identifier of this resource
resource_type (str or None) – The type of this resource.
tags (list of Tag or None) – Opaque identifiers meaningful to the API user
parent_path (str or None) – Path of its parent This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
path (str or None) – Absolute path of this object This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
relative_path (str or None) – Path relative from its parent This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
children (list of vmware.vapi.struct.VapiStruct or None) – subtree for this type within policy tree containing nested elements. When clients pass a value of this class as a parameter, the attribute must contain all the attributes defined in ChildPolicyConfigResource. When methods return a value of this class as a return value, the attribute will contain all the attributes defined in ChildPolicyConfigResource.
marked_for_delete (bool or None) – Intent objects are not directly deleted from the system when a delete is invoked on them. They are marked for deletion and only when all the realized entities for that intent object gets deleted, the intent object is deleted. Objects that are marked for deletion are not returned in GET call. One can use the search API to get these objects. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
is_auto_draft (bool or None) – Flag to indicate whether draft is auto created. True indicates that the draft is an auto draft. False indicates that the draft is a manual draft. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
lock_comments (str or None) – Comments for a policy draft lock/unlock.
lock_modified_by (str or None) – ID of the user who last modified the lock for a policy draft. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
lock_modified_time (long or None) – Policy draft locked/unlocked time in epoch milliseconds. format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
locked (bool or None) – Indicates whether a draft should be locked. If the draft is locked by an user, then no other user would be able to modify or publish this draft. Once the user releases the lock, other users can then modify or publish this draft.
ref_draft_path (str or None) – When specified, a manual draft will be created w.r.t. the specified draft. If not specified, manual draft will be created w.r.t. the current published configuration. For an auto draft, this will always be null.
system_area (Infra or None) – Configuration changes against the current configuration, tracked by the system. The value is stored in a hierarchical body format.
user_area (Infra or None) – These are user defined configuration changes, which are applicable only in case of manual drafts. During the publish of a draft, system_area changes gets applied first, and then these changes. The value must be in a hierarchical body format.

class com.vmware.nsx_policy.model_client.PolicyDraftListResult(links=None, schema=None, self_=None, cursor=None, result_count=None, sort_ascending=None, sort_by=None, results=None)¶

Bases: vmware.vapi.bindings.struct.VapiStruct

This holds the list of policy drafts.

Tip

The arguments are used to initialize data attributes with the same names.

Parameters

links (list of ResourceLink or None) – The server will populate this field when returing the resource. Ignored on PUT and POST. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
schema (str or None) – Schema for this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
self (SelfResourceLink or None) – Link to this resource
cursor (str or None) – Opaque cursor to be used for getting next page of records (supplied by current result page) This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
result_count (long or None) – Count of results found (across all pages), set only on first page format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
sort_ascending (bool or None) – If true, results are sorted in ascending order This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
sort_by (str or None) – Field by which records are sorted This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
results (list of PolicyDraft or None) – Paginated list of policy drafts. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.

class com.vmware.nsx_policy.model_client.PolicyEdgeCluster(links=None, schema=None, self_=None, revision=None, create_time=None, create_user=None, last_modified_time=None, last_modified_user=None, protection=None, system_owned=None, description=None, display_name=None, id=None, resource_type=None, tags=None, parent_path=None, path=None, relative_path=None, children=None, marked_for_delete=None, nsx_id=None)¶

Bases: vmware.vapi.bindings.struct.VapiStruct

Policy manager periodically reads edge clusters from enforcement point and corresponding read-only intent objects are auto-created.

Tip

The arguments are used to initialize data attributes with the same names.

Parameters

links (list of ResourceLink or None) – The server will populate this field when returing the resource. Ignored on PUT and POST. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
schema (str or None) – Schema for this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
self (SelfResourceLink or None) – Link to this resource
revision (long or None) – The _revision property describes the current revision of the resource. To prevent clients from overwriting each other’s changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected. format: int32
create_time (long or None) – Timestamp of resource creation format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
create_user (str or None) – ID of the user who created this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
last_modified_time (long or None) – Timestamp of last modification format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
last_modified_user (str or None) – ID of the user who last modified this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
protection (str or None) – Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super user and can modify it, but only when providing the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this entity. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
system_owned (bool or None) – Indicates system owned resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
description (str or None) – Description of this resource
display_name (str or None) – Defaults to ID if not set
id (str or None) – Unique identifier of this resource
resource_type (str or None) – The type of this resource.
tags (list of Tag or None) – Opaque identifiers meaningful to the API user
parent_path (str or None) – Path of its parent This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
path (str or None) – Absolute path of this object This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
relative_path (str or None) – Path relative from its parent This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
children (list of vmware.vapi.struct.VapiStruct or None) – subtree for this type within policy tree containing nested elements. When clients pass a value of this class as a parameter, the attribute must contain all the attributes defined in ChildPolicyConfigResource. When methods return a value of this class as a return value, the attribute will contain all the attributes defined in ChildPolicyConfigResource.
marked_for_delete (bool or None) – Intent objects are not directly deleted from the system when a delete is invoked on them. They are marked for deletion and only when all the realized entities for that intent object gets deleted, the intent object is deleted. Objects that are marked for deletion are not returned in GET call. One can use the search API to get these objects. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
nsx_id (str or None) – UUID of edge cluster on enforcement point. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.

class com.vmware.nsx_policy.model_client.PolicyEdgeClusterListResult(links=None, schema=None, self_=None, cursor=None, result_count=None, sort_ascending=None, sort_by=None, results=None)¶

Bases: vmware.vapi.bindings.struct.VapiStruct

Paged Collection of Edge Cluster

Tip

The arguments are used to initialize data attributes with the same names.

Parameters

links (list of ResourceLink or None) – The server will populate this field when returing the resource. Ignored on PUT and POST. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
schema (str or None) – Schema for this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
self (SelfResourceLink or None) – Link to this resource
cursor (str or None) – Opaque cursor to be used for getting next page of records (supplied by current result page) This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
result_count (long or None) – Count of results found (across all pages), set only on first page format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
sort_ascending (bool or None) – If true, results are sorted in ascending order This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
sort_by (str or None) – Field by which records are sorted This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
results (list of PolicyEdgeCluster) – Edge Cluster

class com.vmware.nsx_policy.model_client.PolicyEdgeNode(links=None, schema=None, self_=None, revision=None, create_time=None, create_user=None, last_modified_time=None, last_modified_user=None, protection=None, system_owned=None, description=None, display_name=None, id=None, resource_type=None, tags=None, parent_path=None, path=None, relative_path=None, children=None, marked_for_delete=None, member_index=None, nsx_id=None)¶

Bases: vmware.vapi.bindings.struct.VapiStruct

Policy manager periodically reads edge nodes from enforcement point and corresponding read-only intent objects are auto-created.

Tip

The arguments are used to initialize data attributes with the same names.

Parameters

links (list of ResourceLink or None) – The server will populate this field when returing the resource. Ignored on PUT and POST. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
schema (str or None) – Schema for this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
self (SelfResourceLink or None) – Link to this resource
revision (long or None) – The _revision property describes the current revision of the resource. To prevent clients from overwriting each other’s changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected. format: int32
create_time (long or None) – Timestamp of resource creation format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
create_user (str or None) – ID of the user who created this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
last_modified_time (long or None) – Timestamp of last modification format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
last_modified_user (str or None) – ID of the user who last modified this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
protection (str or None) – Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super user and can modify it, but only when providing the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this entity. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
system_owned (bool or None) – Indicates system owned resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
description (str or None) – Description of this resource
display_name (str or None) – Defaults to ID if not set
id (str or None) – Unique identifier of this resource
resource_type (str or None) – The type of this resource.
tags (list of Tag or None) – Opaque identifiers meaningful to the API user
parent_path (str or None) – Path of its parent This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
path (str or None) – Absolute path of this object This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
relative_path (str or None) – Path relative from its parent This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
children (list of vmware.vapi.struct.VapiStruct or None) – subtree for this type within policy tree containing nested elements. When clients pass a value of this class as a parameter, the attribute must contain all the attributes defined in ChildPolicyConfigResource. When methods return a value of this class as a return value, the attribute will contain all the attributes defined in ChildPolicyConfigResource.
marked_for_delete (bool or None) – Intent objects are not directly deleted from the system when a delete is invoked on them. They are marked for deletion and only when all the realized entities for that intent object gets deleted, the intent object is deleted. Objects that are marked for deletion are not returned in GET call. One can use the search API to get these objects. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
member_index (long or None) – Member index of edge node in edge cluster. format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
nsx_id (str or None) – UUID of edge node on enforcement point. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.

class com.vmware.nsx_policy.model_client.PolicyEdgeNodeListResult(links=None, schema=None, self_=None, cursor=None, result_count=None, sort_ascending=None, sort_by=None, results=None)¶

Bases: vmware.vapi.bindings.struct.VapiStruct

Paged Collection of Edge Node

Tip

The arguments are used to initialize data attributes with the same names.

Parameters

links (list of ResourceLink or None) – The server will populate this field when returing the resource. Ignored on PUT and POST. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
schema (str or None) – Schema for this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
self (SelfResourceLink or None) – Link to this resource
cursor (str or None) – Opaque cursor to be used for getting next page of records (supplied by current result page) This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
result_count (long or None) – Count of results found (across all pages), set only on first page format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
sort_ascending (bool or None) – If true, results are sorted in ascending order This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
sort_by (str or None) – Field by which records are sorted This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
results (list of PolicyEdgeNode) – Edge Node

class com.vmware.nsx_policy.model_client.PolicyExcludeList(links=None, schema=None, self_=None, revision=None, create_time=None, create_user=None, last_modified_time=None, last_modified_user=None, protection=None, system_owned=None, description=None, display_name=None, id=None, resource_type=None, tags=None, parent_path=None, path=None, relative_path=None, children=None, marked_for_delete=None, members=None)¶

Bases: vmware.vapi.bindings.struct.VapiStruct

Tip

The arguments are used to initialize data attributes with the same names.

Parameters

links (list of ResourceLink or None) – The server will populate this field when returing the resource. Ignored on PUT and POST. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
schema (str or None) – Schema for this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
self (SelfResourceLink or None) – Link to this resource
revision (long or None) – The _revision property describes the current revision of the resource. To prevent clients from overwriting each other’s changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected. format: int32
create_time (long or None) – Timestamp of resource creation format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
create_user (str or None) – ID of the user who created this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
last_modified_time (long or None) – Timestamp of last modification format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
last_modified_user (str or None) – ID of the user who last modified this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
protection (str or None) – Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super user and can modify it, but only when providing the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this entity. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
system_owned (bool or None) – Indicates system owned resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
description (str or None) – Description of this resource
display_name (str or None) – Defaults to ID if not set
id (str or None) – Unique identifier of this resource
resource_type (str or None) – The type of this resource.
tags (list of Tag or None) – Opaque identifiers meaningful to the API user
parent_path (str or None) – Path of its parent This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
path (str or None) – Absolute path of this object This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
relative_path (str or None) – Path relative from its parent This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
children (list of vmware.vapi.struct.VapiStruct or None) – subtree for this type within policy tree containing nested elements. When clients pass a value of this class as a parameter, the attribute must contain all the attributes defined in ChildPolicyConfigResource. When methods return a value of this class as a return value, the attribute will contain all the attributes defined in ChildPolicyConfigResource.
marked_for_delete (bool or None) – Intent objects are not directly deleted from the system when a delete is invoked on them. They are marked for deletion and only when all the realized entities for that intent object gets deleted, the intent object is deleted. Objects that are marked for deletion are not returned in GET call. One can use the search API to get these objects. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
members (list of str) – List of the members in the exclude list

class com.vmware.nsx_policy.model_client.PolicyFineTuningResourceInfo(fields=None, resource_name=None)¶

Bases: vmware.vapi.bindings.struct.VapiStruct

It represent the resource with details of name and fields it owns.

Tip

The arguments are used to initialize data attributes with the same names.

Parameters

fields (list of PolicyFineTuningResourceInfoDetail) – List of all field of any resource
resource_name (str) – It will represent resource with name and fields.

class com.vmware.nsx_policy.model_client.PolicyFineTuningResourceInfoDetail(field_name=None, sub_type=None)¶

Bases: vmware.vapi.bindings.struct.VapiStruct

Contains the details of resource field

Tip

The arguments are used to initialize data attributes with the same names.

Parameters

field_name (str) – It will represent resource with name and fields.
sub_type (PolicyFineTuningResourceInfo) – List of all field of any resource

class com.vmware.nsx_policy.model_client.PolicyFirewallFloodProtectionProfileBindingMap(links=None, schema=None, self_=None, revision=None, create_time=None, create_user=None, last_modified_time=None, last_modified_user=None, protection=None, system_owned=None, description=None, display_name=None, id=None, resource_type=None, tags=None, parent_path=None, path=None, relative_path=None, children=None, marked_for_delete=None, profile_path=None, sequence_number=None)¶

Bases: vmware.vapi.bindings.struct.VapiStruct

This entity will be used to establish association between Firewall Flood Protection profile and Group. Using this entity, user can specify intent for applying Firewall Flood Protection profile to particular Group.

Tip

The arguments are used to initialize data attributes with the same names.

Parameters

links (list of ResourceLink or None) – The server will populate this field when returing the resource. Ignored on PUT and POST. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
schema (str or None) – Schema for this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
self (SelfResourceLink or None) – Link to this resource
revision (long or None) – The _revision property describes the current revision of the resource. To prevent clients from overwriting each other’s changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected. format: int32
create_time (long or None) – Timestamp of resource creation format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
create_user (str or None) – ID of the user who created this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
last_modified_time (long or None) – Timestamp of last modification format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
last_modified_user (str or None) – ID of the user who last modified this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
protection (str or None) – Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super user and can modify it, but only when providing the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this entity. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
system_owned (bool or None) – Indicates system owned resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
description (str or None) – Description of this resource
display_name (str or None) – Defaults to ID if not set
id (str or None) – Unique identifier of this resource
resource_type (str or None) – The type of this resource.
tags (list of Tag or None) – Opaque identifiers meaningful to the API user
parent_path (str or None) – Path of its parent This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
path (str or None) – Absolute path of this object This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
relative_path (str or None) – Path relative from its parent This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
children (list of vmware.vapi.struct.VapiStruct or None) – subtree for this type within policy tree containing nested elements. When clients pass a value of this class as a parameter, the attribute must contain all the attributes defined in ChildPolicyConfigResource. When methods return a value of this class as a return value, the attribute will contain all the attributes defined in ChildPolicyConfigResource.
marked_for_delete (bool or None) – Intent objects are not directly deleted from the system when a delete is invoked on them. They are marked for deletion and only when all the realized entities for that intent object gets deleted, the intent object is deleted. Objects that are marked for deletion are not returned in GET call. One can use the search API to get these objects. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
profile_path (str) – PolicyPath of associated Profile
sequence_number (long) – Sequence number is used to resolve conflicts when two profiles get applied to a single port. Lower value gets higher precedence. Two binding maps having the same profile path should have the same sequence number. format: int64

class com.vmware.nsx_policy.model_client.PolicyFirewallFloodProtectionProfileBindingMapListResult(links=None, schema=None, self_=None, cursor=None, result_count=None, sort_ascending=None, sort_by=None, results=None)¶

Bases: vmware.vapi.bindings.struct.VapiStruct

Paged collection of Firewall Flood Protection Profile Binding Maps

Tip

The arguments are used to initialize data attributes with the same names.

Parameters

links (list of ResourceLink or None) – The server will populate this field when returing the resource. Ignored on PUT and POST. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
schema (str or None) – Schema for this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
self (SelfResourceLink or None) – Link to this resource
cursor (str or None) – Opaque cursor to be used for getting next page of records (supplied by current result page) This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
result_count (long or None) – Count of results found (across all pages), set only on first page format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
sort_ascending (bool or None) – If true, results are sorted in ascending order This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
sort_by (str or None) – Field by which records are sorted This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
results (list of PolicyFirewallFloodProtectionProfileBindingMap) – Firewall Flood Protection Profile Binding Map list results

class com.vmware.nsx_policy.model_client.PolicyFirewallSessionTimerProfile(links=None, schema=None, self_=None, revision=None, create_time=None, create_user=None, last_modified_time=None, last_modified_user=None, protection=None, system_owned=None, description=None, display_name=None, id=None, resource_type=None, tags=None, parent_path=None, path=None, relative_path=None, children=None, marked_for_delete=None, icmp_error_reply=None, icmp_first_packet=None, tcp_closed=None, tcp_closing=None, tcp_established=None, tcp_finwait=None, tcp_first_packet=None, tcp_opening=None, udp_first_packet=None, udp_multiple=None, udp_single=None)¶

Bases: vmware.vapi.bindings.struct.VapiStruct

A profile holding TCP, UDP and ICMP session timeout configuration.

Tip

The arguments are used to initialize data attributes with the same names.

Parameters

links (list of ResourceLink or None) – The server will populate this field when returing the resource. Ignored on PUT and POST. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
schema (str or None) – Schema for this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
self (SelfResourceLink or None) – Link to this resource
revision (long or None) – The _revision property describes the current revision of the resource. To prevent clients from overwriting each other’s changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected. format: int32
create_time (long or None) – Timestamp of resource creation format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
create_user (str or None) – ID of the user who created this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
last_modified_time (long or None) – Timestamp of last modification format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
last_modified_user (str or None) – ID of the user who last modified this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
protection (str or None) – Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super user and can modify it, but only when providing the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this entity. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
system_owned (bool or None) – Indicates system owned resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
description (str or None) – Description of this resource
display_name (str or None) – Defaults to ID if not set
id (str or None) – Unique identifier of this resource
resource_type (str or None) – The type of this resource.
tags (list of Tag or None) – Opaque identifiers meaningful to the API user
parent_path (str or None) – Path of its parent This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
path (str or None) – Absolute path of this object This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
relative_path (str or None) – Path relative from its parent This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
children (list of vmware.vapi.struct.VapiStruct or None) – subtree for this type within policy tree containing nested elements. When clients pass a value of this class as a parameter, the attribute must contain all the attributes defined in ChildPolicyConfigResource. When methods return a value of this class as a return value, the attribute will contain all the attributes defined in ChildPolicyConfigResource.
marked_for_delete (bool or None) – Intent objects are not directly deleted from the system when a delete is invoked on them. They are marked for deletion and only when all the realized entities for that intent object gets deleted, the intent object is deleted. Objects that are marked for deletion are not returned in GET call. One can use the search API to get these objects. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
icmp_error_reply (long) – The timeout value for the connection after an ICMP error came back in response to an ICMP packet. format: int64
icmp_first_packet (long) – The timeout value of connection in seconds after the first packet. This will be the initial timeout for the new ICMP flow. format: int64
tcp_closed (long) – The timeout value of connection in seconds after one endpoint sends an RST. format: int64
tcp_closing (long) – The timeout value of connection in seconds after the first FIN has been sent. format: int64
tcp_established (long) – The timeout value of connection in seconds once the connection has become fully established. format: int64
tcp_finwait (long) – The timeout value of connection in seconds after both FINs have been exchanged and connection is closed. format: int64
tcp_first_packet (long) – The timeout value of connection in seconds after the first packet has been sent. format: int64
tcp_opening (long) – The timeout value of connection in seconds after a second packet has been transferred. format: int64
udp_first_packet (long) – The timeout value of connection in seconds after the first packet. This will be the initial timeout for the new UDP flow. format: int64
udp_multiple (long) – The timeout value of connection in seconds if both hosts have sent packets. format: int64
udp_single (long) – The timeout value of connection in seconds if the source host sends more than one packet but the destination host has never sent one back. format: int64

class com.vmware.nsx_policy.model_client.PolicyFirewallSessionTimerProfileBindingMap(links=None, schema=None, self_=None, revision=None, create_time=None, create_user=None, last_modified_time=None, last_modified_user=None, protection=None, system_owned=None, description=None, display_name=None, id=None, resource_type=None, tags=None, parent_path=None, path=None, relative_path=None, children=None, marked_for_delete=None, firewall_session_timer_profile_path=None, sequence_number=None)¶

Bases: vmware.vapi.bindings.struct.VapiStruct

This entity will be used to establish association between Firewall Timer session profile and Group. Using this entity, user can specify intent for applying Firewall Timer session profile to particular Group.

Tip

The arguments are used to initialize data attributes with the same names.

Parameters

links (list of ResourceLink or None) – The server will populate this field when returing the resource. Ignored on PUT and POST. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
schema (str or None) – Schema for this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
self (SelfResourceLink or None) – Link to this resource
revision (long or None) – The _revision property describes the current revision of the resource. To prevent clients from overwriting each other’s changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected. format: int32
create_time (long or None) – Timestamp of resource creation format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
create_user (str or None) – ID of the user who created this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
last_modified_time (long or None) – Timestamp of last modification format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
last_modified_user (str or None) – ID of the user who last modified this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
protection (str or None) – Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super user and can modify it, but only when providing the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this entity. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
system_owned (bool or None) – Indicates system owned resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
description (str or None) – Description of this resource
display_name (str or None) – Defaults to ID if not set
id (str or None) – Unique identifier of this resource
resource_type (str or None) – The type of this resource.
tags (list of Tag or None) – Opaque identifiers meaningful to the API user
parent_path (str or None) – Path of its parent This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
path (str or None) – Absolute path of this object This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
relative_path (str or None) – Path relative from its parent This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
children (list of vmware.vapi.struct.VapiStruct or None) – subtree for this type within policy tree containing nested elements. When clients pass a value of this class as a parameter, the attribute must contain all the attributes defined in ChildPolicyConfigResource. When methods return a value of this class as a return value, the attribute will contain all the attributes defined in ChildPolicyConfigResource.
marked_for_delete (bool or None) – Intent objects are not directly deleted from the system when a delete is invoked on them. They are marked for deletion and only when all the realized entities for that intent object gets deleted, the intent object is deleted. Objects that are marked for deletion are not returned in GET call. One can use the search API to get these objects. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
firewall_session_timer_profile_path (str) – PolicyPath of associated Firewall Timer Session Profile
sequence_number (long or None) – Sequence number is used to resolve conflicts when two profiles get applied to a single port. Lower value gets higher precedence. Two binding maps having the same profile path should have the same sequence number. format: int64

class com.vmware.nsx_policy.model_client.PolicyFirewallSessionTimerProfileBindingMapListResult(links=None, schema=None, self_=None, cursor=None, result_count=None, sort_ascending=None, sort_by=None, results=None)¶

Bases: vmware.vapi.bindings.struct.VapiStruct

Paged collection of Firewall Session Timer Profile Binding Maps

Tip

The arguments are used to initialize data attributes with the same names.

Parameters

links (list of ResourceLink or None) – The server will populate this field when returing the resource. Ignored on PUT and POST. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
schema (str or None) – Schema for this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
self (SelfResourceLink or None) – Link to this resource
cursor (str or None) – Opaque cursor to be used for getting next page of records (supplied by current result page) This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
result_count (long or None) – Count of results found (across all pages), set only on first page format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
sort_ascending (bool or None) – If true, results are sorted in ascending order This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
sort_by (str or None) – Field by which records are sorted This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
results (list of PolicyFirewallSessionTimerProfileBindingMap) – Firewall Session Timer Profile Binding Map list results

class com.vmware.nsx_policy.model_client.PolicyFirewallSessionTimerProfileListResult(links=None, schema=None, self_=None, cursor=None, result_count=None, sort_ascending=None, sort_by=None, results=None)¶

Bases: vmware.vapi.bindings.struct.VapiStruct

Paged Collection of Policy Firewall Session timeout profiles

Tip

The arguments are used to initialize data attributes with the same names.

Parameters

links (list of ResourceLink or None) – The server will populate this field when returing the resource. Ignored on PUT and POST. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
schema (str or None) – Schema for this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
self (SelfResourceLink or None) – Link to this resource
cursor (str or None) – Opaque cursor to be used for getting next page of records (supplied by current result page) This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
result_count (long or None) – Count of results found (across all pages), set only on first page format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
sort_ascending (bool or None) – If true, results are sorted in ascending order This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
sort_by (str or None) – Field by which records are sorted This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
results (list of PolicyFirewallSessionTimerProfile) – Policy Firewall Session timeout profile list results

class com.vmware.nsx_policy.model_client.PolicyGroupIPMembersListResult(links=None, schema=None, self_=None, cursor=None, result_count=None, sort_ascending=None, sort_by=None, results=None)¶

Bases: vmware.vapi.bindings.struct.VapiStruct

Paginated collection of IP members belonging to a Group.

Tip

The arguments are used to initialize data attributes with the same names.

Parameters

links (list of ResourceLink or None) – The server will populate this field when returing the resource. Ignored on PUT and POST. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
schema (str or None) – Schema for this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
self (SelfResourceLink or None) – Link to this resource
cursor (str or None) – Opaque cursor to be used for getting next page of records (supplied by current result page) This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
result_count (long or None) – Count of results found (across all pages), set only on first page format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
sort_ascending (bool or None) – If true, results are sorted in ascending order This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
sort_by (str or None) – Field by which records are sorted This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
results (list of str) – Paged Collection of IP addresses that belong to the given Group format: address-or-block-or-range

class com.vmware.nsx_policy.model_client.PolicyGroupMemberDetails(display_name=None, id=None, path=None)¶

Bases: vmware.vapi.bindings.struct.VapiStruct

Details of the member belonging to a Group

Tip

The arguments are used to initialize data attributes with the same names.

Parameters

display_name (str or None) – The display name of the member on the enforcement point This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
id (str or None) – The ID of the member on the enforcement point This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
path (str or None) – The path of the member, if relevant This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.

class com.vmware.nsx_policy.model_client.PolicyGroupMembersListResult(links=None, schema=None, self_=None, cursor=None, result_count=None, sort_ascending=None, sort_by=None, results=None)¶

Bases: vmware.vapi.bindings.struct.VapiStruct

Paginated collection of members belonging to a Group.

Tip

The arguments are used to initialize data attributes with the same names.

Parameters

links (list of ResourceLink or None) – The server will populate this field when returing the resource. Ignored on PUT and POST. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
schema (str or None) – Schema for this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
self (SelfResourceLink or None) – Link to this resource
cursor (str or None) – Opaque cursor to be used for getting next page of records (supplied by current result page) This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
result_count (long or None) – Count of results found (across all pages), set only on first page format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
sort_ascending (bool or None) – If true, results are sorted in ascending order This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
sort_by (str or None) – Field by which records are sorted This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
results (list of PolicyGroupMemberDetails) – Paged Collection of members that belong to the given Group

class com.vmware.nsx_policy.model_client.PolicyIPAddressInfo(address_value=None, display_name=None, next_hop=None)¶

Bases: vmware.vapi.bindings.struct.VapiStruct

Used to specify the display name and value of the IPv4Address.

Tip

The arguments are used to initialize data attributes with the same names.

Parameters

address_value (str) – Value of the IPv4Address. format: ipv4
display_name (str or None) – Display name used to help identify the IPv4Address.
next_hop (str or None) – Next hop used in auto-plumbing of static route. If a value is not provided, static route will not be auto-plumbed. format: ipv4

class com.vmware.nsx_policy.model_client.PolicyInsertParameters(anchor_path=None, operation=None)¶

Bases: vmware.vapi.bindings.struct.VapiStruct

Parameters to let the admin specify a relative position of a security policy or rule w.r.t to another one.

Tip

The arguments are used to initialize data attributes with the same names.

Parameters

anchor_path (str or None) – The security policy/rule path if operation is ‘insert_after’ or ‘insert_before’
operation (str or None) –
Possible values are:
Operation

OPERATION_AFTER = 'insert_after'¶

OPERATION_BEFORE = 'insert_before'¶

OPERATION_BOTTOM = 'insert_bottom'¶

OPERATION_TOP = 'insert_top'¶

class com.vmware.nsx_policy.model_client.PolicyInterfaceStatistics(logical_router_port_id=None, per_node_statistics=None)¶

Bases: vmware.vapi.bindings.struct.VapiStruct

Tier0 or Tier1 interface statistics on specific Enforcement Point.

Tip

The arguments are used to initialize data attributes with the same names.

Parameters

logical_router_port_id (str) – The ID of the logical router port
per_node_statistics (list of LogicalRouterPortStatisticsPerNode or None) – Per Node Statistics This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.

class com.vmware.nsx_policy.model_client.PolicyLabel(links=None, schema=None, self_=None, revision=None, create_time=None, create_user=None, last_modified_time=None, last_modified_user=None, protection=None, system_owned=None, description=None, display_name=None, id=None, resource_type=None, tags=None, parent_path=None, path=None, relative_path=None, children=None, marked_for_delete=None, refs=None, type=None)¶

Bases: vmware.vapi.bindings.struct.VapiStruct

Label to reference group of policy entities of same type.

Tip

The arguments are used to initialize data attributes with the same names.

Parameters

links (list of ResourceLink or None) – The server will populate this field when returing the resource. Ignored on PUT and POST. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
schema (str or None) – Schema for this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
self (SelfResourceLink or None) – Link to this resource
revision (long or None) – The _revision property describes the current revision of the resource. To prevent clients from overwriting each other’s changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected. format: int32
create_time (long or None) – Timestamp of resource creation format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
create_user (str or None) – ID of the user who created this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
last_modified_time (long or None) – Timestamp of last modification format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
last_modified_user (str or None) – ID of the user who last modified this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
protection (str or None) – Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super user and can modify it, but only when providing the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this entity. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
system_owned (bool or None) – Indicates system owned resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
description (str or None) – Description of this resource
display_name (str or None) – Defaults to ID if not set
id (str or None) – Unique identifier of this resource
resource_type (str or None) – The type of this resource.
tags (list of Tag or None) – Opaque identifiers meaningful to the API user
parent_path (str or None) – Path of its parent This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
path (str or None) – Absolute path of this object This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
relative_path (str or None) – Path relative from its parent This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
children (list of vmware.vapi.struct.VapiStruct or None) – subtree for this type within policy tree containing nested elements. When clients pass a value of this class as a parameter, the attribute must contain all the attributes defined in ChildPolicyConfigResource. When methods return a value of this class as a return value, the attribute will contain all the attributes defined in ChildPolicyConfigResource.
marked_for_delete (bool or None) – Intent objects are not directly deleted from the system when a delete is invoked on them. They are marked for deletion and only when all the realized entities for that intent object gets deleted, the intent object is deleted. Objects that are marked for deletion are not returned in GET call. One can use the search API to get these objects. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
refs (list of str or None) – Policy entity paths referred by the label instance
type (str) – Policy intent entity type from PolicyResourceType

class com.vmware.nsx_policy.model_client.PolicyLbMonitorProfile(links=None, schema=None, self_=None, revision=None, create_time=None, create_user=None, last_modified_time=None, last_modified_user=None, protection=None, system_owned=None, description=None, display_name=None, id=None, resource_type='PolicyLbMonitorProfile', tags=None, parent_path=None, path=None, relative_path=None, children=None, marked_for_delete=None, fall_count=None, interval=None, monitor_port=None, rise_count=None, timeout=None)¶

Bases: vmware.vapi.bindings.struct.VapiStruct

All the types of PolicyLbMonitorProfile extend from this abstract class. This is present for extensibility.

Tip

The arguments are used to initialize data attributes with the same names.

Parameters

links (list of ResourceLink or None) – The server will populate this field when returing the resource. Ignored on PUT and POST. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
schema (str or None) – Schema for this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
self (SelfResourceLink or None) – Link to this resource
revision (long or None) – The _revision property describes the current revision of the resource. To prevent clients from overwriting each other’s changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected. format: int32
create_time (long or None) – Timestamp of resource creation format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
create_user (str or None) – ID of the user who created this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
last_modified_time (long or None) – Timestamp of last modification format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
last_modified_user (str or None) – ID of the user who last modified this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
protection (str or None) – Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super user and can modify it, but only when providing the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this entity. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
system_owned (bool or None) – Indicates system owned resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
description (str or None) – Description of this resource
display_name (str or None) – Defaults to ID if not set
id (str or None) – Unique identifier of this resource
resource_type (str) –
Possible values are:
- PolicyLbMonitorProfile.RESOURCE_TYPE_TCPPOLICYLBMONITORPROFILE
- PolicyLbMonitorProfile.RESOURCE_TYPE_UDPPOLICYLBMONITORPROFILE
- PolicyLbMonitorProfile.RESOURCE_TYPE_ICMPPOLICYLBMONITORPROFILE
- PolicyLbMonitorProfile.RESOURCE_TYPE_HTTPPOLICYLBMONITORPROFILE
- PolicyLbMonitorProfile.RESOURCE_TYPE_HTTPSPOLICYLBMONITORPROFILE
tags (list of Tag or None) – Opaque identifiers meaningful to the API user
parent_path (str or None) – Path of its parent This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
path (str or None) – Absolute path of this object This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
relative_path (str or None) – Path relative from its parent This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
children (list of vmware.vapi.struct.VapiStruct or None) – subtree for this type within policy tree containing nested elements. When clients pass a value of this class as a parameter, the attribute must contain all the attributes defined in ChildPolicyConfigResource. When methods return a value of this class as a return value, the attribute will contain all the attributes defined in ChildPolicyConfigResource.
marked_for_delete (bool or None) – Intent objects are not directly deleted from the system when a delete is invoked on them. They are marked for deletion and only when all the realized entities for that intent object gets deleted, the intent object is deleted. Objects that are marked for deletion are not returned in GET call. One can use the search API to get these objects. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
fall_count (long or None) – Only if a healthcheck fails consecutively for a specified number of times, given with fall_count, to a member will the member status be marked DOWN. format: int64
interval (long or None) – Active healthchecks are initiated periodically, at a configurable interval (in seconds), to each member of the Group. format: int64
monitor_port (long or None) – Typically, monitors perform healthchecks to Group members using the member IP address and pool_port. However, in some cases, customers prefer to run healthchecks against a different port than the pool member port which handles actual application traffic. In such cases, the port to run healthchecks against can be specified in the monitor_port value. format: int32
rise_count (long or None) – Once a member is DOWN, a specified number of consecutive successful healthchecks specified by rise_count will bring the member back to UP state. format: int64
timeout (long or None) – Timeout specified in seconds. After a healthcheck is initiated, if it does not complete within a certain period, then also the healthcheck is considered to be unsuccessful. Completing a healthcheck within timeout means establishing a connection (TCP or SSL), if applicable, sending the request and receiving the response, all within the configured timeout. format: int64

RESOURCE_TYPE_HTTPPOLICYLBMONITORPROFILE = 'HttpPolicyLbMonitorProfile'¶

RESOURCE_TYPE_HTTPSPOLICYLBMONITORPROFILE = 'HttpsPolicyLbMonitorProfile'¶

RESOURCE_TYPE_ICMPPOLICYLBMONITORPROFILE = 'IcmpPolicyLbMonitorProfile'¶

RESOURCE_TYPE_TCPPOLICYLBMONITORPROFILE = 'TcpPolicyLbMonitorProfile'¶

RESOURCE_TYPE_UDPPOLICYLBMONITORPROFILE = 'UdpPolicyLbMonitorProfile'¶

property resource_type¶: Return the discriminator value

class com.vmware.nsx_policy.model_client.PolicyLbPersistenceProfile(links=None, schema=None, self_=None, revision=None, create_time=None, create_user=None, last_modified_time=None, last_modified_user=None, protection=None, system_owned=None, description=None, display_name=None, id=None, resource_type='PolicyLbPersistenceProfile', tags=None, parent_path=None, path=None, relative_path=None, children=None, marked_for_delete=None)¶

Bases: vmware.vapi.bindings.struct.VapiStruct

Some applications maintain state and require all relevant connections to be sent to the same server as the application state is not synchronized among servers. Persistence is enabled on a PolicyLbVirtualServer by binding a persistence profile to it.

Tip

The arguments are used to initialize data attributes with the same names.

Parameters

links (list of ResourceLink or None) – The server will populate this field when returing the resource. Ignored on PUT and POST. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
schema (str or None) – Schema for this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
self (SelfResourceLink or None) – Link to this resource
revision (long or None) – The _revision property describes the current revision of the resource. To prevent clients from overwriting each other’s changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected. format: int32
create_time (long or None) – Timestamp of resource creation format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
create_user (str or None) – ID of the user who created this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
last_modified_time (long or None) – Timestamp of last modification format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
last_modified_user (str or None) – ID of the user who last modified this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
protection (str or None) – Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super user and can modify it, but only when providing the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this entity. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
system_owned (bool or None) – Indicates system owned resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
description (str or None) – Description of this resource
display_name (str or None) – Defaults to ID if not set
id (str or None) – Unique identifier of this resource
resource_type (str) –
Possible values are:
- PolicyLbPersistenceProfile.RESOURCE_TYPE_L4POLICYLBPERSISTENCEPROFILE
- PolicyLbPersistenceProfile.RESOURCE_TYPE_L7POLICYLBPERSISTENCEPROFILE
- PolicyLbPersistenceProfile.RESOURCE_TYPE_CUSTOMPOLICYLBPERSISTENCEPROFILE
tags (list of Tag or None) – Opaque identifiers meaningful to the API user
parent_path (str or None) – Path of its parent This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
path (str or None) – Absolute path of this object This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
relative_path (str or None) – Path relative from its parent This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
children (list of vmware.vapi.struct.VapiStruct or None) – subtree for this type within policy tree containing nested elements. When clients pass a value of this class as a parameter, the attribute must contain all the attributes defined in ChildPolicyConfigResource. When methods return a value of this class as a return value, the attribute will contain all the attributes defined in ChildPolicyConfigResource.
marked_for_delete (bool or None) – Intent objects are not directly deleted from the system when a delete is invoked on them. They are marked for deletion and only when all the realized entities for that intent object gets deleted, the intent object is deleted. Objects that are marked for deletion are not returned in GET call. One can use the search API to get these objects. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.

RESOURCE_TYPE_CUSTOMPOLICYLBPERSISTENCEPROFILE = 'CustomPolicyLbPersistenceProfile'¶

RESOURCE_TYPE_L4POLICYLBPERSISTENCEPROFILE = 'L4PolicyLbPersistenceProfile'¶

RESOURCE_TYPE_L7POLICYLBPERSISTENCEPROFILE = 'L7PolicyLbPersistenceProfile'¶

property resource_type¶: Return the discriminator value

class com.vmware.nsx_policy.model_client.PolicyLbPoolAccess(links=None, schema=None, self_=None, revision=None, create_time=None, create_user=None, last_modified_time=None, last_modified_user=None, protection=None, system_owned=None, description=None, display_name=None, id=None, resource_type=None, tags=None, parent_path=None, path=None, relative_path=None, children=None, marked_for_delete=None, algorithm=None, ip_port_list=None, lb_monitor_profile=None, pool_port=None, source_nat=None)¶

Bases: vmware.vapi.bindings.struct.VapiStruct

Defining access of a Group from a PolicyLbVirtualServer and binding to PolicyLbMonitorProfile.

Tip

The arguments are used to initialize data attributes with the same names.

Parameters

links (list of ResourceLink or None) – The server will populate this field when returing the resource. Ignored on PUT and POST. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
schema (str or None) – Schema for this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
self (SelfResourceLink or None) – Link to this resource
revision (long or None) – The _revision property describes the current revision of the resource. To prevent clients from overwriting each other’s changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected. format: int32
create_time (long or None) – Timestamp of resource creation format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
create_user (str or None) – ID of the user who created this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
last_modified_time (long or None) – Timestamp of last modification format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
last_modified_user (str or None) – ID of the user who last modified this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
protection (str or None) – Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super user and can modify it, but only when providing the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this entity. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
system_owned (bool or None) – Indicates system owned resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
description (str or None) – Description of this resource
display_name (str or None) – Defaults to ID if not set
id (str or None) – Unique identifier of this resource
resource_type (str or None) – The type of this resource.
tags (list of Tag or None) – Opaque identifiers meaningful to the API user
parent_path (str or None) – Path of its parent This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
path (str or None) – Absolute path of this object This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
relative_path (str or None) – Path relative from its parent This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
children (list of vmware.vapi.struct.VapiStruct or None) – subtree for this type within policy tree containing nested elements. When clients pass a value of this class as a parameter, the attribute must contain all the attributes defined in ChildPolicyConfigResource. When methods return a value of this class as a return value, the attribute will contain all the attributes defined in ChildPolicyConfigResource.
marked_for_delete (bool or None) – Intent objects are not directly deleted from the system when a delete is invoked on them. They are marked for deletion and only when all the realized entities for that intent object gets deleted, the intent object is deleted. Objects that are marked for deletion are not returned in GET call. One can use the search API to get these objects. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
algorithm (str or None) –
Possible values are:
- PolicyLbPoolAccess.ALGORITHM_ROUND_ROBIN
- PolicyLbPoolAccess.ALGORITHM_LEAST_CONNECTION
Load balanding algorithm controls how the incoming connections are distributed among the members. - ROUND_ROBIN - requests to the application servers are distributed in a round-robin fashion, - LEAST_CONNECTION - next request is assigned to the server with the least number of active connections
ip_port_list (list of IPAddressPortPair or None) – IP Port list for applications within the Group to allow for non-uniform port usage by applications
lb_monitor_profile (str or None) – Path of the PolicyLbMonitorProfile to actively monitor the PolicyLbPoolAccess’s Group
pool_port (long or None) – Port for LoadBalancer to send connections to the PolicyLbPoolAccess’s Group. Pool_port could be optional, if it is not specified, LB will use PolicyLbVirtualServer port to connect to backend servers. If the PolicyLbMonitorProfile is configured in PolicyLbPoolAccess and active monitor IP protocol is TCP/UDP(which requires TCP or UDP port number), monitor_port should be specified if pool_port is unset. format: int32
source_nat (str or None) –
Possible values are:
- PolicyLbPoolAccess.SOURCE_NAT_ENABLED
- PolicyLbPoolAccess.SOURCE_NAT_DISABLED
Depending on the topology, Source NAT (SNAT) may be required to ensure traffic from the server destined to the client is received by the load balancer. SNAT can be enabled per pool. If SNAT is not enabled for a pool, then load balancer uses the client IP and port (spoofing) while establishing connections to the servers. This is referred to as no-SNAT or TRANSPARENT mode. SNAT is enabled by default and will use the load balancer interface IP and an ephemeral port as the source IP and port of the server side connection.

ALGORITHM_LEAST_CONNECTION = 'LEAST_CONNECTION'¶

ALGORITHM_ROUND_ROBIN = 'ROUND_ROBIN'¶

SOURCE_NAT_DISABLED = 'DISABLED'¶

SOURCE_NAT_ENABLED = 'ENABLED'¶

class com.vmware.nsx_policy.model_client.PolicyLbRule(links=None, schema=None, self_=None, revision=None, create_time=None, create_user=None, last_modified_time=None, last_modified_user=None, protection=None, system_owned=None, description=None, display_name=None, id=None, resource_type=None, tags=None, parent_path=None, path=None, relative_path=None, children=None, marked_for_delete=None, host_match=None, lb_virtual_server=None, match_strategy=None, path_match=None, sequence_number=None)¶

Bases: vmware.vapi.bindings.struct.VapiStruct

Binding of a LbPoolAccess and Group to a PolicyLbVirtualServer used to route application traffic passing through load balancers. PolicyLbRule uses match conditions to match application traffic passing through a PolicyLbVirtualServer using HTTP or HTTPS. Can bind multiple PolicyLbVirtualServers to a Group. Each PolicyLbRule consists of two optional match conditions, each match contidion defines a criterion for application traffic. If no match conditions are specified, then the PolicyLbRule will always match and it is used typically to define default rules. If more than one match condition is specified, then matching strategy determines if all conditions should match or any one condition should match for the PolicyLbRule to be considered a match. A match indicates that the PolicyLbVirtualServer should route the request to the Group (parent of PolicyLbRule).

Tip

The arguments are used to initialize data attributes with the same names.

Parameters

links (list of ResourceLink or None) – The server will populate this field when returing the resource. Ignored on PUT and POST. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
schema (str or None) – Schema for this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
self (SelfResourceLink or None) – Link to this resource
revision (long or None) – The _revision property describes the current revision of the resource. To prevent clients from overwriting each other’s changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected. format: int32
create_time (long or None) – Timestamp of resource creation format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
create_user (str or None) – ID of the user who created this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
last_modified_time (long or None) – Timestamp of last modification format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
last_modified_user (str or None) – ID of the user who last modified this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
protection (str or None) – Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super user and can modify it, but only when providing the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this entity. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
system_owned (bool or None) – Indicates system owned resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
description (str or None) – Description of this resource
display_name (str or None) – Defaults to ID if not set
id (str or None) – Unique identifier of this resource
resource_type (str or None) – The type of this resource.
tags (list of Tag or None) – Opaque identifiers meaningful to the API user
parent_path (str or None) – Path of its parent This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
path (str or None) – Absolute path of this object This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
relative_path (str or None) – Path relative from its parent This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
children (list of vmware.vapi.struct.VapiStruct or None) – subtree for this type within policy tree containing nested elements. When clients pass a value of this class as a parameter, the attribute must contain all the attributes defined in ChildPolicyConfigResource. When methods return a value of this class as a return value, the attribute will contain all the attributes defined in ChildPolicyConfigResource.
marked_for_delete (bool or None) – Intent objects are not directly deleted from the system when a delete is invoked on them. They are marked for deletion and only when all the realized entities for that intent object gets deleted, the intent object is deleted. Objects that are marked for deletion are not returned in GET call. One can use the search API to get these objects. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
host_match (str or None) – This condition is used to match HTTP request messages by the specific HTTP header field, Host. The Host request header specifies the domain name of the server. The supplied Host HTTP header match condition will be matched as a regular expression. The regular expressions in load balancer rules use the features common to both Java regular expressions and Perl Compatible Regular Expressions (PCREs) with some restrictions. Reference http://www.pcre .org for PCRE and the NSX-T Administrator’s Guide for the restrictions. Please note, when regular expressions are used in JSON (JavaScript Object Notation) string, every backslash character () needs to be escaped by one additional backslash character.
lb_virtual_server (str or None) – The path of PolicyLbVirtualServer to bind to this PolicyLbRule and its Group
match_strategy (str or None) –
Possible values are:
- PolicyLbRule.MATCH_STRATEGY_ALL
- PolicyLbRule.MATCH_STRATEGY_ANY
If more than one match condition is specified, then matching strategy determines if all conditions should match or any one condition should match for the LB Rule to be considered a match. - ALL indicates that both host_match and path_match must match for this PolicyLbRule to be considered a match - ANY indicates that either host_match or patch match may match for this PolicyLbRule to be considered a match
path_match (str or None) – This condition is used to match URIs(Uniform Resource Identifier) of HTTP request messages. The URI field can be specified as a regluar expression. If an HTTP request message is requesting an URI which matches specified regular expression, it matches the condition. The syntax of whole URI looks like this: scheme:[//[user[:password]\@]host[:port]][/path][?query][#fragment] This condition matches only the path part of entire URI. The path_match field is used as a regular expression to match URI path of HTTP requests. For example, to match any URI that has “/image/” or “/images/”, uri field can be specified as: “/image[s]?/”. The regular expressions in load balancer rules use the features common to both Java regular expressions and Perl Compatible Regular Expressions (PCREs) with some restrictions. Reference http://www.pcre .org for PCRE and the NSX-T Administrator’s Guide for the restrictions. Please note, when regular expressions are used in JSON (JavaScript Object Notation) string, every backslash character () needs to be escaped by one additional backslash character.
sequence_number (long or None) – This field is used to resolve conflicts between multiple PolicyLbRules associated with a single PolicyLbVirtualServer and will be applied numerically or low to high format: int32

MATCH_STRATEGY_ALL = 'ALL'¶

MATCH_STRATEGY_ANY = 'ANY'¶

class com.vmware.nsx_policy.model_client.PolicyLbVirtualServer(links=None, schema=None, self_=None, revision=None, create_time=None, create_user=None, last_modified_time=None, last_modified_user=None, protection=None, system_owned=None, description=None, display_name=None, id=None, resource_type='PolicyLbVirtualServer', tags=None, parent_path=None, path=None, relative_path=None, children=None, marked_for_delete=None, access_log_enabled=None, ip_address=None, lb_persistence_profile=None, ports=None, router_path=None, traffic_source=None)¶

Bases: vmware.vapi.bindings.struct.VapiStruct

All the types of PolicyLbVirtualServer extend from this abstract class. This is present for extensibility.

Tip

The arguments are used to initialize data attributes with the same names.

Parameters

links (list of ResourceLink or None) – The server will populate this field when returing the resource. Ignored on PUT and POST. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
schema (str or None) – Schema for this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
self (SelfResourceLink or None) – Link to this resource
revision (long or None) – The _revision property describes the current revision of the resource. To prevent clients from overwriting each other’s changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected. format: int32
create_time (long or None) – Timestamp of resource creation format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
create_user (str or None) – ID of the user who created this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
last_modified_time (long or None) – Timestamp of last modification format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
last_modified_user (str or None) – ID of the user who last modified this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
protection (str or None) – Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super user and can modify it, but only when providing the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this entity. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
system_owned (bool or None) – Indicates system owned resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
description (str or None) – Description of this resource
display_name (str or None) – Defaults to ID if not set
id (str or None) – Unique identifier of this resource
resource_type (str) –
Possible values are:
- PolicyLbVirtualServer.RESOURCE_TYPE_TCPPOLICYLBVIRTUALSERVER
- PolicyLbVirtualServer.RESOURCE_TYPE_UDPPOLICYLBVIRTUALSERVER
- PolicyLbVirtualServer.RESOURCE_TYPE_HTTPPOLICYLBVIRTUALSERVER
- PolicyLbVirtualServer.RESOURCE_TYPE_HTTPSPOLICYLBVIRTUALSERVER
- PolicyLbVirtualServer.RESOURCE_TYPE_CUSTOMPOLICYLBVIRTUALSERVER
tags (list of Tag or None) – Opaque identifiers meaningful to the API user
parent_path (str or None) – Path of its parent This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
path (str or None) – Absolute path of this object This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
relative_path (str or None) – Path relative from its parent This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
children (list of vmware.vapi.struct.VapiStruct or None) – subtree for this type within policy tree containing nested elements. When clients pass a value of this class as a parameter, the attribute must contain all the attributes defined in ChildPolicyConfigResource. When methods return a value of this class as a return value, the attribute will contain all the attributes defined in ChildPolicyConfigResource.
marked_for_delete (bool or None) – Intent objects are not directly deleted from the system when a delete is invoked on them. They are marked for deletion and only when all the realized entities for that intent object gets deleted, the intent object is deleted. Objects that are marked for deletion are not returned in GET call. One can use the search API to get these objects. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
access_log_enabled (bool or None) – If access log is enabled, all HTTP requests sent to an L7 virtual server are logged to the access log file. Both successful requests (backend server returns 2xx) and unsuccessful requests (backend server returns 4xx or 5xx) are logged to access log, if enabled.
ip_address (str) – Configures the IP address of the PolicyLbVirtualServer where it receives all client connections and distributes them among the backend servers. format: ip
lb_persistence_profile (str or None) – Path to optional object that enables persistence on a virtual server allowing related client connections to be sent to the same backend server. Persistence is disabled by default.
ports (list of str) – Ports contains a list of at least one port or port range such as “80”, “1234-1236”. Each port element in the list should be a single port or a single port range. format: port-or-range
router_path (str) – Path to router type object that PolicyLbVirtualServer connects to. The only supported router object is Network.
traffic_source (str or None) –

RESOURCE_TYPE_CUSTOMPOLICYLBVIRTUALSERVER = 'CustomPolicyLbVirtualServer'¶

RESOURCE_TYPE_HTTPPOLICYLBVIRTUALSERVER = 'HttpPolicyLbVirtualServer'¶

RESOURCE_TYPE_HTTPSPOLICYLBVIRTUALSERVER = 'HttpsPolicyLbVirtualServer'¶

RESOURCE_TYPE_TCPPOLICYLBVIRTUALSERVER = 'TcpPolicyLbVirtualServer'¶

RESOURCE_TYPE_UDPPOLICYLBVIRTUALSERVER = 'UdpPolicyLbVirtualServer'¶

property resource_type¶: Return the discriminator value

class com.vmware.nsx_policy.model_client.PolicyListResult(links=None, schema=None, self_=None, cursor=None, result_count=None, sort_ascending=None, sort_by=None)¶

Bases: vmware.vapi.bindings.struct.VapiStruct

Paged Collection of security policies

Tip

The arguments are used to initialize data attributes with the same names.

Parameters

links (list of ResourceLink or None) – The server will populate this field when returing the resource. Ignored on PUT and POST. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
schema (str or None) – Schema for this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
self (SelfResourceLink or None) – Link to this resource
cursor (str or None) – Opaque cursor to be used for getting next page of records (supplied by current result page) This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
result_count (long or None) – Count of results found (across all pages), set only on first page format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
sort_ascending (bool or None) – If true, results are sorted in ascending order This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
sort_by (str or None) – Field by which records are sorted This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.

class com.vmware.nsx_policy.model_client.PolicyNATRuleCounters(active_sessions=None, total_bytes=None, total_packets=None)¶

Bases: vmware.vapi.bindings.struct.VapiStruct

Gives the statistics count of a NAT rule.

Tip

The arguments are used to initialize data attributes with the same names.

Parameters

active_sessions (long or None) – Gives the total number of active sessions. format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
total_bytes (long or None) – Gives the total number of bytes. format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
total_packets (long or None) – Gives the total number of packets. format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.

class com.vmware.nsx_policy.model_client.PolicyNat(links=None, schema=None, self_=None, revision=None, create_time=None, create_user=None, last_modified_time=None, last_modified_user=None, protection=None, system_owned=None, description=None, display_name=None, id=None, resource_type=None, tags=None, parent_path=None, path=None, relative_path=None, children=None, marked_for_delete=None, nat_type=None)¶

Bases: vmware.vapi.bindings.struct.VapiStruct

Represents NAT section. This object is created by default when corresponding tier-0/tier-1 is created. Under tier-0/tier-1 there will be 3 different NATs(sections). (INTERNAL, USER and DEFAULT).

Tip

The arguments are used to initialize data attributes with the same names.

Parameters

links (list of ResourceLink or None) – The server will populate this field when returing the resource. Ignored on PUT and POST. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
schema (str or None) – Schema for this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
self (SelfResourceLink or None) – Link to this resource
revision (long or None) – The _revision property describes the current revision of the resource. To prevent clients from overwriting each other’s changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected. format: int32
create_time (long or None) – Timestamp of resource creation format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
create_user (str or None) – ID of the user who created this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
last_modified_time (long or None) – Timestamp of last modification format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
last_modified_user (str or None) – ID of the user who last modified this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
protection (str or None) – Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super user and can modify it, but only when providing the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this entity. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
system_owned (bool or None) – Indicates system owned resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
description (str or None) – Description of this resource
display_name (str or None) – Defaults to ID if not set
id (str or None) – Unique identifier of this resource
resource_type (str or None) – The type of this resource.
tags (list of Tag or None) – Opaque identifiers meaningful to the API user
parent_path (str or None) – Path of its parent This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
path (str or None) – Absolute path of this object This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
relative_path (str or None) – Path relative from its parent This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
children (list of vmware.vapi.struct.VapiStruct or None) – subtree for this type within policy tree containing nested elements. When clients pass a value of this class as a parameter, the attribute must contain all the attributes defined in ChildPolicyConfigResource. When methods return a value of this class as a return value, the attribute will contain all the attributes defined in ChildPolicyConfigResource.
marked_for_delete (bool or None) – Intent objects are not directly deleted from the system when a delete is invoked on them. They are marked for deletion and only when all the realized entities for that intent object gets deleted, the intent object is deleted. Objects that are marked for deletion are not returned in GET call. One can use the search API to get these objects. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
nat_type (str or None) –
Possible values are:
- PolicyNat.NAT_TYPE_INTERNAL
- PolicyNat.NAT_TYPE_USER
- PolicyNat.NAT_TYPE_DEFAULT
Represents a NAT section under tier-0/tier-1.

NAT_TYPE_DEFAULT = 'DEFAULT'¶

NAT_TYPE_INTERNAL = 'INTERNAL'¶

NAT_TYPE_USER = 'USER'¶

class com.vmware.nsx_policy.model_client.PolicyNatRule(links=None, schema=None, self_=None, revision=None, create_time=None, create_user=None, last_modified_time=None, last_modified_user=None, protection=None, system_owned=None, description=None, display_name=None, id=None, resource_type=None, tags=None, parent_path=None, path=None, relative_path=None, children=None, marked_for_delete=None, action=None, destination_network=None, enabled=None, firewall_match=None, logging=None, scope=None, sequence_number=None, service=None, source_network=None, translated_network=None, translated_ports=None)¶

Bases: vmware.vapi.bindings.struct.VapiStruct

Represents a NAT rule between source and destination at T0/T1 router.

Tip

The arguments are used to initialize data attributes with the same names.

Parameters

links (list of ResourceLink or None) – The server will populate this field when returing the resource. Ignored on PUT and POST. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
schema (str or None) – Schema for this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
self (SelfResourceLink or None) – Link to this resource
revision (long or None) – The _revision property describes the current revision of the resource. To prevent clients from overwriting each other’s changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected. format: int32
create_time (long or None) – Timestamp of resource creation format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
create_user (str or None) – ID of the user who created this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
last_modified_time (long or None) – Timestamp of last modification format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
last_modified_user (str or None) – ID of the user who last modified this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
protection (str or None) – Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super user and can modify it, but only when providing the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this entity. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
system_owned (bool or None) – Indicates system owned resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
description (str or None) – Description of this resource
display_name (str or None) – Defaults to ID if not set
id (str or None) – Unique identifier of this resource
resource_type (str or None) – The type of this resource.
tags (list of Tag or None) – Opaque identifiers meaningful to the API user
parent_path (str or None) – Path of its parent This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
path (str or None) – Absolute path of this object This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
relative_path (str or None) – Path relative from its parent This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
children (list of vmware.vapi.struct.VapiStruct or None) – subtree for this type within policy tree containing nested elements. When clients pass a value of this class as a parameter, the attribute must contain all the attributes defined in ChildPolicyConfigResource. When methods return a value of this class as a return value, the attribute will contain all the attributes defined in ChildPolicyConfigResource.
marked_for_delete (bool or None) – Intent objects are not directly deleted from the system when a delete is invoked on them. They are marked for deletion and only when all the realized entities for that intent object gets deleted, the intent object is deleted. Objects that are marked for deletion are not returned in GET call. One can use the search API to get these objects. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
action (str) –
Possible values are:
- PolicyNatRule.ACTION_SNAT
- PolicyNatRule.ACTION_DNAT
- PolicyNatRule.ACTION_REFLEXIVE
- PolicyNatRule.ACTION_NO_SNAT
- PolicyNatRule.ACTION_NO_DNAT
Source NAT(SNAT) - translates a source IP address in an outbound packet so that the packet appears to originate from a different network. SNAT is only supported when the logical router is running in active-standby mode. Destination NAT(DNAT) - translates the destination IP address of inbound packets so that packets are delivered to a target address into another network. DNAT is only supported when the logical router is running in active-standby mode. Reflexive NAT(REFLEXIVE) - IP-Range and CIDR are supported to define the “n”. The number of original networks should be exactly the same as that of translated networks. The address translation is deterministic. Reflexive is supported on both Active/Standby and Active/Active LR. NO_SNAT and NO_DNAT - These do not have support for translated_fields, only source_network and destination_network fields are supported.
destination_network (str or None) – IP Address | Comma separeted list of IP addresses | CIDR. For DNAT and NO_DNAT rules, this is a mandatory field, and represents the destination network for the incoming packets. For other type of rules, optionally it can contain destination network of outgoing packets. NULL value for this field represents ANY network. format: list-of-address-or-block-or-range
enabled (bool or None) – The flag, which suggests whether the NAT rule is enabled or disabled. The default is True.
firewall_match (str or None) –
Possible values are:
- PolicyNatRule.FIREWALL_MATCH_MATCH_EXTERNAL_ADDRESS
- PolicyNatRule.FIREWALL_MATCH_MATCH_INTERNAL_ADDRESS
- PolicyNatRule.FIREWALL_MATCH_BYPASS
It indicates how the firewall matches the address after NATing if firewall stage is not skipped. MATCH_EXTERNAL_ADDRESS indicates the firewall will be applied to external address of a NAT rule. For SNAT, the external address is the translated source address after NAT is done. For DNAT, the external address is the original destination address before NAT is done. For REFLEXIVE, to egress traffic, the firewall will be applied to the translated source address after NAT is done; To ingress traffic, the firewall will be applied to the original destination address before NAT is done. MATCH_INTERNAL_ADDRESS indicates the firewall will be applied to internal address of a NAT rule. For SNAT, the internal address is the original source address before NAT is done. For DNAT, the internal address is the translated destination address after NAT is done. For REFLEXIVE, to egress traffic, the firewall will be applied to the original source address before NAT is done; To ingress traffic, the firewall will be applied to the translated destination address after NAT is done. BYPASS indicates the firewall stage will be skipped. For NO_SNAT or NO_DNAT, it must be BYPASS or leave it unassigned
logging (bool or None) – The flag, which suggests whether the logging of NAT rule is enabled or disabled. The default is False.
scope (list of str or None) – Represents the array of policy paths of ProviderInterface or NetworkInterface or labels of type ProviderInterface or NetworkInterface on which the NAT rule should get enforced. The interfaces must belong to the same router for which the NAT Rule is created.
sequence_number (long or None) – The sequence_number decides the rule_priority of a NAT rule. Sequence_number and rule_priority have 1:1 mapping.For each NAT section, there will be reserved rule_priority numbers.The valid range of rule_priority number is from 0 to 2147483647(MAX_INT). 1. INTERNAL section rule_priority reserved from 0 - 1023 (1024 rules) valid sequence_number range 0 - 1023 2. USER section rule_priority reserved from 1024 - 2147482623 (2147481600 rules) valid sequence_number range 0 - 2147481599 3. DEFAULT section rule_priority reserved from 2147482624 - 2147483647 (1024 rules) valid sequence_number range 0 - 1023 format: int32
service (str or None) – It represents the path of Service on which the NAT rule will be applied. If not provided or if it is blank then Policy manager will consider it as ANY.
source_network (str or None) – IP Address | Comma separeted list of IP addresses | CIDR. For SNAT, NO_SNAT and REFLEXIVE rules, this is a mandatory field and represents the source network of the packets leaving the network. For DNAT and NO_DNAT rules, optionally it can contain source network of incoming packets. NULL value for this field represents ANY network. format: list-of-address-or-block-or-range
translated_network (str or None) – IP Address | Comma separeted list of IP addresses | CIDR. For SNAT, DNAT and REFLEXIVE rules, this ia a mandatory field, which represents the translated network address. For NO_SNAT and NO_DNAT this should be empty. format: list-of-address-or-block-or-range
translated_ports (str or None) – Port number or port range format: port-or-range

ACTION_DNAT = 'DNAT'¶

ACTION_NO_DNAT = 'NO_DNAT'¶

ACTION_NO_SNAT = 'NO_SNAT'¶

ACTION_REFLEXIVE = 'REFLEXIVE'¶

ACTION_SNAT = 'SNAT'¶

FIREWALL_MATCH_BYPASS = 'BYPASS'¶

FIREWALL_MATCH_MATCH_EXTERNAL_ADDRESS = 'MATCH_EXTERNAL_ADDRESS'¶

FIREWALL_MATCH_MATCH_INTERNAL_ADDRESS = 'MATCH_INTERNAL_ADDRESS'¶

class com.vmware.nsx_policy.model_client.PolicyNatRuleListResult(links=None, schema=None, self_=None, cursor=None, result_count=None, sort_ascending=None, sort_by=None, results=None)¶

Bases: vmware.vapi.bindings.struct.VapiStruct

Paged Collection of NAT Rules

Tip

The arguments are used to initialize data attributes with the same names.

Parameters

links (list of ResourceLink or None) – The server will populate this field when returing the resource. Ignored on PUT and POST. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
schema (str or None) – Schema for this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
self (SelfResourceLink or None) – Link to this resource
cursor (str or None) – Opaque cursor to be used for getting next page of records (supplied by current result page) This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
result_count (long or None) – Count of results found (across all pages), set only on first page format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
sort_ascending (bool or None) – If true, results are sorted in ascending order This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
sort_by (str or None) – Field by which records are sorted This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
results (list of PolicyNatRule) – NAT Rules list results

class com.vmware.nsx_policy.model_client.PolicyNatRuleStatistics(active_sessions=None, total_bytes=None, total_packets=None, last_update_timestamp=None, warning_message=None)¶

Bases: vmware.vapi.bindings.struct.VapiStruct

Gives the Statistics of a NAT rule.

Tip

The arguments are used to initialize data attributes with the same names.

Parameters

active_sessions (long or None) – Gives the total number of active sessions. format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
total_bytes (long or None) – Gives the total number of bytes. format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
total_packets (long or None) – Gives the total number of packets. format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
last_update_timestamp (long or None) – Timestamp when the data was last updated. format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
warning_message (str or None) – The warning message about the NAT Rule Statistics. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.

class com.vmware.nsx_policy.model_client.PolicyNatRuleStatisticsListResult(links=None, schema=None, self_=None, cursor=None, result_count=None, sort_ascending=None, sort_by=None, results=None)¶

Bases: vmware.vapi.bindings.struct.VapiStruct

Gives the collection of NAT rule statistics per enforcement point.

Tip

The arguments are used to initialize data attributes with the same names.

Parameters

links (list of ResourceLink or None) – The server will populate this field when returing the resource. Ignored on PUT and POST. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
schema (str or None) – Schema for this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
self (SelfResourceLink or None) – Link to this resource
cursor (str or None) – Opaque cursor to be used for getting next page of records (supplied by current result page) This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
result_count (long or None) – Count of results found (across all pages), set only on first page format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
sort_ascending (bool or None) – If true, results are sorted in ascending order This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
sort_by (str or None) – Field by which records are sorted This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
results (list of PolicyNatRuleStatisticsPerEnforcementPoint) – NAT rules statistics per enforcement point

class com.vmware.nsx_policy.model_client.PolicyNatRuleStatisticsPerEnforcementPoint(enforcement_point_path=None, rule_path=None, rule_statistics=None)¶

Bases: vmware.vapi.bindings.struct.VapiStruct

Gives the statistics of a NAT rule per enforcement point.

Tip

The arguments are used to initialize data attributes with the same names.

Parameters

enforcement_point_path (str or None) – Policy Path referencing the enforcement point from where the statistics are fetched.
rule_path (str or None) – Path of NAT Rule.
rule_statistics (list of PolicyNatRuleStatistics or None) – Gives NAT rule stats on an enforcement point. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.

class com.vmware.nsx_policy.model_client.PolicyNatRuleStatisticsPerLogicalRouter(enforcement_point_path=None, last_update_timestamp=None, per_node_statistics=None, router_path=None, statistics=None)¶

Bases: vmware.vapi.bindings.struct.VapiStruct

Gives the statistics of a NAT rule per logical router on specified enforcement point.

Tip

The arguments are used to initialize data attributes with the same names.

Parameters

enforcement_point_path (str or None) – Policy Path referencing the enforcement point from where the statistics are fetched.
last_update_timestamp (long or None) – Timestamp when the data was last updated. format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
per_node_statistics (list of PolicyNatRuleStatisticsPerTransportNode or None) – Detailed Rule statistics per logical router. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
router_path (str or None) – Path of the router.
statistics (PolicyNATRuleCounters or None) – Rolled up statistics for all rules on the logical router.

class com.vmware.nsx_policy.model_client.PolicyNatRuleStatisticsPerLogicalRouterListResult(links=None, schema=None, self_=None, cursor=None, result_count=None, sort_ascending=None, sort_by=None, results=None)¶

Bases: vmware.vapi.bindings.struct.VapiStruct

Gives the collection of NAT rule statistics per logical router on specified enforcement point.

Tip

The arguments are used to initialize data attributes with the same names.

Parameters

links (list of ResourceLink or None) – The server will populate this field when returing the resource. Ignored on PUT and POST. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
schema (str or None) – Schema for this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
self (SelfResourceLink or None) – Link to this resource
cursor (str or None) – Opaque cursor to be used for getting next page of records (supplied by current result page) This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
result_count (long or None) – Count of results found (across all pages), set only on first page format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
sort_ascending (bool or None) – If true, results are sorted in ascending order This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
sort_by (str or None) – Field by which records are sorted This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
results (list of PolicyNatRuleStatisticsPerLogicalRouter) – NAT rules statistics per logical router

class com.vmware.nsx_policy.model_client.PolicyNatRuleStatisticsPerTransportNode(active_sessions=None, total_bytes=None, total_packets=None, last_update_timestamp=None, transport_node_path=None)¶

Bases: vmware.vapi.bindings.struct.VapiStruct

Gives the Statistics of a NAT rule.

Tip

The arguments are used to initialize data attributes with the same names.

Parameters

active_sessions (long or None) – Gives the total number of active sessions. format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
total_bytes (long or None) – Gives the total number of bytes. format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
total_packets (long or None) – Gives the total number of packets. format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
last_update_timestamp (long or None) – Timestamp when the data was last updated. format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
transport_node_path (str or None) – Policy path of the Edge Node. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.

class com.vmware.nsx_policy.model_client.PolicyNonCompliantConfig(affected_resources=None, description=None, non_compliance_code=None, reported_by=None)¶

Bases: vmware.vapi.bindings.struct.VapiStruct

Tip

The arguments are used to initialize data attributes with the same names.

Parameters

affected_resources (list of PolicyResourceReference or None) – Resources/Services impacted by non compliant configuration This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
description (str or None) – Detail description of non compliant configuration with suggestive action This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
non_compliance_code (long or None) – Code for non compliant configuration format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
reported_by (PolicyResourceReference or None) – Id and name of non compliant resource/service

class com.vmware.nsx_policy.model_client.PolicyRealizedResource(links=None, schema=None, self_=None, revision=None, create_time=None, create_user=None, last_modified_time=None, last_modified_user=None, protection=None, system_owned=None, description=None, display_name=None, id=None, resource_type=None, tags=None, parent_path=None, path=None, relative_path=None, alarms=None, intent_reference=None, realization_api=None, realization_specific_identifier=None, runtime_error=None, runtime_status=None, state=None)¶

Bases: vmware.vapi.bindings.struct.VapiStruct

Abstract base class for all the realized policy objects

Tip

The arguments are used to initialize data attributes with the same names.

Parameters

links (list of ResourceLink or None) – The server will populate this field when returing the resource. Ignored on PUT and POST. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
schema (str or None) – Schema for this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
self (SelfResourceLink or None) – Link to this resource
revision (long or None) – The _revision property describes the current revision of the resource. To prevent clients from overwriting each other’s changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected. format: int32
create_time (long or None) – Timestamp of resource creation format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
create_user (str or None) – ID of the user who created this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
last_modified_time (long or None) – Timestamp of last modification format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
last_modified_user (str or None) – ID of the user who last modified this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
protection (str or None) – Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super user and can modify it, but only when providing the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this entity. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
system_owned (bool or None) – Indicates system owned resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
description (str or None) – Description of this resource
display_name (str or None) – Defaults to ID if not set
id (str or None) – Unique identifier of this resource
resource_type (str or None) – The type of this resource.
tags (list of Tag or None) – Opaque identifiers meaningful to the API user
parent_path (str or None) – Path of its parent This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
path (str or None) – Absolute path of this object This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
relative_path (str or None) – Path relative from its parent This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
alarms (list of PolicyAlarmResource or None) – Alarm info detail
intent_reference (list of str or None) – Desire state paths of this object
realization_api (str or None) – Realization API of this object on enforcement point
realization_specific_identifier (str or None) – Realization id of this object
runtime_error (str or None) – It define the root cause for runtime error.
runtime_status (str or None) – Possible values could be UP, DOWN, UNKNOWN, DEGRADED This list is not exhaustive.
state (str) –
Possible values are:
- PolicyRealizedResource.STATE_UNAVAILABLE
- PolicyRealizedResource.STATE_UNREALIZED
- PolicyRealizedResource.STATE_REALIZED
- PolicyRealizedResource.STATE_ERROR
Realization state of this object

STATE_ERROR = 'ERROR'¶

STATE_REALIZED = 'REALIZED'¶

STATE_UNAVAILABLE = 'UNAVAILABLE'¶

STATE_UNREALIZED = 'UNREALIZED'¶

class com.vmware.nsx_policy.model_client.PolicyRelatedApiError(details=None, error_code=None, error_data=None, error_message=None, module_name=None)¶

Bases: vmware.vapi.bindings.struct.VapiStruct

Detailed information about errors from API call to an enforcement point

Tip

The arguments are used to initialize data attributes with the same names.

Parameters

details (str or None) – Further details about the error
error_code (long or None) – A numeric error code format: int64
error_data (vmware.vapi.struct.VapiStruct or None) – Additional data about the error
error_message (str or None) – A description of the error
module_name (str or None) – The module name where the error occurred

class com.vmware.nsx_policy.model_client.PolicyResource(links=None, schema=None, self_=None, revision=None, create_time=None, create_user=None, last_modified_time=None, last_modified_user=None, protection=None, system_owned=None, description=None, display_name=None, id=None, resource_type=None, tags=None, parent_path=None, path=None, relative_path=None)¶

Bases: vmware.vapi.bindings.struct.VapiStruct

Abstract base class for all the policy objects.

Tip

The arguments are used to initialize data attributes with the same names.

Parameters

links (list of ResourceLink or None) – The server will populate this field when returing the resource. Ignored on PUT and POST. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
schema (str or None) – Schema for this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
self (SelfResourceLink or None) – Link to this resource
revision (long or None) – The _revision property describes the current revision of the resource. To prevent clients from overwriting each other’s changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected. format: int32
create_time (long or None) – Timestamp of resource creation format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
create_user (str or None) – ID of the user who created this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
last_modified_time (long or None) – Timestamp of last modification format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
last_modified_user (str or None) – ID of the user who last modified this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
protection (str or None) – Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super user and can modify it, but only when providing the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this entity. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
system_owned (bool or None) – Indicates system owned resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
description (str or None) – Description of this resource
display_name (str or None) – Defaults to ID if not set
id (str or None) – Unique identifier of this resource
resource_type (str or None) – The type of this resource.
tags (list of Tag or None) – Opaque identifiers meaningful to the API user
parent_path (str or None) – Path of its parent This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
path (str or None) – Absolute path of this object This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
relative_path (str or None) – Path relative from its parent This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.

class com.vmware.nsx_policy.model_client.PolicyResourceReference(is_valid=None, target_display_name=None, target_id=None, target_type=None, path=None)¶

Bases: vmware.vapi.bindings.struct.VapiStruct

Policy resource reference.

Tip

The arguments are used to initialize data attributes with the same names.

Parameters

is_valid (bool or None) – Will be set to false if the referenced NSX resource has been deleted. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
target_display_name (str or None) – Display name of the NSX resource. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
target_id (str or None) – Identifier of the NSX resource.
target_type (str or None) – Type of the NSX resource.
path (str or None) – Absolute path of this object. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.

class com.vmware.nsx_policy.model_client.PolicyResourceReferenceForEP(is_valid=None, target_display_name=None, target_id=None, target_type=None, path=None)¶

Bases: vmware.vapi.bindings.struct.VapiStruct

Policy resource reference for enforcement point

Tip

The arguments are used to initialize data attributes with the same names.

Parameters

is_valid (bool or None) – Will be set to false if the referenced NSX resource has been deleted. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
target_display_name (str or None) – Display name of the NSX resource. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
target_id (str or None) – Identifier of the NSX resource.
target_type (str or None) – Type of the NSX resource.
path (str or None) – Absolute path of this object. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.

class com.vmware.nsx_policy.model_client.PolicyResourceReferenceForEPListResult(links=None, schema=None, self_=None, cursor=None, result_count=None, sort_ascending=None, sort_by=None, results=None)¶

Bases: vmware.vapi.bindings.struct.VapiStruct

Paginated collection of policy resource references for enforcement point

Tip

The arguments are used to initialize data attributes with the same names.

Parameters

links (list of ResourceLink or None) – The server will populate this field when returing the resource. Ignored on PUT and POST. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
schema (str or None) – Schema for this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
self (SelfResourceLink or None) – Link to this resource
cursor (str or None) – Opaque cursor to be used for getting next page of records (supplied by current result page) This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
result_count (long or None) – Count of results found (across all pages), set only on first page format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
sort_ascending (bool or None) – If true, results are sorted in ascending order This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
sort_by (str or None) – Field by which records are sorted This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
results (list of PolicyResourceReferenceForEP) – Paged Collection of policy resource references for enforcement point

class com.vmware.nsx_policy.model_client.PolicyRuntimeAlarm(error_details=None, error_id=None, message=None)¶

Bases: vmware.vapi.bindings.struct.VapiStruct

Alarm associated with the PolicyRuntimeInfoPerEP that exposes potential errors when retrieving runtime information from the enforcement point.

Tip

The arguments are used to initialize data attributes with the same names.

Parameters

error_details (PolicyApiError or None) – Detailed information about errors from an API call made to the enforcement point, if any.
error_id (str or None) – Alarm error id. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
message (str or None) – Error message describing the issue. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.

class com.vmware.nsx_policy.model_client.PolicyRuntimeInfoPerEP(alarm=None, enforcement_point_path=None)¶

Bases: vmware.vapi.bindings.struct.VapiStruct

Runtime Info Per Enforcement Point.

Tip

The arguments are used to initialize data attributes with the same names.

Parameters

alarm (PolicyRuntimeAlarm or None) – Alarm information details.
enforcement_point_path (str or None) – Policy Path referencing the enforcement point where the info is fetched. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.

class com.vmware.nsx_policy.model_client.PolicyServiceChain(links=None, schema=None, self_=None, revision=None, create_time=None, create_user=None, last_modified_time=None, last_modified_user=None, protection=None, system_owned=None, description=None, display_name=None, id=None, resource_type=None, tags=None, parent_path=None, path=None, relative_path=None, children=None, marked_for_delete=None, failure_policy=None, forward_path_service_profiles=None, path_selection_policy=None, reverse_path_service_profiles=None, service_segment_path=None)¶

Bases: vmware.vapi.bindings.struct.VapiStruct

Service chain is a set of network Services. A Service chain is made up of ordered list of service profiles belonging to any same or different services.

Tip

The arguments are used to initialize data attributes with the same names.

Parameters

links (list of ResourceLink or None) – The server will populate this field when returing the resource. Ignored on PUT and POST. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
schema (str or None) – Schema for this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
self (SelfResourceLink or None) – Link to this resource
revision (long or None) – The _revision property describes the current revision of the resource. To prevent clients from overwriting each other’s changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected. format: int32
create_time (long or None) – Timestamp of resource creation format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
create_user (str or None) – ID of the user who created this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
last_modified_time (long or None) – Timestamp of last modification format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
last_modified_user (str or None) – ID of the user who last modified this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
protection (str or None) – Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super user and can modify it, but only when providing the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this entity. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
system_owned (bool or None) – Indicates system owned resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
description (str or None) – Description of this resource
display_name (str or None) – Defaults to ID if not set
id (str or None) – Unique identifier of this resource
resource_type (str or None) – The type of this resource.
tags (list of Tag or None) – Opaque identifiers meaningful to the API user
parent_path (str or None) – Path of its parent This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
path (str or None) – Absolute path of this object This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
relative_path (str or None) – Path relative from its parent This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
children (list of vmware.vapi.struct.VapiStruct or None) – subtree for this type within policy tree containing nested elements. When clients pass a value of this class as a parameter, the attribute must contain all the attributes defined in ChildPolicyConfigResource. When methods return a value of this class as a return value, the attribute will contain all the attributes defined in ChildPolicyConfigResource.
marked_for_delete (bool or None) – Intent objects are not directly deleted from the system when a delete is invoked on them. They are marked for deletion and only when all the realized entities for that intent object gets deleted, the intent object is deleted. Objects that are marked for deletion are not returned in GET call. One can use the search API to get these objects. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
failure_policy (str or None) –
Possible values are:
- PolicyServiceChain.FAILURE_POLICY_ALLOW
- PolicyServiceChain.FAILURE_POLICY_BLOCK
Failure policy for the service defines the action to be taken i.e to allow or to block the traffic during failure scenarios.
forward_path_service_profiles (list of str) – Forward path service profiles are applied to ingress traffic.
path_selection_policy (str or None) –
Possible values are:
- PolicyServiceChain.PATH_SELECTION_POLICY_ANY
- PolicyServiceChain.PATH_SELECTION_POLICY_LOCAL
- PolicyServiceChain.PATH_SELECTION_POLICY_REMOTE
- PolicyServiceChain.PATH_SELECTION_POLICY_ROUND_ROBIN
Path selection policy can be - ANY - Service Insertion is free to redirect to any service path regardless of any load balancing considerations or flow pinning. LOCAL - Preference to be given to local service insances. REMOTE - Preference to be given to the SVM co-located on the same host. ROUND_ROBIN - All active service paths are hit with equal probability.
reverse_path_service_profiles (list of str or None) – Reverse path service profiles are applied to egress traffic and is optional. 2 different set of profiles can be defined for forward and reverse path. If not defined, the reverse of the forward path service profile is applied.
service_segment_path (list of str) – Path to service segment using which the traffic needs to be redirected.

FAILURE_POLICY_ALLOW = 'ALLOW'¶

FAILURE_POLICY_BLOCK = 'BLOCK'¶

PATH_SELECTION_POLICY_ANY = 'ANY'¶

PATH_SELECTION_POLICY_LOCAL = 'LOCAL'¶

PATH_SELECTION_POLICY_REMOTE = 'REMOTE'¶

PATH_SELECTION_POLICY_ROUND_ROBIN = 'ROUND_ROBIN'¶

class com.vmware.nsx_policy.model_client.PolicyServiceInstance(links=None, schema=None, self_=None, revision=None, create_time=None, create_user=None, last_modified_time=None, last_modified_user=None, protection=None, system_owned=None, description=None, display_name=None, id=None, resource_type=None, tags=None, parent_path=None, path=None, relative_path=None, children=None, marked_for_delete=None, deployment_mode=None, partner_service_name=None, transport_type=None, attributes=None, compute_id=None, context_id=None, deployment_spec_name=None, deployment_template_name=None, failure_policy=None, primary_gateway_address=None, primary_interface_mgmt_ip=None, primary_interface_network=None, primary_portgroup_id=None, primary_subnet_mask=None, secondary_gateway_address=None, secondary_interface_mgmt_ip=None, secondary_interface_network=None, secondary_portgroup_id=None, secondary_subnet_mask=None, storage_id=None)¶

Bases: vmware.vapi.bindings.struct.VapiStruct

Represents an instance of partner Service and its configuration.

Tip

The arguments are used to initialize data attributes with the same names.

Parameters

links (list of ResourceLink or None) – The server will populate this field when returing the resource. Ignored on PUT and POST. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
schema (str or None) – Schema for this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
self (SelfResourceLink or None) – Link to this resource
revision (long or None) – The _revision property describes the current revision of the resource. To prevent clients from overwriting each other’s changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected. format: int32
create_time (long or None) – Timestamp of resource creation format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
create_user (str or None) – ID of the user who created this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
last_modified_time (long or None) – Timestamp of last modification format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
last_modified_user (str or None) – ID of the user who last modified this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
protection (str or None) – Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super user and can modify it, but only when providing the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this entity. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
system_owned (bool or None) – Indicates system owned resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
description (str or None) – Description of this resource
display_name (str or None) – Defaults to ID if not set
id (str or None) – Unique identifier of this resource
resource_type (str or None) – The type of this resource.
tags (list of Tag or None) – Opaque identifiers meaningful to the API user
parent_path (str or None) – Path of its parent This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
path (str or None) – Absolute path of this object This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
relative_path (str or None) – Path relative from its parent This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
children (list of vmware.vapi.struct.VapiStruct or None) – subtree for this type within policy tree containing nested elements. When clients pass a value of this class as a parameter, the attribute must contain all the attributes defined in ChildPolicyConfigResource. When methods return a value of this class as a return value, the attribute will contain all the attributes defined in ChildPolicyConfigResource.
marked_for_delete (bool or None) – Intent objects are not directly deleted from the system when a delete is invoked on them. They are marked for deletion and only when all the realized entities for that intent object gets deleted, the intent object is deleted. Objects that are marked for deletion are not returned in GET call. One can use the search API to get these objects. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
deployment_mode (str or None) –
Possible values are:
- PolicyServiceInstance.DEPLOYMENT_MODE_STAND_ALONE
- PolicyServiceInstance.DEPLOYMENT_MODE_ACTIVE_STANDBY
Deployment mode specifies how the partner appliance will be deployed i.e. in HA or standalone mode.
partner_service_name (str) – Unique name of Partner Service in the Marketplace
transport_type (str or None) –
Possible values are:
- PolicyServiceInstance.TRANSPORT_TYPE_L2_BRIDGE
- PolicyServiceInstance.TRANSPORT_TYPE_L3_ROUTED
Transport to be used while deploying Service-VM.
attributes (list of Attribute) – List of attributes specific to a partner for which the service is created. There attributes are passed on to the partner appliance.
compute_id (str) – Id of the compute(ResourcePool) to which this service needs to be deployed.
context_id (str or None) – UUID of VCenter/Compute Manager as seen on NSX Manager, to which this service needs to be deployed.
deployment_spec_name (str) – Form factor for the deployment of partner service.
deployment_template_name (str) – Template for the deployment of partnet service.
failure_policy (str or None) –
Possible values are:
- PolicyServiceInstance.FAILURE_POLICY_ALLOW
- PolicyServiceInstance.FAILURE_POLICY_BLOCK
Failure policy for the Service VM. If this values is not provided, it will be defaulted to FAIL_CLOSE.
primary_gateway_address (str or None) – Gateway address for primary management console. If the provided segment already has gateway, this field can be omitted. But if it is provided, it takes precedence always. However, if provided segment does not have gateway, this field must be provided. format: address-or-block-or-range
primary_interface_mgmt_ip (str) – Management IP Address of primary interface of the Service format: address-or-block-or-range
primary_interface_network (str or None) – Path of the segment to which primary interface of the Service VM needs to be connected
primary_portgroup_id (str or None) – Id of the standard or ditsributed port group for primary management console. Please note that only 1 of the 2 values from 1. primary_interface_network 2. primary_portgroup_id are allowed to be passed. Both can’t be passed in the same request.
primary_subnet_mask (str or None) – Subnet for primary management console IP. If the provided segment already has subnet, this field can be omitted. But if it is provided, it takes precedence always. However, if provided segment does not have subnet, this field must be provided. format: address-or-block-or-range
secondary_gateway_address (str or None) – Gateway address for secondary management console. If the provided segment already has gateway, this field can be omitted. But if it is provided, it takes precedence always. However, if provided segment does not have gateway, this field must be provided. format: address-or-block-or-range
secondary_interface_mgmt_ip (str) – Management IP Address of secondary interface of the Service format: address-or-block-or-range
secondary_interface_network (str or None) – Path of segment to which secondary interface of the Service VM needs to be connected
secondary_portgroup_id (str or None) – Id of the standard or ditsributed port group for secondary management console. Please note that only 1 of the 2 values from 1. secondary_interface_network 2. secondary_portgroup_id are allowed to be passed. Both can’t be passed in the same request.
secondary_subnet_mask (str or None) – Subnet for secondary management console IP. If the provided segment already has subnet, this field can be omitted. But if it is provided, it takes precedence always. However, if provided segment does not have subnet, this field must be provided. format: address-or-block-or-range
storage_id (str) – Id of the storage(Datastore). VC moref of Datastore to which this service needs to be deployed.

DEPLOYMENT_MODE_ACTIVE_STANDBY = 'ACTIVE_STANDBY'¶

DEPLOYMENT_MODE_STAND_ALONE = 'STAND_ALONE'¶

FAILURE_POLICY_ALLOW = 'ALLOW'¶

FAILURE_POLICY_BLOCK = 'BLOCK'¶

TRANSPORT_TYPE_L2_BRIDGE = 'L2_BRIDGE'¶

TRANSPORT_TYPE_L3_ROUTED = 'L3_ROUTED'¶

class com.vmware.nsx_policy.model_client.PolicyServiceInstanceListResult(links=None, schema=None, self_=None, cursor=None, result_count=None, sort_ascending=None, sort_by=None, results=None)¶

Bases: vmware.vapi.bindings.struct.VapiStruct

Collection of only SI objects

Tip

The arguments are used to initialize data attributes with the same names.

Parameters

links (list of ResourceLink or None) – The server will populate this field when returing the resource. Ignored on PUT and POST. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
schema (str or None) – Schema for this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
self (SelfResourceLink or None) – Link to this resource
cursor (str or None) – Opaque cursor to be used for getting next page of records (supplied by current result page) This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
result_count (long or None) – Count of results found (across all pages), set only on first page format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
sort_ascending (bool or None) – If true, results are sorted in ascending order This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
sort_by (str or None) – Field by which records are sorted This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
results (list of PolicyServiceInstance) – Service instance list results

class com.vmware.nsx_policy.model_client.PolicyServiceInstanceStatistics(links=None, schema=None, self_=None, enforcement_point_path=None, instance_runtime_statistics=None, service_instance_id=None)¶

Bases: vmware.vapi.bindings.struct.VapiStruct

Statistics for NICs for a PolicyServiceInstance

Tip

The arguments are used to initialize data attributes with the same names.

Parameters

links (list of ResourceLink or None) – The server will populate this field when returing the resource. Ignored on PUT and POST. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
schema (str or None) – Schema for this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
self (SelfResourceLink or None) – Link to this resource
enforcement_point_path (str or None) – Enforcement point path, forward slashes must be escaped using %2F. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
instance_runtime_statistics (list of InstanceRuntimeStatistic or None) – Statistics for the data NICs for all the runtimes associated with this service instance. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
service_instance_id (str or None) – PolicyServiceInsatnce path This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.

class com.vmware.nsx_policy.model_client.PolicyServiceProfile(links=None, schema=None, self_=None, revision=None, create_time=None, create_user=None, last_modified_time=None, last_modified_user=None, protection=None, system_owned=None, description=None, display_name=None, id=None, resource_type=None, tags=None, parent_path=None, path=None, relative_path=None, children=None, marked_for_delete=None, attributes=None, redirection_action=None, vendor_template_key=None, vendor_template_name=None)¶

Bases: vmware.vapi.bindings.struct.VapiStruct

Service profile represents specialization of a vendor template. User may provide any of the vendor_template_name or vendor_template_key properties. But in case of multiple vendor templates with the same name, it is recommended to use the vendor_template_key. When both attributes are provided, name is ignored and only key is used to identify the template. If there are multiple templates with same name, and vendor_template_name is provided, realization will fail.

Tip

The arguments are used to initialize data attributes with the same names.

Parameters

links (list of ResourceLink or None) – The server will populate this field when returing the resource. Ignored on PUT and POST. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
schema (str or None) – Schema for this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
self (SelfResourceLink or None) – Link to this resource
revision (long or None) – The _revision property describes the current revision of the resource. To prevent clients from overwriting each other’s changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected. format: int32
create_time (long or None) – Timestamp of resource creation format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
create_user (str or None) – ID of the user who created this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
last_modified_time (long or None) – Timestamp of last modification format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
last_modified_user (str or None) – ID of the user who last modified this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
protection (str or None) – Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super user and can modify it, but only when providing the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this entity. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
system_owned (bool or None) – Indicates system owned resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
description (str or None) – Description of this resource
display_name (str or None) – Defaults to ID if not set
id (str or None) – Unique identifier of this resource
resource_type (str or None) – The type of this resource.
tags (list of Tag or None) – Opaque identifiers meaningful to the API user
parent_path (str or None) – Path of its parent This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
path (str or None) – Absolute path of this object This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
relative_path (str or None) – Path relative from its parent This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
children (list of vmware.vapi.struct.VapiStruct or None) – subtree for this type within policy tree containing nested elements. When clients pass a value of this class as a parameter, the attribute must contain all the attributes defined in ChildPolicyConfigResource. When methods return a value of this class as a return value, the attribute will contain all the attributes defined in ChildPolicyConfigResource.
marked_for_delete (bool or None) – Intent objects are not directly deleted from the system when a delete is invoked on them. They are marked for deletion and only when all the realized entities for that intent object gets deleted, the intent object is deleted. Objects that are marked for deletion are not returned in GET call. One can use the search API to get these objects. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
attributes (list of Attribute or None) – List of attributes specific to a partner for which the service is created. These attributes are passed on to the partner appliance and are opaque to NSX. If a vendor template exposes configurable parameters, then their values are specified here.
redirection_action (str or None) –
Possible values are:
- PolicyServiceProfile.REDIRECTION_ACTION_PUNT
- PolicyServiceProfile.REDIRECTION_ACTION_COPY
The redirection action represents if the packet is exclusively redirected to the service, or if a copy is forwarded to the service. Redirection action is not applicable to guest introspection service.
vendor_template_key (str or None) – The vendor template key property of actual vendor template. This should be used when multiple templates with same name exist.
vendor_template_name (str or None) – Name of the vendor template for which this Service Profile is being created.

REDIRECTION_ACTION_COPY = 'COPY'¶

REDIRECTION_ACTION_PUNT = 'PUNT'¶

class com.vmware.nsx_policy.model_client.PolicySubAttributes(datatype=None, key=None, value=None)¶

Bases: vmware.vapi.bindings.struct.VapiStruct

Policy Sub Attributes data holder

Tip

The arguments are used to initialize data attributes with the same names.

Parameters

datatype (str) –
Possible values are:
- PolicySubAttributes.DATATYPE_STRING
Datatype for sub attribute
key (str) –
Possible values are:
Key for sub attribute
value (list of str) – Multiple sub attribute values can be specified as elements of array.

DATATYPE_STRING = 'STRING'¶

KEY_CIFS_SMB_VERSION = 'CIFS_SMB_VERSION'¶

KEY_TLS_CIPHER_SUITE = 'TLS_CIPHER_SUITE'¶

KEY_TLS_VERSION = 'TLS_VERSION'¶

class com.vmware.nsx_policy.model_client.PolicyTransportZone(links=None, schema=None, self_=None, revision=None, create_time=None, create_user=None, last_modified_time=None, last_modified_user=None, protection=None, system_owned=None, description=None, display_name=None, id=None, resource_type=None, tags=None, parent_path=None, path=None, relative_path=None, children=None, marked_for_delete=None, is_default=None, nsx_id=None, tz_type=None)¶

Bases: vmware.vapi.bindings.struct.VapiStruct

Policy manager periodically reads transport zones (TZ) from enforcement point and corresponding read-only intent objects are auto-created.

Tip

The arguments are used to initialize data attributes with the same names.

Parameters

links (list of ResourceLink or None) – The server will populate this field when returing the resource. Ignored on PUT and POST. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
schema (str or None) – Schema for this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
self (SelfResourceLink or None) – Link to this resource
revision (long or None) – The _revision property describes the current revision of the resource. To prevent clients from overwriting each other’s changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected. format: int32
create_time (long or None) – Timestamp of resource creation format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
create_user (str or None) – ID of the user who created this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
last_modified_time (long or None) – Timestamp of last modification format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
last_modified_user (str or None) – ID of the user who last modified this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
protection (str or None) – Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super user and can modify it, but only when providing the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this entity. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
system_owned (bool or None) – Indicates system owned resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
description (str or None) – Description of this resource
display_name (str or None) – Defaults to ID if not set
id (str or None) – Unique identifier of this resource
resource_type (str or None) – The type of this resource.
tags (list of Tag or None) – Opaque identifiers meaningful to the API user
parent_path (str or None) – Path of its parent This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
path (str or None) – Absolute path of this object This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
relative_path (str or None) – Path relative from its parent This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
children (list of vmware.vapi.struct.VapiStruct or None) – subtree for this type within policy tree containing nested elements. When clients pass a value of this class as a parameter, the attribute must contain all the attributes defined in ChildPolicyConfigResource. When methods return a value of this class as a return value, the attribute will contain all the attributes defined in ChildPolicyConfigResource.
marked_for_delete (bool or None) – Intent objects are not directly deleted from the system when a delete is invoked on them. They are marked for deletion and only when all the realized entities for that intent object gets deleted, the intent object is deleted. Objects that are marked for deletion are not returned in GET call. One can use the search API to get these objects. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
is_default (bool or None) – Indicates whether the transport zone is default.
nsx_id (str or None) – UUID of transport zone on enforcement point. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
tz_type (str or None) –
Possible values are:
- PolicyTransportZone.TZ_TYPE_OVERLAY_STANDARD
- PolicyTransportZone.TZ_TYPE_OVERLAY_ENS
- PolicyTransportZone.TZ_TYPE_VLAN_BACKED
- PolicyTransportZone.TZ_TYPE_UNKNOWN
Type of Transport Zone

This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.

TZ_TYPE_OVERLAY_ENS = 'OVERLAY_ENS'¶

TZ_TYPE_OVERLAY_STANDARD = 'OVERLAY_STANDARD'¶

TZ_TYPE_UNKNOWN = 'UNKNOWN'¶

TZ_TYPE_VLAN_BACKED = 'VLAN_BACKED'¶

class com.vmware.nsx_policy.model_client.PolicyTransportZoneListResult(links=None, schema=None, self_=None, cursor=None, result_count=None, sort_ascending=None, sort_by=None, results=None)¶

Bases: vmware.vapi.bindings.struct.VapiStruct

Paged Collection of Transport Zone

Tip

The arguments are used to initialize data attributes with the same names.

Parameters

links (list of ResourceLink or None) – The server will populate this field when returing the resource. Ignored on PUT and POST. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
schema (str or None) – Schema for this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
self (SelfResourceLink or None) – Link to this resource
cursor (str or None) – Opaque cursor to be used for getting next page of records (supplied by current result page) This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
result_count (long or None) – Count of results found (across all pages), set only on first page format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
sort_ascending (bool or None) – If true, results are sorted in ascending order This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
sort_by (str or None) – Field by which records are sorted This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
results (list of PolicyTransportZone) – Transport Zone

class com.vmware.nsx_policy.model_client.PoolMemberSetting(admin_state=None, display_name=None, ip_address=None, port=None, weight=None)¶

Bases: vmware.vapi.bindings.struct.VapiStruct

The setting is used to add, update or remove pool members from pool. For static pool members, admin_state, display_name and weight can be updated. For dynamic pool members, only admin_state can be updated.

Tip

The arguments are used to initialize data attributes with the same names.

Parameters

admin_state (str or None) –
Possible values are:
Member admin state
display_name (str or None) – Only applicable to static pool members. If supplied for a pool defined by a grouping object, update API would fail.
ip_address (str) – Pool member IP address format: ip
port (str or None) – Pool member port number format: port-or-range
weight (long or None) – Only applicable to static pool members. If supplied for a pool defined by a grouping object, update API would fail. format: int64

ADMIN_STATE_DISABLED = 'DISABLED'¶

ADMIN_STATE_ENABLED = 'ENABLED'¶

ADMIN_STATE_GRACEFUL_DISABLED = 'GRACEFUL_DISABLED'¶

class com.vmware.nsx_policy.model_client.PortAddressBindingEntry(ip_address=None, mac_address=None, vlan_id=None)¶

Bases: vmware.vapi.bindings.struct.VapiStruct

Detailed information about static address for the port.

Tip

The arguments are used to initialize data attributes with the same names.

Parameters

ip_address (str or None) – IP Address for port binding
mac_address (str or None) – Mac address for port binding
vlan_id (long or None) – VLAN ID for port binding format: int64

class com.vmware.nsx_policy.model_client.PortAttachment(allocate_addresses=None, app_id=None, context_id=None, id=None, traffic_tag=None, type=None)¶

Bases: vmware.vapi.bindings.struct.VapiStruct

Detail information about port attachment

Tip

The arguments are used to initialize data attributes with the same names.

Parameters

allocate_addresses (str or None) –
Possible values are:
Indicate how IP will be allocated for the port
app_id (str or None) – ID used to identify/look up a child attachment behind a parent attachment
context_id (str or None) – Parent VIF ID if type is CHILD, Transport node ID if type is INDEPENDENT
id (str or None) – VIF UUID on NSX Manager. If the attachement type is PARENT, this property is required.
traffic_tag (long or None) – Not valid when type is INDEPENDENT, mainly used to identify traffic from different ports in container use case format: int64
type (str or None) –
Possible values are:
Type of port attachment, it’s an Enum value.

ALLOCATE_ADDRESSES_BOTH = 'BOTH'¶

ALLOCATE_ADDRESSES_IP_POOL = 'IP_POOL'¶

ALLOCATE_ADDRESSES_MAC_POOL = 'MAC_POOL'¶

ALLOCATE_ADDRESSES_NONE = 'NONE'¶

TYPE_CHILD = 'CHILD'¶

TYPE_INDEPENDENT = 'INDEPENDENT'¶

TYPE_PARENT = 'PARENT'¶

class com.vmware.nsx_policy.model_client.PortDiscoveryProfileBindingMap(links=None, schema=None, self_=None, revision=None, create_time=None, create_user=None, last_modified_time=None, last_modified_user=None, protection=None, system_owned=None, description=None, display_name=None, id=None, resource_type=None, tags=None, parent_path=None, path=None, relative_path=None, children=None, marked_for_delete=None, ip_discovery_profile_path=None, mac_discovery_profile_path=None)¶

Bases: vmware.vapi.bindings.struct.VapiStruct

This entity will be used to establish association between discovery profile and Port. Using this entity, user can specify intent for applying discovery profile to particular Port. Port here is Logical Port.

Tip

The arguments are used to initialize data attributes with the same names.

Parameters

links (list of ResourceLink or None) – The server will populate this field when returing the resource. Ignored on PUT and POST. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
schema (str or None) – Schema for this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
self (SelfResourceLink or None) – Link to this resource
revision (long or None) – The _revision property describes the current revision of the resource. To prevent clients from overwriting each other’s changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected. format: int32
create_time (long or None) – Timestamp of resource creation format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
create_user (str or None) – ID of the user who created this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
last_modified_time (long or None) – Timestamp of last modification format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
last_modified_user (str or None) – ID of the user who last modified this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
protection (str or None) – Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super user and can modify it, but only when providing the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this entity. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
system_owned (bool or None) – Indicates system owned resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
description (str or None) – Description of this resource
display_name (str or None) – Defaults to ID if not set
id (str or None) – Unique identifier of this resource
resource_type (str or None) – The type of this resource.
tags (list of Tag or None) – Opaque identifiers meaningful to the API user
parent_path (str or None) – Path of its parent This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
path (str or None) – Absolute path of this object This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
relative_path (str or None) – Path relative from its parent This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
children (list of vmware.vapi.struct.VapiStruct or None) – subtree for this type within policy tree containing nested elements. When clients pass a value of this class as a parameter, the attribute must contain all the attributes defined in ChildPolicyConfigResource. When methods return a value of this class as a return value, the attribute will contain all the attributes defined in ChildPolicyConfigResource.
marked_for_delete (bool or None) – Intent objects are not directly deleted from the system when a delete is invoked on them. They are marked for deletion and only when all the realized entities for that intent object gets deleted, the intent object is deleted. Objects that are marked for deletion are not returned in GET call. One can use the search API to get these objects. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
ip_discovery_profile_path (str or None) – PolicyPath of associated IP Discovery Profile
mac_discovery_profile_path (str or None) – PolicyPath of associated Mac Discovery Profile

class com.vmware.nsx_policy.model_client.PortDiscoveryProfileBindingMapListResult(links=None, schema=None, self_=None, cursor=None, result_count=None, sort_ascending=None, sort_by=None, results=None)¶

Bases: vmware.vapi.bindings.struct.VapiStruct

Paged collection of Port Discovery Profile Binding Maps

Tip

The arguments are used to initialize data attributes with the same names.

Parameters

links (list of ResourceLink or None) – The server will populate this field when returing the resource. Ignored on PUT and POST. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
schema (str or None) – Schema for this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
self (SelfResourceLink or None) – Link to this resource
cursor (str or None) – Opaque cursor to be used for getting next page of records (supplied by current result page) This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
result_count (long or None) – Count of results found (across all pages), set only on first page format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
sort_ascending (bool or None) – If true, results are sorted in ascending order This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
sort_by (str or None) – Field by which records are sorted This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
results (list of PortDiscoveryProfileBindingMap) – Port Discovery Profile Binding Map list results

class com.vmware.nsx_policy.model_client.PortMirroringInstance(links=None, schema=None, self_=None, revision=None, create_time=None, create_user=None, last_modified_time=None, last_modified_user=None, protection=None, system_owned=None, description=None, display_name=None, id=None, resource_type=None, tags=None, parent_path=None, path=None, relative_path=None, children=None, marked_for_delete=None, destination_group=None, direction=None, snap_length=None)¶

Bases: vmware.vapi.bindings.struct.VapiStruct

Mirrors Data from source to destination

Tip

The arguments are used to initialize data attributes with the same names.

Parameters

links (list of ResourceLink or None) – The server will populate this field when returing the resource. Ignored on PUT and POST. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
schema (str or None) – Schema for this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
self (SelfResourceLink or None) – Link to this resource
revision (long or None) – The _revision property describes the current revision of the resource. To prevent clients from overwriting each other’s changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected. format: int32
create_time (long or None) – Timestamp of resource creation format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
create_user (str or None) – ID of the user who created this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
last_modified_time (long or None) – Timestamp of last modification format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
last_modified_user (str or None) – ID of the user who last modified this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
protection (str or None) – Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super user and can modify it, but only when providing the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this entity. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
system_owned (bool or None) – Indicates system owned resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
description (str or None) – Description of this resource
display_name (str or None) – Defaults to ID if not set
id (str or None) – Unique identifier of this resource
resource_type (str or None) – The type of this resource.
tags (list of Tag or None) – Opaque identifiers meaningful to the API user
parent_path (str or None) – Path of its parent This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
path (str or None) – Absolute path of this object This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
relative_path (str or None) – Path relative from its parent This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
children (list of vmware.vapi.struct.VapiStruct or None) – subtree for this type within policy tree containing nested elements. When clients pass a value of this class as a parameter, the attribute must contain all the attributes defined in ChildPolicyConfigResource. When methods return a value of this class as a return value, the attribute will contain all the attributes defined in ChildPolicyConfigResource.
marked_for_delete (bool or None) – Intent objects are not directly deleted from the system when a delete is invoked on them. They are marked for deletion and only when all the realized entities for that intent object gets deleted, the intent object is deleted. Objects that are marked for deletion are not returned in GET call. One can use the search API to get these objects. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
destination_group (str) – Data from source group will be copied to members of destination group.
direction (str or None) –
Possible values are:
- PortMirroringInstance.DIRECTION_INGRESS
- PortMirroringInstance.DIRECTION_EGRESS
- PortMirroringInstance.DIRECTION_BIDIRECTIONAL
Port mirroring instance direction
snap_length (long or None) – If this property is set, the packet will be truncated to the provided length. If this property is unset, entire packet will be mirrored. format: int32

DIRECTION_BIDIRECTIONAL = 'BIDIRECTIONAL'¶

DIRECTION_EGRESS = 'EGRESS'¶

DIRECTION_INGRESS = 'INGRESS'¶

class com.vmware.nsx_policy.model_client.PortMirroringInstanceListResult(links=None, schema=None, self_=None, cursor=None, result_count=None, sort_ascending=None, sort_by=None, results=None)¶

Bases: vmware.vapi.bindings.struct.VapiStruct

Paged collection of port mirroring instances

Tip

The arguments are used to initialize data attributes with the same names.

Parameters

links (list of ResourceLink or None) – The server will populate this field when returing the resource. Ignored on PUT and POST. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
schema (str or None) – Schema for this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
self (SelfResourceLink or None) – Link to this resource
cursor (str or None) – Opaque cursor to be used for getting next page of records (supplied by current result page) This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
result_count (long or None) – Count of results found (across all pages), set only on first page format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
sort_ascending (bool or None) – If true, results are sorted in ascending order This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
sort_by (str or None) – Field by which records are sorted This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
results (list of PortMirroringInstance) – Port Mirroring Instances list results

class com.vmware.nsx_policy.model_client.PortMirroringProfile(links=None, schema=None, self_=None, revision=None, create_time=None, create_user=None, last_modified_time=None, last_modified_user=None, protection=None, system_owned=None, description=None, display_name=None, id=None, resource_type=None, tags=None, parent_path=None, path=None, relative_path=None, children=None, marked_for_delete=None, destination_group=None, direction=None, encapsulation_type=None, erspan_id=None, gre_key=None, profile_type=None, snap_length=None)¶

Bases: vmware.vapi.bindings.struct.VapiStruct

Mirrors Data from source to destination

Tip

The arguments are used to initialize data attributes with the same names.

Parameters

links (list of ResourceLink or None) – The server will populate this field when returing the resource. Ignored on PUT and POST. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
schema (str or None) – Schema for this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
self (SelfResourceLink or None) – Link to this resource
revision (long or None) – The _revision property describes the current revision of the resource. To prevent clients from overwriting each other’s changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected. format: int32
create_time (long or None) – Timestamp of resource creation format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
create_user (str or None) – ID of the user who created this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
last_modified_time (long or None) – Timestamp of last modification format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
last_modified_user (str or None) – ID of the user who last modified this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
protection (str or None) – Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super user and can modify it, but only when providing the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this entity. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
system_owned (bool or None) – Indicates system owned resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
description (str or None) – Description of this resource
display_name (str or None) – Defaults to ID if not set
id (str or None) – Unique identifier of this resource
resource_type (str or None) – The type of this resource.
tags (list of Tag or None) – Opaque identifiers meaningful to the API user
parent_path (str or None) – Path of its parent This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
path (str or None) – Absolute path of this object This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
relative_path (str or None) – Path relative from its parent This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
children (list of vmware.vapi.struct.VapiStruct or None) – subtree for this type within policy tree containing nested elements. When clients pass a value of this class as a parameter, the attribute must contain all the attributes defined in ChildPolicyConfigResource. When methods return a value of this class as a return value, the attribute will contain all the attributes defined in ChildPolicyConfigResource.
marked_for_delete (bool or None) – Intent objects are not directly deleted from the system when a delete is invoked on them. They are marked for deletion and only when all the realized entities for that intent object gets deleted, the intent object is deleted. Objects that are marked for deletion are not returned in GET call. One can use the search API to get these objects. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
destination_group (str) – Data from source group will be copied to members of destination group. Only IPSET group and group with membership criteria VM is supported. IPSET group allows only three ip’s.
direction (str or None) –
Possible values are:
- PortMirroringProfile.DIRECTION_INGRESS
- PortMirroringProfile.DIRECTION_EGRESS
- PortMirroringProfile.DIRECTION_BIDIRECTIONAL
Port mirroring profile direction
encapsulation_type (str or None) –
Possible values are:
- PortMirroringProfile.ENCAPSULATION_TYPE_GRE
- PortMirroringProfile.ENCAPSULATION_TYPE_ERSPAN_TWO
- PortMirroringProfile.ENCAPSULATION_TYPE_ERSPAN_THREE
User can provide Mirror Destination type e.g GRE, ERSPAN_TWO or ERSPAN_THREE.If profile type is REMOTE_L3_SPAN, encapsulation type is used else ignored.
erspan_id (long or None) – Used by physical switch for the mirror traffic forwarding. Must be provided and only effective when encapsulation type is ERSPAN type II or type III. format: int32
gre_key (long or None) – User-configurable 32-bit key only for GRE format: int32
profile_type (str or None) –
Possible values are:
- PortMirroringProfile.PROFILE_TYPE_REMOTE_L3_SPAN
- PortMirroringProfile.PROFILE_TYPE_LOGICAL_SPAN
Allows user to select type of port mirroring session.
snap_length (long or None) – If this property is set, the packet will be truncated to the provided length. If this property is unset, entire packet will be mirrored. format: int32

DIRECTION_BIDIRECTIONAL = 'BIDIRECTIONAL'¶

DIRECTION_EGRESS = 'EGRESS'¶

DIRECTION_INGRESS = 'INGRESS'¶

ENCAPSULATION_TYPE_ERSPAN_THREE = 'ERSPAN_THREE'¶

ENCAPSULATION_TYPE_ERSPAN_TWO = 'ERSPAN_TWO'¶

ENCAPSULATION_TYPE_GRE = 'GRE'¶

PROFILE_TYPE_LOGICAL_SPAN = 'LOGICAL_SPAN'¶

PROFILE_TYPE_REMOTE_L3_SPAN = 'REMOTE_L3_SPAN'¶

class com.vmware.nsx_policy.model_client.PortMirroringProfileListResult(links=None, schema=None, self_=None, cursor=None, result_count=None, sort_ascending=None, sort_by=None, results=None)¶

Bases: vmware.vapi.bindings.struct.VapiStruct

Paged collection of port mirroring profiles

Tip

The arguments are used to initialize data attributes with the same names.

Parameters

links (list of ResourceLink or None) – The server will populate this field when returing the resource. Ignored on PUT and POST. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
schema (str or None) – Schema for this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
self (SelfResourceLink or None) – Link to this resource
cursor (str or None) – Opaque cursor to be used for getting next page of records (supplied by current result page) This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
result_count (long or None) – Count of results found (across all pages), set only on first page format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
sort_ascending (bool or None) – If true, results are sorted in ascending order This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
sort_by (str or None) – Field by which records are sorted This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
results (list of PortMirroringProfile) – Port Mirroring Profiles list results

class com.vmware.nsx_policy.model_client.PortMonitoringProfileBindingMap(links=None, schema=None, self_=None, revision=None, create_time=None, create_user=None, last_modified_time=None, last_modified_user=None, protection=None, system_owned=None, description=None, display_name=None, id=None, resource_type=None, tags=None, parent_path=None, path=None, relative_path=None, children=None, marked_for_delete=None, ipfix_l2_profile_path=None, port_mirroring_profile_path=None)¶

Bases: vmware.vapi.bindings.struct.VapiStruct

This entity will be used to establish association between monitoring profile and Port. Using this entity, user can specify intent for applying monitoring profile to particular Port. Port here is Segment Port.

Tip

The arguments are used to initialize data attributes with the same names.

Parameters

links (list of ResourceLink or None) – The server will populate this field when returing the resource. Ignored on PUT and POST. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
schema (str or None) – Schema for this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
self (SelfResourceLink or None) – Link to this resource
revision (long or None) – The _revision property describes the current revision of the resource. To prevent clients from overwriting each other’s changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected. format: int32
create_time (long or None) – Timestamp of resource creation format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
create_user (str or None) – ID of the user who created this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
last_modified_time (long or None) – Timestamp of last modification format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
last_modified_user (str or None) – ID of the user who last modified this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
protection (str or None) – Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super user and can modify it, but only when providing the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this entity. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
system_owned (bool or None) – Indicates system owned resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
description (str or None) – Description of this resource
display_name (str or None) – Defaults to ID if not set
id (str or None) – Unique identifier of this resource
resource_type (str or None) – The type of this resource.
tags (list of Tag or None) – Opaque identifiers meaningful to the API user
parent_path (str or None) – Path of its parent This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
path (str or None) – Absolute path of this object This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
relative_path (str or None) – Path relative from its parent This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
children (list of vmware.vapi.struct.VapiStruct or None) – subtree for this type within policy tree containing nested elements. When clients pass a value of this class as a parameter, the attribute must contain all the attributes defined in ChildPolicyConfigResource. When methods return a value of this class as a return value, the attribute will contain all the attributes defined in ChildPolicyConfigResource.
marked_for_delete (bool or None) – Intent objects are not directly deleted from the system when a delete is invoked on them. They are marked for deletion and only when all the realized entities for that intent object gets deleted, the intent object is deleted. Objects that are marked for deletion are not returned in GET call. One can use the search API to get these objects. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
ipfix_l2_profile_path (str or None) – PolicyPath of associated IPFIX L2 Profile
port_mirroring_profile_path (str or None) – PolicyPath of associated Port Mirroring Profile

class com.vmware.nsx_policy.model_client.PortMonitoringProfileBindingMapListResult(links=None, schema=None, self_=None, cursor=None, result_count=None, sort_ascending=None, sort_by=None, results=None)¶

Bases: vmware.vapi.bindings.struct.VapiStruct

Paged collection of Port Monitoring Profile Binding Maps

Tip

The arguments are used to initialize data attributes with the same names.

Parameters

links (list of ResourceLink or None) – The server will populate this field when returing the resource. Ignored on PUT and POST. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
schema (str or None) – Schema for this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
self (SelfResourceLink or None) – Link to this resource
cursor (str or None) – Opaque cursor to be used for getting next page of records (supplied by current result page) This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
result_count (long or None) – Count of results found (across all pages), set only on first page format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
sort_ascending (bool or None) – If true, results are sorted in ascending order This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
sort_by (str or None) – Field by which records are sorted This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
results (list of PortMonitoringProfileBindingMap) – Port Monitoring Profile Binding Map list results

class com.vmware.nsx_policy.model_client.PortQosProfileBindingMap(links=None, schema=None, self_=None, revision=None, create_time=None, create_user=None, last_modified_time=None, last_modified_user=None, protection=None, system_owned=None, description=None, display_name=None, id=None, resource_type=None, tags=None, parent_path=None, path=None, relative_path=None, children=None, marked_for_delete=None, qos_profile_path=None)¶

Bases: vmware.vapi.bindings.struct.VapiStruct

This entity will be used to establish association between qos profile and Port. Using this entity, you can specify intent for applying qos profile to particular Port. Port here is Segment Port.

Tip

The arguments are used to initialize data attributes with the same names.

Parameters

links (list of ResourceLink or None) – The server will populate this field when returing the resource. Ignored on PUT and POST. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
schema (str or None) – Schema for this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
self (SelfResourceLink or None) – Link to this resource
revision (long or None) – The _revision property describes the current revision of the resource. To prevent clients from overwriting each other’s changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected. format: int32
create_time (long or None) – Timestamp of resource creation format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
create_user (str or None) – ID of the user who created this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
last_modified_time (long or None) – Timestamp of last modification format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
last_modified_user (str or None) – ID of the user who last modified this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
protection (str or None) – Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super user and can modify it, but only when providing the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this entity. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
system_owned (bool or None) – Indicates system owned resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
description (str or None) – Description of this resource
display_name (str or None) – Defaults to ID if not set
id (str or None) – Unique identifier of this resource
resource_type (str or None) – The type of this resource.
tags (list of Tag or None) – Opaque identifiers meaningful to the API user
parent_path (str or None) – Path of its parent This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
path (str or None) – Absolute path of this object This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
relative_path (str or None) – Path relative from its parent This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
children (list of vmware.vapi.struct.VapiStruct or None) – subtree for this type within policy tree containing nested elements. When clients pass a value of this class as a parameter, the attribute must contain all the attributes defined in ChildPolicyConfigResource. When methods return a value of this class as a return value, the attribute will contain all the attributes defined in ChildPolicyConfigResource.
marked_for_delete (bool or None) – Intent objects are not directly deleted from the system when a delete is invoked on them. They are marked for deletion and only when all the realized entities for that intent object gets deleted, the intent object is deleted. Objects that are marked for deletion are not returned in GET call. One can use the search API to get these objects. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
qos_profile_path (str or None) – PolicyPath of associated QoS Profile

class com.vmware.nsx_policy.model_client.PortQosProfileBindingMapListResult(links=None, schema=None, self_=None, cursor=None, result_count=None, sort_ascending=None, sort_by=None, results=None)¶

Bases: vmware.vapi.bindings.struct.VapiStruct

Paged collection of Port QoS Profile Binding Maps

Tip

The arguments are used to initialize data attributes with the same names.

Parameters

links (list of ResourceLink or None) – The server will populate this field when returing the resource. Ignored on PUT and POST. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
schema (str or None) – Schema for this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
self (SelfResourceLink or None) – Link to this resource
cursor (str or None) – Opaque cursor to be used for getting next page of records (supplied by current result page) This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
result_count (long or None) – Count of results found (across all pages), set only on first page format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
sort_ascending (bool or None) – If true, results are sorted in ascending order This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
sort_by (str or None) – Field by which records are sorted This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
results (list of PortQosProfileBindingMap) – Port QoS Profile Binding Map list results

class com.vmware.nsx_policy.model_client.PortSecurityProfileBindingMap(links=None, schema=None, self_=None, revision=None, create_time=None, create_user=None, last_modified_time=None, last_modified_user=None, protection=None, system_owned=None, description=None, display_name=None, id=None, resource_type=None, tags=None, parent_path=None, path=None, relative_path=None, children=None, marked_for_delete=None, segment_security_profile_path=None, spoofguard_profile_path=None)¶

Bases: vmware.vapi.bindings.struct.VapiStruct

Contains the binding relationship between port and security profile.

Tip

The arguments are used to initialize data attributes with the same names.

Parameters

links (list of ResourceLink or None) – The server will populate this field when returing the resource. Ignored on PUT and POST. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
schema (str or None) – Schema for this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
self (SelfResourceLink or None) – Link to this resource
revision (long or None) – The _revision property describes the current revision of the resource. To prevent clients from overwriting each other’s changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected. format: int32
create_time (long or None) – Timestamp of resource creation format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
create_user (str or None) – ID of the user who created this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
last_modified_time (long or None) – Timestamp of last modification format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
last_modified_user (str or None) – ID of the user who last modified this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
protection (str or None) – Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super user and can modify it, but only when providing the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this entity. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
system_owned (bool or None) – Indicates system owned resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
description (str or None) – Description of this resource
display_name (str or None) – Defaults to ID if not set
id (str or None) – Unique identifier of this resource
resource_type (str or None) – The type of this resource.
tags (list of Tag or None) – Opaque identifiers meaningful to the API user
parent_path (str or None) – Path of its parent This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
path (str or None) – Absolute path of this object This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
relative_path (str or None) – Path relative from its parent This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
children (list of vmware.vapi.struct.VapiStruct or None) – subtree for this type within policy tree containing nested elements. When clients pass a value of this class as a parameter, the attribute must contain all the attributes defined in ChildPolicyConfigResource. When methods return a value of this class as a return value, the attribute will contain all the attributes defined in ChildPolicyConfigResource.
marked_for_delete (bool or None) – Intent objects are not directly deleted from the system when a delete is invoked on them. They are marked for deletion and only when all the realized entities for that intent object gets deleted, the intent object is deleted. Objects that are marked for deletion are not returned in GET call. One can use the search API to get these objects. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
segment_security_profile_path (str or None) – The policy path of the asscociated Segment Security profile
spoofguard_profile_path (str or None) – The policy path of the asscociated SpoofGuard profile

class com.vmware.nsx_policy.model_client.PortSecurityProfileBindingMapListResult(links=None, schema=None, self_=None, cursor=None, result_count=None, sort_ascending=None, sort_by=None, results=None)¶

Bases: vmware.vapi.bindings.struct.VapiStruct

Paged collection of port security profile binding maps

Tip

The arguments are used to initialize data attributes with the same names.

Parameters

links (list of ResourceLink or None) – The server will populate this field when returing the resource. Ignored on PUT and POST. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
schema (str or None) – Schema for this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
self (SelfResourceLink or None) – Link to this resource
cursor (str or None) – Opaque cursor to be used for getting next page of records (supplied by current result page) This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
result_count (long or None) – Count of results found (across all pages), set only on first page format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
sort_ascending (bool or None) – If true, results are sorted in ascending order This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
sort_by (str or None) – Field by which records are sorted This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
results (list of PortSecurityProfileBindingMap) – Port security profile binding map list results

class com.vmware.nsx_policy.model_client.PrefixEntry(action=None, ge=None, le=None, network=None)¶

Bases: vmware.vapi.bindings.struct.VapiStruct

Network prefix entry

Tip

The arguments are used to initialize data attributes with the same names.

Parameters

action (str or None) –
Possible values are:
- PrefixEntry.ACTION_PERMIT
- PrefixEntry.ACTION_DENY
Action for the prefix list.
ge (long or None) – Prefix length greater than or equal to. format: int32
le (long or None) – Prefix length less than or equal to. format: int32
network (str) – Network prefix in CIDR format. “ANY” matches all networks.

ACTION_DENY = 'DENY'¶

ACTION_PERMIT = 'PERMIT'¶

class com.vmware.nsx_policy.model_client.PrefixList(links=None, schema=None, self_=None, revision=None, create_time=None, create_user=None, last_modified_time=None, last_modified_user=None, protection=None, system_owned=None, description=None, display_name=None, id=None, resource_type=None, tags=None, parent_path=None, path=None, relative_path=None, children=None, marked_for_delete=None, prefixes=None)¶

Bases: vmware.vapi.bindings.struct.VapiStruct

A named list of prefixes for routing purposes.

Tip

The arguments are used to initialize data attributes with the same names.

Parameters

links (list of ResourceLink or None) – The server will populate this field when returing the resource. Ignored on PUT and POST. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
schema (str or None) – Schema for this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
self (SelfResourceLink or None) – Link to this resource
revision (long or None) – The _revision property describes the current revision of the resource. To prevent clients from overwriting each other’s changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected. format: int32
create_time (long or None) – Timestamp of resource creation format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
create_user (str or None) – ID of the user who created this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
last_modified_time (long or None) – Timestamp of last modification format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
last_modified_user (str or None) – ID of the user who last modified this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
protection (str or None) – Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super user and can modify it, but only when providing the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this entity. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
system_owned (bool or None) – Indicates system owned resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
description (str or None) – Description of this resource
display_name (str or None) – Defaults to ID if not set
id (str or None) – Unique identifier of this resource
resource_type (str or None) – The type of this resource.
tags (list of Tag or None) – Opaque identifiers meaningful to the API user
parent_path (str or None) – Path of its parent This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
path (str or None) – Absolute path of this object This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
relative_path (str or None) – Path relative from its parent This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
children (list of vmware.vapi.struct.VapiStruct or None) – subtree for this type within policy tree containing nested elements. When clients pass a value of this class as a parameter, the attribute must contain all the attributes defined in ChildPolicyConfigResource. When methods return a value of this class as a return value, the attribute will contain all the attributes defined in ChildPolicyConfigResource.
marked_for_delete (bool or None) – Intent objects are not directly deleted from the system when a delete is invoked on them. They are marked for deletion and only when all the realized entities for that intent object gets deleted, the intent object is deleted. Objects that are marked for deletion are not returned in GET call. One can use the search API to get these objects. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
prefixes (list of PrefixEntry) – Specify ordered list of network prefixes.

class com.vmware.nsx_policy.model_client.ProfileBindingMap(links=None, schema=None, self_=None, revision=None, create_time=None, create_user=None, last_modified_time=None, last_modified_user=None, protection=None, system_owned=None, description=None, display_name=None, id=None, resource_type=None, tags=None, parent_path=None, path=None, relative_path=None, children=None, marked_for_delete=None, profile_path=None)¶

Bases: vmware.vapi.bindings.struct.VapiStruct

This entity will be used to establish association between profile and policy entities.

Tip

The arguments are used to initialize data attributes with the same names.

Parameters

links (list of ResourceLink or None) – The server will populate this field when returing the resource. Ignored on PUT and POST. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
schema (str or None) – Schema for this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
self (SelfResourceLink or None) – Link to this resource
revision (long or None) – The _revision property describes the current revision of the resource. To prevent clients from overwriting each other’s changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected. format: int32
create_time (long or None) – Timestamp of resource creation format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
create_user (str or None) – ID of the user who created this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
last_modified_time (long or None) – Timestamp of last modification format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
last_modified_user (str or None) – ID of the user who last modified this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
protection (str or None) – Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super user and can modify it, but only when providing the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this entity. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
system_owned (bool or None) – Indicates system owned resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
description (str or None) – Description of this resource
display_name (str or None) – Defaults to ID if not set
id (str or None) – Unique identifier of this resource
resource_type (str or None) – The type of this resource.
tags (list of Tag or None) – Opaque identifiers meaningful to the API user
parent_path (str or None) – Path of its parent This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
path (str or None) – Absolute path of this object This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
relative_path (str or None) – Path relative from its parent This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
children (list of vmware.vapi.struct.VapiStruct or None) – subtree for this type within policy tree containing nested elements. When clients pass a value of this class as a parameter, the attribute must contain all the attributes defined in ChildPolicyConfigResource. When methods return a value of this class as a return value, the attribute will contain all the attributes defined in ChildPolicyConfigResource.
marked_for_delete (bool or None) – Intent objects are not directly deleted from the system when a delete is invoked on them. They are marked for deletion and only when all the realized entities for that intent object gets deleted, the intent object is deleted. Objects that are marked for deletion are not returned in GET call. One can use the search API to get these objects. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
profile_path (str) – PolicyPath of associated Profile

class com.vmware.nsx_policy.model_client.PropertyItem(condition=None, field=None, heading=None, label=None, render_configuration=None, separator=None, type=None)¶

Bases: vmware.vapi.bindings.struct.VapiStruct

Represents a label-value pair.

Tip

The arguments are used to initialize data attributes with the same names.

Parameters

condition (str or None) – If the condition is met then the property will be displayed. Examples of expression syntax are provided under ‘example_request’ section of ‘CreateWidgetConfiguration’ API.
field (str) – Represents field value of the property.
heading (bool or None) – Set to true if the field is a heading. Default is false.
label (Label or None) – If a field represents a heading, then label is not needed
render_configuration (list of RenderConfiguration or None) – Render configuration to be applied, if any.
separator (bool or None) – If true, separates this property in a widget.
type (str) –
Possible values are:
Data type of the field.

TYPE_DATE = 'Date'¶

TYPE_NUMBER = 'Number'¶

TYPE_STRING = 'String'¶

TYPE_URL = 'Url'¶

class com.vmware.nsx_policy.model_client.QosBaseRateLimiter(enabled=None, resource_type='QoSBaseRateLimiter')¶

Bases: vmware.vapi.bindings.struct.VapiStruct

A Limiter configuration entry that specifies type and metrics

Tip

The arguments are used to initialize data attributes with the same names.

Parameters

enabled (bool) –
resource_type (str) –
Possible values are:
Type rate limiter

RESOURCE_TYPE_EGRESSRATELIMITER = 'EgressRateLimiter'¶

RESOURCE_TYPE_INGRESSBROADCASTRATELIMITER = 'IngressBroadcastRateLimiter'¶

RESOURCE_TYPE_INGRESSRATELIMITER = 'IngressRateLimiter'¶

property resource_type¶: Return the discriminator value

class com.vmware.nsx_policy.model_client.QosDscp(mode=None, priority=None)¶

Bases: vmware.vapi.bindings.struct.VapiStruct

Dscp value is ignored in case of ‘TRUSTED’ DscpTrustMode.

Tip

The arguments are used to initialize data attributes with the same names.

Parameters

mode (str or None) –
Possible values are:
- QosDscp.MODE_TRUSTED
- QosDscp.MODE_UNTRUSTED
When you select the Trusted mode the inner header DSCP value is applied to the outer IP header for IP/IPv6 traffic. For non IP/IPv6 traffic, the outer IP header takes the default value.Untrusted mode is supported on overlay-based and VLAN-based logical port.
priority (long or None) – Internal Forwarding Priority format: int32

MODE_TRUSTED = 'TRUSTED'¶

MODE_UNTRUSTED = 'UNTRUSTED'¶

class com.vmware.nsx_policy.model_client.QosProfile(links=None, schema=None, self_=None, revision=None, create_time=None, create_user=None, last_modified_time=None, last_modified_user=None, protection=None, system_owned=None, description=None, display_name=None, id=None, resource_type=None, tags=None, parent_path=None, path=None, relative_path=None, children=None, marked_for_delete=None, class_of_service=None, dscp=None, shaper_configurations=None)¶

Bases: vmware.vapi.bindings.struct.VapiStruct

Tip

The arguments are used to initialize data attributes with the same names.

Parameters

links (list of ResourceLink or None) – The server will populate this field when returing the resource. Ignored on PUT and POST. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
schema (str or None) – Schema for this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
self (SelfResourceLink or None) – Link to this resource
revision (long or None) – The _revision property describes the current revision of the resource. To prevent clients from overwriting each other’s changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected. format: int32
create_time (long or None) – Timestamp of resource creation format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
create_user (str or None) – ID of the user who created this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
last_modified_time (long or None) – Timestamp of last modification format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
last_modified_user (str or None) – ID of the user who last modified this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
protection (str or None) – Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super user and can modify it, but only when providing the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this entity. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
system_owned (bool or None) – Indicates system owned resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
description (str or None) – Description of this resource
display_name (str or None) – Defaults to ID if not set
id (str or None) – Unique identifier of this resource
resource_type (str or None) – The type of this resource.
tags (list of Tag or None) – Opaque identifiers meaningful to the API user
parent_path (str or None) – Path of its parent This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
path (str or None) – Absolute path of this object This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
relative_path (str or None) – Path relative from its parent This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
children (list of vmware.vapi.struct.VapiStruct or None) – subtree for this type within policy tree containing nested elements. When clients pass a value of this class as a parameter, the attribute must contain all the attributes defined in ChildPolicyConfigResource. When methods return a value of this class as a return value, the attribute will contain all the attributes defined in ChildPolicyConfigResource.
marked_for_delete (bool or None) – Intent objects are not directly deleted from the system when a delete is invoked on them. They are marked for deletion and only when all the realized entities for that intent object gets deleted, the intent object is deleted. Objects that are marked for deletion are not returned in GET call. One can use the search API to get these objects. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
class_of_service (long or None) – Class of service groups similar types of traffic in the network and each type of traffic is treated as a class with its own level of service priority. The lower priority traffic is slowed down or in some cases dropped to provide better throughput for higher priority traffic. format: int32
dscp (QosDscp or None) –
shaper_configurations (list of vmware.vapi.struct.VapiStruct or None) – Array of Rate limiter configurations to applied on Segment or Port. When clients pass a value of this class as a parameter, the attribute must contain all the attributes defined in QosBaseRateLimiter. When methods return a value of this class as a return value, the attribute will contain all the attributes defined in QosBaseRateLimiter.

class com.vmware.nsx_policy.model_client.QosProfileBindingMap(links=None, schema=None, self_=None, revision=None, create_time=None, create_user=None, last_modified_time=None, last_modified_user=None, protection=None, system_owned=None, description=None, display_name=None, id=None, resource_type=None, tags=None, parent_path=None, path=None, relative_path=None, children=None, marked_for_delete=None)¶

Bases: vmware.vapi.bindings.struct.VapiStruct

Base QoS Profile Binding Map

Tip

The arguments are used to initialize data attributes with the same names.

Parameters

links (list of ResourceLink or None) – The server will populate this field when returing the resource. Ignored on PUT and POST. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
schema (str or None) – Schema for this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
self (SelfResourceLink or None) – Link to this resource
revision (long or None) – The _revision property describes the current revision of the resource. To prevent clients from overwriting each other’s changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected. format: int32
create_time (long or None) – Timestamp of resource creation format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
create_user (str or None) – ID of the user who created this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
last_modified_time (long or None) – Timestamp of last modification format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
last_modified_user (str or None) – ID of the user who last modified this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
protection (str or None) – Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super user and can modify it, but only when providing the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this entity. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
system_owned (bool or None) – Indicates system owned resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
description (str or None) – Description of this resource
display_name (str or None) – Defaults to ID if not set
id (str or None) – Unique identifier of this resource
resource_type (str or None) – The type of this resource.
tags (list of Tag or None) – Opaque identifiers meaningful to the API user
parent_path (str or None) – Path of its parent This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
path (str or None) – Absolute path of this object This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
relative_path (str or None) – Path relative from its parent This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
children (list of vmware.vapi.struct.VapiStruct or None) – subtree for this type within policy tree containing nested elements. When clients pass a value of this class as a parameter, the attribute must contain all the attributes defined in ChildPolicyConfigResource. When methods return a value of this class as a return value, the attribute will contain all the attributes defined in ChildPolicyConfigResource.
marked_for_delete (bool or None) – Intent objects are not directly deleted from the system when a delete is invoked on them. They are marked for deletion and only when all the realized entities for that intent object gets deleted, the intent object is deleted. Objects that are marked for deletion are not returned in GET call. One can use the search API to get these objects. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.

class com.vmware.nsx_policy.model_client.QosProfileListResult(links=None, schema=None, self_=None, cursor=None, result_count=None, sort_ascending=None, sort_by=None, results=None)¶

Bases: vmware.vapi.bindings.struct.VapiStruct

Paged collection of QoS profiles

Tip

The arguments are used to initialize data attributes with the same names.

Parameters

links (list of ResourceLink or None) – The server will populate this field when returing the resource. Ignored on PUT and POST. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
schema (str or None) – Schema for this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
self (SelfResourceLink or None) – Link to this resource
cursor (str or None) – Opaque cursor to be used for getting next page of records (supplied by current result page) This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
result_count (long or None) – Count of results found (across all pages), set only on first page format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
sort_ascending (bool or None) – If true, results are sorted in ascending order This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
sort_by (str or None) – Field by which records are sorted This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
results (list of QosProfile) – QoS profiles list results

class com.vmware.nsx_policy.model_client.RAConfig(hop_limit=None, prefix_lifetime=None, prefix_preferred_time=None, ra_interval=None, router_lifetime=None)¶

Bases: vmware.vapi.bindings.struct.VapiStruct

Tip

The arguments are used to initialize data attributes with the same names.

Parameters

hop_limit (long or None) – The maximum number of hops through which packets can pass before being discarded. format: int64
prefix_lifetime (long or None) – The time interval in seconds, in which the prefix is advertised as valid. format: int64
prefix_preferred_time (long or None) – The time interval in seconds, in which the prefix is advertised as preferred. format: int64
ra_interval (long or None) – Interval between 2 Router advertisement in seconds. format: int64
router_lifetime (long or None) – Router lifetime value in seconds. A value of 0 indicates the router is not a default router for the receiving end. Any other value in this field specifies the lifetime, in seconds, associated with this router as a default router. format: int64

class com.vmware.nsx_policy.model_client.RaDNSConfig(dns_server=None, dns_server_lifetime=None, domain_name=None, domain_name_lifetime=None)¶

Bases: vmware.vapi.bindings.struct.VapiStruct

Tip

The arguments are used to initialize data attributes with the same names.

Parameters

dns_server (list of str or None) – DNS server. format: ipv6
dns_server_lifetime (long or None) – Lifetime of DNS server in milliseconds format: int64
domain_name (list of str or None) – Domain name in RA message.
domain_name_lifetime (long or None) – Lifetime of Domain names in milliseconds format: int64

class com.vmware.nsx_policy.model_client.Reaction(links=None, schema=None, self_=None, revision=None, create_time=None, create_user=None, last_modified_time=None, last_modified_user=None, protection=None, system_owned=None, description=None, display_name=None, id=None, resource_type=None, tags=None, parent_path=None, path=None, relative_path=None, children=None, marked_for_delete=None, actions=None, events=None)¶

Bases: vmware.vapi.bindings.struct.VapiStruct

Reaction represents a programmable entity which encapsulates the events and the actions in response to the events, or simply “If This Then That”.

Tip

The arguments are used to initialize data attributes with the same names.

Parameters

links (list of ResourceLink or None) – The server will populate this field when returing the resource. Ignored on PUT and POST. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
schema (str or None) – Schema for this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
self (SelfResourceLink or None) – Link to this resource
revision (long or None) – The _revision property describes the current revision of the resource. To prevent clients from overwriting each other’s changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected. format: int32
create_time (long or None) – Timestamp of resource creation format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
create_user (str or None) – ID of the user who created this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
last_modified_time (long or None) – Timestamp of last modification format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
last_modified_user (str or None) – ID of the user who last modified this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
protection (str or None) – Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super user and can modify it, but only when providing the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this entity. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
system_owned (bool or None) – Indicates system owned resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
description (str or None) – Description of this resource
display_name (str or None) – Defaults to ID if not set
id (str or None) – Unique identifier of this resource
resource_type (str or None) – The type of this resource.
tags (list of Tag or None) – Opaque identifiers meaningful to the API user
parent_path (str or None) – Path of its parent This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
path (str or None) – Absolute path of this object This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
relative_path (str or None) – Path relative from its parent This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
children (list of vmware.vapi.struct.VapiStruct or None) – subtree for this type within policy tree containing nested elements. When clients pass a value of this class as a parameter, the attribute must contain all the attributes defined in ChildPolicyConfigResource. When methods return a value of this class as a return value, the attribute will contain all the attributes defined in ChildPolicyConfigResource.
marked_for_delete (bool or None) – Intent objects are not directly deleted from the system when a delete is invoked on them. They are marked for deletion and only when all the realized entities for that intent object gets deleted, the intent object is deleted. Objects that are marked for deletion are not returned in GET call. One can use the search API to get these objects. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
actions (list of vmware.vapi.struct.VapiStruct) – Actions that need to be taken when the events occur. These actions must appear in the order that they need to be taken in. This field can be interpreted as the HOW of the Reaction, or simply as “Then That”. When clients pass a value of this class as a parameter, the attribute must contain all the attributes defined in Action. When methods return a value of this class as a return value, the attribute will contain all the attributes defined in Action.
events (list of Event) – Events that provide contextual variables about what the reaction should react to. This field can be interpreted as the WHAT of the Reaction, or simply as “If This” Clause.

class com.vmware.nsx_policy.model_client.RealizedVirtualMachine(links=None, schema=None, self_=None, revision=None, create_time=None, create_user=None, last_modified_time=None, last_modified_user=None, protection=None, system_owned=None, description=None, display_name=None, id=None, resource_type=None, tags=None, parent_path=None, path=None, relative_path=None, alarms=None, intent_reference=None, realization_api=None, realization_specific_identifier=None, runtime_error=None, runtime_status=None, state=None, compute_ids=None, host_id=None, local_id_on_host=None, power_state=None)¶

Bases: vmware.vapi.bindings.struct.VapiStruct

Realized Virtual Machine

Tip

The arguments are used to initialize data attributes with the same names.

Parameters

links (list of ResourceLink or None) – The server will populate this field when returing the resource. Ignored on PUT and POST. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
schema (str or None) – Schema for this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
self (SelfResourceLink or None) – Link to this resource
revision (long or None) – The _revision property describes the current revision of the resource. To prevent clients from overwriting each other’s changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected. format: int32
create_time (long or None) – Timestamp of resource creation format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
create_user (str or None) – ID of the user who created this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
last_modified_time (long or None) – Timestamp of last modification format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
last_modified_user (str or None) – ID of the user who last modified this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
protection (str or None) – Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super user and can modify it, but only when providing the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this entity. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
system_owned (bool or None) – Indicates system owned resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
description (str or None) – Description of this resource
display_name (str or None) – Defaults to ID if not set
id (str or None) – Unique identifier of this resource
resource_type (str or None) – The type of this resource.
tags (list of Tag or None) – Opaque identifiers meaningful to the API user
parent_path (str or None) – Path of its parent This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
path (str or None) – Absolute path of this object This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
relative_path (str or None) – Path relative from its parent This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
alarms (list of PolicyAlarmResource or None) – Alarm info detail
intent_reference (list of str or None) – Desire state paths of this object
realization_api (str or None) – Realization API of this object on enforcement point
realization_specific_identifier (str or None) – Realization id of this object
runtime_error (str or None) – It define the root cause for runtime error.
runtime_status (str or None) – Possible values could be UP, DOWN, UNKNOWN, DEGRADED This list is not exhaustive.
state (str) –
Possible values are:
- RealizedVirtualMachine.STATE_UNAVAILABLE
- RealizedVirtualMachine.STATE_UNREALIZED
- RealizedVirtualMachine.STATE_REALIZED
- RealizedVirtualMachine.STATE_ERROR
Realization state of this object
compute_ids (list of str or None) – List of external compute ids of the virtual machine in the format ‘id-type-key:value’ , list of external compute ids [‘uuid:xxxx-xxxx-xxxx-xxxx’, ‘moIdOnHost:moref-11’, ‘instanceUuid:xxxx-xxxx-xxxx-xxxx’] This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
host_id (str or None) – Id of the host on which the vm exists. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
local_id_on_host (str or None) – Id of the vm unique within the host. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
power_state (str or None) –
Possible values are:
- RealizedVirtualMachine.POWER_STATE_VM_RUNNING
- RealizedVirtualMachine.POWER_STATE_VM_STOPPED
- RealizedVirtualMachine.POWER_STATE_VM_SUSPENDED
- RealizedVirtualMachine.POWER_STATE_UNKNOWN
Current power state of this virtual machine in the system.

This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.

POWER_STATE_UNKNOWN = 'UNKNOWN'¶

POWER_STATE_VM_RUNNING = 'VM_RUNNING'¶

POWER_STATE_VM_STOPPED = 'VM_STOPPED'¶

POWER_STATE_VM_SUSPENDED = 'VM_SUSPENDED'¶

STATE_ERROR = 'ERROR'¶

STATE_REALIZED = 'REALIZED'¶

STATE_UNAVAILABLE = 'UNAVAILABLE'¶

STATE_UNREALIZED = 'UNREALIZED'¶

class com.vmware.nsx_policy.model_client.RealizedVirtualMachineListResult(links=None, schema=None, self_=None, cursor=None, result_count=None, sort_ascending=None, sort_by=None, results=None)¶

Bases: vmware.vapi.bindings.struct.VapiStruct

Tip

The arguments are used to initialize data attributes with the same names.

Parameters

links (list of ResourceLink or None) – The server will populate this field when returing the resource. Ignored on PUT and POST. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
schema (str or None) – Schema for this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
self (SelfResourceLink or None) – Link to this resource
cursor (str or None) – Opaque cursor to be used for getting next page of records (supplied by current result page) This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
result_count (long or None) – Count of results found (across all pages), set only on first page format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
sort_ascending (bool or None) – If true, results are sorted in ascending order This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
sort_by (str or None) – Field by which records are sorted This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
results (list of RealizedVirtualMachine or None) – Paged Collection of VMs

class com.vmware.nsx_policy.model_client.RedirectionPolicy(links=None, schema=None, self_=None, revision=None, create_time=None, create_user=None, last_modified_time=None, last_modified_user=None, protection=None, system_owned=None, description=None, display_name=None, id=None, resource_type=None, tags=None, parent_path=None, path=None, relative_path=None, children=None, marked_for_delete=None, category=None, comments=None, lock_modified_by=None, lock_modified_time=None, locked=None, scope=None, sequence_number=None, stateful=None, tcp_strict=None, redirect_to=None, rules=None)¶

Bases: vmware.vapi.bindings.struct.VapiStruct

Ordered list of rules long with the path of PolicyServiceInstance to which the traffic needs to be redirected.

Tip

The arguments are used to initialize data attributes with the same names.

Parameters

links (list of ResourceLink or None) – The server will populate this field when returing the resource. Ignored on PUT and POST. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
schema (str or None) – Schema for this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
self (SelfResourceLink or None) – Link to this resource
revision (long or None) – The _revision property describes the current revision of the resource. To prevent clients from overwriting each other’s changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected. format: int32
create_time (long or None) – Timestamp of resource creation format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
create_user (str or None) – ID of the user who created this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
last_modified_time (long or None) – Timestamp of last modification format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
last_modified_user (str or None) – ID of the user who last modified this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
protection (str or None) – Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super user and can modify it, but only when providing the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this entity. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
system_owned (bool or None) – Indicates system owned resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
description (str or None) – Description of this resource
display_name (str or None) – Defaults to ID if not set
id (str or None) – Unique identifier of this resource
resource_type (str or None) – The type of this resource.
tags (list of Tag or None) – Opaque identifiers meaningful to the API user
parent_path (str or None) – Path of its parent This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
path (str or None) – Absolute path of this object This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
relative_path (str or None) – Path relative from its parent This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
children (list of vmware.vapi.struct.VapiStruct or None) – subtree for this type within policy tree containing nested elements. When clients pass a value of this class as a parameter, the attribute must contain all the attributes defined in ChildPolicyConfigResource. When methods return a value of this class as a return value, the attribute will contain all the attributes defined in ChildPolicyConfigResource.
marked_for_delete (bool or None) – Intent objects are not directly deleted from the system when a delete is invoked on them. They are marked for deletion and only when all the realized entities for that intent object gets deleted, the intent object is deleted. Objects that are marked for deletion are not returned in GET call. One can use the search API to get these objects. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
category (str or None) –
- Distributed Firewall - Policy framework provides five pre-defined
categories for classifying a security policy. They are “Ethernet”,”Emergency”, “Infrastructure” “Environment” and “Application”. There is a pre-determined order in which the policy framework manages the priority of these security policies. Ethernet category is for supporting layer 2 firewall rules. The other four categories are applicable for layer 3 rules. Amongst them, the Emergency category has the highest priority followed by Infrastructure, Environment and then Application rules. Administrator can choose to categorize a security policy into the above categories or can choose to leave it empty. If empty it will have the least precedence w.r.t the above four categories. - Edge Firewall - Policy Framework for Edge Firewall provides six pre-defined categories “Emergency”, “SystemRules”, “SharedPreRules”, “LocalGatewayRules”, “AutoServiceRules” and “Default”, in order of priority of rules. All categories are allowed for Gatetway Policies that belong to ‘default’ Domain. However, for user created domains, category is restricted to “SharedPreRules” or “LocalGatewayRules” only. Also, the users can add/modify/delete rules from only the “SharedPreRules” and “LocalGatewayRules” categories. If user doesn’t specify the category then defaulted to “Rules”. System generated category is used by NSX created rules, for example BFD rules. Autoplumbed category used by NSX verticals to autoplumb data path rules. Finally, “Default” category is the placeholder default rules with lowest in the order of priority.
comments (str or None) – Comments for security policy lock/unlock.
lock_modified_by (str or None) – ID of the user who last modified the lock for the secruity policy. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
lock_modified_time (long or None) – SecurityPolicy locked/unlocked time in epoch milliseconds. format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
locked (bool or None) – Indicates whether a security policy should be locked. If the security policy is locked by a user, then no other user would be able to modify this security policy. Once the user releases the lock, other users can update this security policy.
scope (list of str or None) – The list of group paths where the rules in this policy will get applied. This scope will take precedence over rule level scope. Supported only for security policies.
sequence_number (long or None) – This field is used to resolve conflicts between security policies across domains. In order to change the sequence number of a policy one can fire a POST request on the policy entity with a query parameter action=revise The sequence number field will reflect the value of the computed sequence number upon execution of the above mentioned POST request. For scenarios where the administrator is using a template to update several security policies, the only way to set the sequence number is to explicitly specify the sequence number for each security policy. If no sequence number is specified in the payload, a value of 0 is assigned by default. If there are multiple policies with the same sequence number then their order is not deterministic. If a specific order of policies is desired, then one has to specify unique sequence numbers or use the POST request on the policy entity with a query parameter action=revise to let the framework assign a sequence number format: int32
stateful (bool or None) – Stateful or Stateless nature of security policy is enforced on all rules in this security policy. When it is stateful, the state of the network connects are tracked and a stateful packet inspection is performed. Layer3 security policies can be stateful or stateless. By default, they are stateful. Layer2 security policies can only be stateless.
tcp_strict (bool or None) – Ensures that a 3 way TCP handshake is done before the data packets are sent. tcp_strict=true is supported only for stateful security policies.
redirect_to (list of str) – List of path Service Instance/service Instance endpoint
rules (list of RedirectionRule or None) – Redirection rules that are a part of this RedirectionPolicy. At max, there can be 1000 rules in a given RedirectPolicy.

class com.vmware.nsx_policy.model_client.RedirectionPolicyListResult(links=None, schema=None, self_=None, cursor=None, result_count=None, sort_ascending=None, sort_by=None, results=None)¶

Bases: vmware.vapi.bindings.struct.VapiStruct

Paged Collection of Redirection Policies

Tip

The arguments are used to initialize data attributes with the same names.

Parameters

links (list of ResourceLink or None) – The server will populate this field when returing the resource. Ignored on PUT and POST. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
schema (str or None) – Schema for this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
self (SelfResourceLink or None) – Link to this resource
cursor (str or None) – Opaque cursor to be used for getting next page of records (supplied by current result page) This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
result_count (long or None) – Count of results found (across all pages), set only on first page format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
sort_ascending (bool or None) – If true, results are sorted in ascending order This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
sort_by (str or None) – Field by which records are sorted This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
results (list of RedirectionPolicy) – Redirection policy list results

class com.vmware.nsx_policy.model_client.RedirectionRule(links=None, schema=None, self_=None, revision=None, create_time=None, create_user=None, last_modified_time=None, last_modified_user=None, protection=None, system_owned=None, description=None, display_name=None, id=None, resource_type=None, tags=None, parent_path=None, path=None, relative_path=None, children=None, marked_for_delete=None, destination_groups=None, destinations_excluded=None, direction=None, disabled=None, ip_protocol=None, logged=None, notes=None, profiles=None, scope=None, sequence_number=None, services=None, source_groups=None, sources_excluded=None, tag=None, action=None)¶

Bases: vmware.vapi.bindings.struct.VapiStruct

It define redirection rule for service insertion

Tip

The arguments are used to initialize data attributes with the same names.

Parameters

links (list of ResourceLink or None) – The server will populate this field when returing the resource. Ignored on PUT and POST. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
schema (str or None) – Schema for this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
self (SelfResourceLink or None) – Link to this resource
revision (long or None) – The _revision property describes the current revision of the resource. To prevent clients from overwriting each other’s changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected. format: int32
create_time (long or None) – Timestamp of resource creation format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
create_user (str or None) – ID of the user who created this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
last_modified_time (long or None) – Timestamp of last modification format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
last_modified_user (str or None) – ID of the user who last modified this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
protection (str or None) – Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super user and can modify it, but only when providing the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this entity. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
system_owned (bool or None) – Indicates system owned resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
description (str or None) – Description of this resource
display_name (str or None) – Defaults to ID if not set
id (str or None) – Unique identifier of this resource
resource_type (str or None) – The type of this resource.
tags (list of Tag or None) – Opaque identifiers meaningful to the API user
parent_path (str or None) – Path of its parent This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
path (str or None) – Absolute path of this object This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
relative_path (str or None) – Path relative from its parent This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
children (list of vmware.vapi.struct.VapiStruct or None) – subtree for this type within policy tree containing nested elements. When clients pass a value of this class as a parameter, the attribute must contain all the attributes defined in ChildPolicyConfigResource. When methods return a value of this class as a return value, the attribute will contain all the attributes defined in ChildPolicyConfigResource.
marked_for_delete (bool or None) – Intent objects are not directly deleted from the system when a delete is invoked on them. They are marked for deletion and only when all the realized entities for that intent object gets deleted, the intent object is deleted. Objects that are marked for deletion are not returned in GET call. One can use the search API to get these objects. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
destination_groups (list of str or None) – We need paths as duplicate names may exist for groups under different domains.In order to specify all groups, use the constant “ANY”. This is case insensitive. If “ANY” is used, it should be the ONLY element in the group array. Error will be thrown if ANY is used in conjunction with other values.
destinations_excluded (bool or None) – If set to true, the rule gets applied on all the groups that are NOT part of the destination groups. If false, the rule applies to the destination groups
direction (str or None) –
Possible values are:
- RedirectionRule.DIRECTION_IN
- RedirectionRule.DIRECTION_OUT
- RedirectionRule.DIRECTION_IN_OUT
Define direction of traffic.
disabled (bool or None) – Flag to disable the rule. Default is enabled.
ip_protocol (str or None) –
Possible values are:
- RedirectionRule.IP_PROTOCOL_IPV4
- RedirectionRule.IP_PROTOCOL_IPV6
- RedirectionRule.IP_PROTOCOL_IPV4_IPV6
Type of IP packet that should be matched while enforcing the rule. The value is set to IPV4_IPV6 for Layer3 rule if not specified. For Layer2/Ether rule the value must be null.
logged (bool or None) – Flag to enable packet logging. Default is disabled.
notes (str or None) – Text for additional notes on changes.
profiles (list of str or None) – Holds the list of layer 7 service profile paths. These profiles accept attributes and sub-attributes of various network services (e.g. L4 AppId, encryption algorithm, domain name, etc) as key value pairs.
scope (list of str or None) – The list of policy paths where the rule is applied LR/Edge/T0/T1/LRP etc. Note that a given rule can be applied on multiple LRs/LRPs.
sequence_number (long or None) – This field is used to resolve conflicts between multiple Rules under Security or Gateway Policy for a Domain If no sequence number is specified in the payload, a value of 0 is assigned by default. If there are multiple rules with the same sequence number then their order is not deterministic. If a specific order of rules is desired, then one has to specify unique sequence numbers or use the POST request on the rule entity with a query parameter action=revise to let the framework assign a sequence number format: int32
services (list of str or None) – In order to specify all services, use the constant “ANY”. This is case insensitive. If “ANY” is used, it should be the ONLY element in the services array. Error will be thrown if ANY is used in conjunction with other values.
source_groups (list of str or None) – We need paths as duplicate names may exist for groups under different domains. In order to specify all groups, use the constant “ANY”. This is case insensitive. If “ANY” is used, it should be the ONLY element in the group array. Error will be thrown if ANY is used in conjunction with other values.
sources_excluded (bool or None) – If set to true, the rule gets applied on all the groups that are NOT part of the source groups. If false, the rule applies to the source groups
tag (str or None) – User level field which will be printed in CLI and packet logs.
action (str or None) –
Possible values are:
- RedirectionRule.ACTION_REDIRECT
- RedirectionRule.ACTION_DO_NOT_REDIRECT
The action to be applied to all the services

ACTION_DO_NOT_REDIRECT = 'DO_NOT_REDIRECT'¶

ACTION_REDIRECT = 'REDIRECT'¶

DIRECTION_IN = 'IN'¶

DIRECTION_IN_OUT = 'IN_OUT'¶

DIRECTION_OUT = 'OUT'¶

IP_PROTOCOL_IPV4 = 'IPV4'¶

IP_PROTOCOL_IPV4_IPV6 = 'IPV4_IPV6'¶

IP_PROTOCOL_IPV6 = 'IPV6'¶

class com.vmware.nsx_policy.model_client.RedirectionRuleListResult(links=None, schema=None, self_=None, cursor=None, result_count=None, sort_ascending=None, sort_by=None, results=None)¶

Bases: vmware.vapi.bindings.struct.VapiStruct

Paged Collection of RedirectionRules

Tip

The arguments are used to initialize data attributes with the same names.

Parameters

links (list of ResourceLink or None) – The server will populate this field when returing the resource. Ignored on PUT and POST. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
schema (str or None) – Schema for this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
self (SelfResourceLink or None) – Link to this resource
cursor (str or None) – Opaque cursor to be used for getting next page of records (supplied by current result page) This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
result_count (long or None) – Count of results found (across all pages), set only on first page format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
sort_ascending (bool or None) – If true, results are sorted in ascending order This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
sort_by (str or None) – Field by which records are sorted This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
results (list of RedirectionRule) – RedirectionRule list results

class com.vmware.nsx_policy.model_client.RelatedApiError(details=None, error_code=None, error_data=None, error_message=None, module_name=None)¶

Bases: vmware.vapi.bindings.struct.VapiStruct

Detailed information about a related API error

Tip

The arguments are used to initialize data attributes with the same names.

Parameters

details (str or None) – Further details about the error
error_code (long or None) – A numeric error code format: int64
error_data (vmware.vapi.struct.VapiStruct or None) – Additional data about the error
error_message (str or None) – A description of the error
module_name (str or None) – The module name where the error occurred

class com.vmware.nsx_policy.model_client.RelatedAttribute(attribute=None)¶

Bases: vmware.vapi.bindings.struct.VapiStruct

Related attribute on the target resource for conditional constraints based on related attribute value. Example - destinationGroups/service/action is related attribute of sourceGroups in communcation entry.

Tip

The arguments are used to initialize data attributes with the same names.

Parameters: attribute (str) – Related attribute name on the target entity.

class com.vmware.nsx_policy.model_client.RelatedAttributeConditionalExpression(condition=None, related_attribute=None, links=None, schema=None, self_=None, revision=None, create_time=None, create_user=None, last_modified_time=None, last_modified_user=None, protection=None, system_owned=None, description=None, display_name=None, id=None, resource_type='RelatedAttributeConditionalExpression', tags=None)¶

Bases: vmware.vapi.bindings.struct.VapiStruct

Represents the leaf level type expression to express constraint as value of realted attribute to the target. Example - Constraint traget attribute ‘X’ (example in Constraint), if destinationGroups contains ‘vCeneter’ then allow only values “HTTPS”, “HTTP” for attribute X. { “target”:{ “target_resource_type”:”CommunicationEntry”, “attribute”:”services”, “path_prefix”: “/infra/domains/{{DOMAIN}}/edge-communication-maps/default/communication-entries/” }, “constraint_expression”: { “resource_type”: “RelatedAttributeConditionalExpression”, “related_attribute”:{ “attribute”:”destinationGroups” }, “condition” : { “operator”:”INCLUDES”, “rhs_value”: [“/infra/domains/mgw/groups/VCENTER”], “value_constraint”: { “resource_type”: “ValueConstraintExpression”, “operator”:”INCLUDES”, “values”:[“/infra/services/HTTP”, “/infra/services/HTTPS”] } } } }

Tip

The arguments are used to initialize data attributes with the same names.

Parameters

condition (ConditionalValueConstraintExpression) – Conditional value expression for target based on realted attribute value.
related_attribute (RelatedAttribute) – Related attribute.
links (list of ResourceLink or None) – The server will populate this field when returing the resource. Ignored on PUT and POST. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
schema (str or None) – Schema for this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
self (SelfResourceLink or None) – Link to this resource
revision (long or None) – The _revision property describes the current revision of the resource. To prevent clients from overwriting each other’s changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected. format: int32
create_time (long or None) – Timestamp of resource creation format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
create_user (str or None) – ID of the user who created this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
last_modified_time (long or None) – Timestamp of last modification format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
last_modified_user (str or None) – ID of the user who last modified this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
protection (str or None) – Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super user and can modify it, but only when providing the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this entity. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
system_owned (bool or None) – Indicates system owned resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
description (str or None) – Description of this resource
display_name (str or None) – Defaults to ID if not set
id (str or None) – Unique identifier of this resource
resource_type (str) –
Possible values are:
tags (list of Tag or None) – Opaque identifiers meaningful to the API user

property resource_type¶: Return the discriminator value

class com.vmware.nsx_policy.model_client.RenderConfiguration(color=None, condition=None, display_value=None, icons=None, tooltip=None)¶

Bases: vmware.vapi.bindings.struct.VapiStruct

Render configuration to be applied to the widget.

Tip

The arguments are used to initialize data attributes with the same names.

Parameters

color (str or None) –
Possible values are:
The color to use when rendering an entity. For example, set color as ‘RED’ to render a portion of donut in red.
condition (str or None) – If the condition is met then the rendering specified for the condition will be applied. Examples of expression syntax are provided under ‘example_request’ section of ‘CreateWidgetConfiguration’ API.
display_value (str or None) – If specified, overrides the field value. This can be used to display a meaningful value in situations where field value is not available or not configured.
icons (list of Icon or None) – Icons to be applied at dashboard for widgets and UI elements.
tooltip (list of Tooltip or None) – Multi-line text to be shown on tooltip while hovering over the UI element if the condition is met.

COLOR_BLUE = 'BLUE'¶

COLOR_DARK_GREY = 'DARK_GREY'¶

COLOR_DARK_RED = 'DARK_RED'¶

COLOR_GREEN = 'GREEN'¶

COLOR_GREY = 'GREY'¶

COLOR_LIGHT_GREY = 'LIGHT_GREY'¶

COLOR_RED = 'RED'¶

COLOR_SKY_BLUE = 'SKY_BLUE'¶

COLOR_YELLOW = 'YELLOW'¶

class com.vmware.nsx_policy.model_client.Resource(links=None, schema=None, self_=None)¶

Bases: vmware.vapi.bindings.struct.VapiStruct

Base class for resources

Tip

The arguments are used to initialize data attributes with the same names.

Parameters

links (list of ResourceLink or None) – The server will populate this field when returing the resource. Ignored on PUT and POST. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
schema (str or None) – Schema for this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
self (SelfResourceLink or None) – Link to this resource

class com.vmware.nsx_policy.model_client.ResourceFieldPointer(field_pointer=None, path=None)¶

Bases: vmware.vapi.bindings.struct.VapiStruct

Resource Field Pointer representing the exact value within a policy object.

Tip

The arguments are used to initialize data attributes with the same names.

Parameters

field_pointer (str) – Field Pointer referencing the exact field within the policy object.
path (str or None) – Policy Path referencing a policy object. If not supplied, the field pointer will be applied to the event source.

class com.vmware.nsx_policy.model_client.ResourceInfoListResult(links=None, schema=None, self_=None, cursor=None, result_count=None, sort_ascending=None, sort_by=None, results=None)¶

Bases: vmware.vapi.bindings.struct.VapiStruct

Collection of resource info objects

Tip

The arguments are used to initialize data attributes with the same names.

Parameters

links (list of ResourceLink or None) – The server will populate this field when returing the resource. Ignored on PUT and POST. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
schema (str or None) – Schema for this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
self (SelfResourceLink or None) – Link to this resource
cursor (str or None) – Opaque cursor to be used for getting next page of records (supplied by current result page) This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
result_count (long or None) – Count of results found (across all pages), set only on first page format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
sort_ascending (bool or None) – If true, results are sorted in ascending order This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
sort_by (str or None) – Field by which records are sorted This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
results (list of PolicyFineTuningResourceInfo) – Resource info list results

class com.vmware.nsx_policy.model_client.ResourceLink(action=None, href=None, rel=None)¶

Bases: vmware.vapi.bindings.struct.VapiStruct

A link to a related resource

Tip

The arguments are used to initialize data attributes with the same names.

Parameters

action (str or None) – Optional action This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
href (str or None) – Link to resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
rel (str or None) – Custom relation type (follows RFC 5988 where appropriate definitions exist) This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.

class com.vmware.nsx_policy.model_client.ResourceOperation(operation_types=None, resource_pointer=None, resource_type='ResourceOperation')¶

Bases: vmware.vapi.bindings.struct.VapiStruct

Resource Operation is an Event Source that represents a resource that is being changed at very specific points of time, with regard to its interaction with dao layer.

Tip

The arguments are used to initialize data attributes with the same names.

Parameters

operation_types (list of str) –
Possible values are:
Operation types.
resource_pointer (str) – Regex path representing a regex expression on resources. This regex is used to identify the object(s) that is/are the source of the Event. For instance: specifying “Lb* | /infra/tier-0s/vmc/ipsec-vpn-services/default” as a source means that ANY resource starting with Lb or ANY resource with “/infra/tier-0s/vmc/ipsec-vpn-services/default” as path would be the source of the event in question.
resource_type (str) –
Possible values are:
- Source.RESOURCE_TYPE_RESOURCEOPERATION
- Source.RESOURCE_TYPE_APIREQUESTBODY
Event Source resource type.

OPERATION_TYPES_POST_CREATE = 'POST_CREATE'¶

OPERATION_TYPES_POST_UPDATE = 'POST_UPDATE'¶

OPERATION_TYPES_PRE_DELETE = 'PRE_DELETE'¶

property resource_type¶: Return the discriminator value

class com.vmware.nsx_policy.model_client.ResourceReference(is_valid=None, target_display_name=None, target_id=None, target_type=None)¶

Bases: vmware.vapi.bindings.struct.VapiStruct

A weak reference to an NSX resource.

Tip

The arguments are used to initialize data attributes with the same names.

Parameters

is_valid (bool or None) – Will be set to false if the referenced NSX resource has been deleted. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
target_display_name (str or None) – Display name of the NSX resource. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
target_id (str or None) – Identifier of the NSX resource.
target_type (str or None) – Type of the NSX resource.

class com.vmware.nsx_policy.model_client.RevisionedResource(links=None, schema=None, self_=None, revision=None)¶

Bases: vmware.vapi.bindings.struct.VapiStruct

A base class for types that track revisions

Tip

The arguments are used to initialize data attributes with the same names.

Parameters

links (list of ResourceLink or None) – The server will populate this field when returing the resource. Ignored on PUT and POST. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
schema (str or None) – Schema for this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
self (SelfResourceLink or None) – Link to this resource
revision (long or None) – The _revision property describes the current revision of the resource. To prevent clients from overwriting each other’s changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected. format: int32

class com.vmware.nsx_policy.model_client.RouteAdvertisementRule(action=None, name=None, prefix_operator=None, route_advertisement_types=None, subnets=None)¶

Bases: vmware.vapi.bindings.struct.VapiStruct

Route advertisement rules and filtering

Tip

The arguments are used to initialize data attributes with the same names.

Parameters

action (str) –
Possible values are:
- RouteAdvertisementRule.ACTION_PERMIT
- RouteAdvertisementRule.ACTION_DENY
Action to advertise filtered routes to the connected Tier0 gateway. PERMIT: Enables the advertisment DENY: Disables the advertisement
name (str) – Display name should be unique.
prefix_operator (str or None) –
Possible values are:
- RouteAdvertisementRule.PREFIX_OPERATOR_GE
- RouteAdvertisementRule.PREFIX_OPERATOR_EQ
Prefix operator to filter subnets. GE prefix operator filters all the routes with prefix length greater than or equal to the subnets configured. EQ prefix operator filter all the routes with prefix length equal to the subnets configured.
route_advertisement_types (list of str or None) –
Possible values are:
Enable different types of route advertisements. When not specified, routes to IPSec VPN local-endpoint subnets (TIER1_IPSEC_LOCAL_ENDPOINT) are automatically advertised.
subnets (list of str or None) – Network CIDRs to be routed. format: ip-cidr-block

ACTION_DENY = 'DENY'¶

ACTION_PERMIT = 'PERMIT'¶

PREFIX_OPERATOR_EQ = 'EQ'¶

PREFIX_OPERATOR_GE = 'GE'¶

ROUTE_ADVERTISEMENT_TYPES_CONNECTED = 'TIER1_CONNECTED'¶

ROUTE_ADVERTISEMENT_TYPES_DNS_FORWARDER_IP = 'TIER1_DNS_FORWARDER_IP'¶

ROUTE_ADVERTISEMENT_TYPES_IPSEC_LOCAL_ENDPOINT = 'TIER1_IPSEC_LOCAL_ENDPOINT'¶

ROUTE_ADVERTISEMENT_TYPES_LB_SNAT = 'TIER1_LB_SNAT'¶

ROUTE_ADVERTISEMENT_TYPES_LB_VIP = 'TIER1_LB_VIP'¶

ROUTE_ADVERTISEMENT_TYPES_NAT = 'TIER1_NAT'¶

ROUTE_ADVERTISEMENT_TYPES_STATIC_ROUTES = 'TIER1_STATIC_ROUTES'¶

class com.vmware.nsx_policy.model_client.RouteAggregationEntry(prefix=None, summary_only=None)¶

Bases: vmware.vapi.bindings.struct.VapiStruct

List of routes to be aggregated

Tip

The arguments are used to initialize data attributes with the same names.

Parameters

prefix (str) – CIDR of aggregate address format: ip-cidr-block
summary_only (bool or None) – Send only summarized route. Summarization reduces number of routes advertised by representing multiple related routes with prefix property.

class com.vmware.nsx_policy.model_client.RouteBasedIPSecVpnSession(force_whitelisting=None, tunnel_interfaces=None, links=None, schema=None, self_=None, revision=None, create_time=None, create_user=None, last_modified_time=None, last_modified_user=None, protection=None, system_owned=None, description=None, display_name=None, id=None, resource_type='RouteBasedIPSecVpnSession', tags=None, parent_path=None, path=None, relative_path=None, children=None, marked_for_delete=None, authentication_mode=None, compliance_suite=None, connection_initiation_mode=None, dpd_profile_path=None, enabled=None, ike_profile_path=None, local_endpoint_path=None, peer_address=None, peer_id=None, psk=None, tcp_mss_clamping=None, tunnel_profile_path=None)¶

Bases: vmware.vapi.bindings.struct.VapiStruct

A Route Based VPN is more flexible, more powerful and recommended over policy based VPN. IP Tunnel port is created and all traffic routed via tunnel port is protected. Routes can be configured statically or can be learned through BGP. A route based VPN is must for establishing redundant VPN session to remote site.

Tip

The arguments are used to initialize data attributes with the same names.

Parameters

force_whitelisting (bool or None) – If true the default firewall rule Action is set to DROP, otherwise set to ALLOW. This filed is deprecated and recommended to change Rule action filed. Note that this filed is not synchornied with default rule field.
tunnel_interfaces (list of IPSecVpnTunnelInterface) – IP Tunnel interfaces.
links (list of ResourceLink or None) – The server will populate this field when returing the resource. Ignored on PUT and POST. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
schema (str or None) – Schema for this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
self (SelfResourceLink or None) – Link to this resource
revision (long or None) – The _revision property describes the current revision of the resource. To prevent clients from overwriting each other’s changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected. format: int32
create_time (long or None) – Timestamp of resource creation format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
create_user (str or None) – ID of the user who created this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
last_modified_time (long or None) – Timestamp of last modification format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
last_modified_user (str or None) – ID of the user who last modified this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
protection (str or None) – Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super user and can modify it, but only when providing the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this entity. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
system_owned (bool or None) – Indicates system owned resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
description (str or None) – Description of this resource
display_name (str or None) – Defaults to ID if not set
id (str or None) – Unique identifier of this resource
resource_type (str) –
Possible values are:
- IPSecVpnSession.RESOURCE_TYPE_POLICYBASEDIPSECVPNSESSION
- IPSecVpnSession.RESOURCE_TYPE_ROUTEBASEDIPSECVPNSESSION
A Policy Based VPN requires to define protect rules that match local and peer subnets. IPSec security associations is negotiated for each pair of local and peer subnet. A Route Based VPN is more flexible, more powerful and recommended over policy based VPN. IP Tunnel port is created and all traffic routed via tunnel port is protected. Routes can be configured statically or can be learned through BGP. A route based VPN is must for establishing redundant VPN session to remote site.
tags (list of Tag or None) – Opaque identifiers meaningful to the API user
parent_path (str or None) – Path of its parent This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
path (str or None) – Absolute path of this object This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
relative_path (str or None) – Path relative from its parent This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
children (list of vmware.vapi.struct.VapiStruct or None) – subtree for this type within policy tree containing nested elements. When clients pass a value of this class as a parameter, the attribute must contain all the attributes defined in ChildPolicyConfigResource. When methods return a value of this class as a return value, the attribute will contain all the attributes defined in ChildPolicyConfigResource.
marked_for_delete (bool or None) – Intent objects are not directly deleted from the system when a delete is invoked on them. They are marked for deletion and only when all the realized entities for that intent object gets deleted, the intent object is deleted. Objects that are marked for deletion are not returned in GET call. One can use the search API to get these objects. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
authentication_mode (str or None) –
Possible values are:
- IPSecVpnSession.AUTHENTICATION_MODE_PSK
- IPSecVpnSession.AUTHENTICATION_MODE_CERTIFICATE
Peer authentication mode. PSK - In this mode a secret key shared between local and peer sites is to be used for authentication. The secret key can be a string with a maximum length of 128 characters. CERTIFICATE - In this mode a certificate defined at the global level is to be used for authentication.
compliance_suite (str or None) –
Possible values are:
- IPSecVpnSession.COMPLIANCE_SUITE_CNSA
- IPSecVpnSession.COMPLIANCE_SUITE_SUITE_B_GCM_128
- IPSecVpnSession.COMPLIANCE_SUITE_SUITE_B_GCM_256
- IPSecVpnSession.COMPLIANCE_SUITE_PRIME
- IPSecVpnSession.COMPLIANCE_SUITE_FOUNDATION
- IPSecVpnSession.COMPLIANCE_SUITE_FIPS
- IPSecVpnSession.COMPLIANCE_SUITE_NONE
Compliance suite.
connection_initiation_mode (str or None) –
Possible values are:
- IPSecVpnSession.CONNECTION_INITIATION_MODE_INITIATOR
- IPSecVpnSession.CONNECTION_INITIATION_MODE_RESPOND_ONLY
- IPSecVpnSession.CONNECTION_INITIATION_MODE_ON_DEMAND
Connection initiation mode used by local endpoint to establish ike connection with peer site. INITIATOR - In this mode local endpoint initiates tunnel setup and will also respond to incoming tunnel setup requests from peer gateway. RESPOND_ONLY - In this mode, local endpoint shall only respond to incoming tunnel setup requests. It shall not initiate the tunnel setup. ON_DEMAND - In this mode local endpoint will initiate tunnel creation once first packet matching the policy rule is received and will also respond to incoming initiation request.
dpd_profile_path (str or None) – Policy path referencing Dead Peer Detection (DPD) profile. Default is set to system default profile.
enabled (bool or None) – Enable/Disable IPSec VPN session.
ike_profile_path (str or None) – Policy path referencing IKE profile to be used. Default is set according to system default profile.
local_endpoint_path (str) – Policy path referencing Local endpoint.
peer_address (str) – Public IPV4 address of the remote device terminating the VPN connection.
peer_id (str) – Peer ID to uniquely identify the peer site. The peer ID is the public IP address of the remote device terminating the VPN tunnel. When NAT is configured for the peer, enter the private IP address of the peer.
psk (str or None) – IPSec Pre-shared key. Maximum length of this field is 128 characters.
tcp_mss_clamping (TcpMaximumSegmentSizeClamping or None) – TCP Maximum Segment Size Clamping Direction and Value.
tunnel_profile_path (str or None) – Policy path referencing Tunnel profile to be used. Default is set to system default profile.

property resource_type¶: Return the discriminator value

class com.vmware.nsx_policy.model_client.RouteBasedL3VpnSession(default_rule_logging=None, force_whitelisting=None, routing_config_path=None, tunnel_subnets=None, resource_type='RouteBasedL3VpnSession')¶

Bases: vmware.vapi.bindings.struct.VapiStruct

A Route Based L3Vpn is more flexible, more powerful and recommended over policy based. IP Tunnel subnet is created and all traffic routed through tunnel subnet is sent over tunnel. Routes can be learned through BGP. A route based L3Vpn is required when using redundant L3Vpn.

Tip

The arguments are used to initialize data attributes with the same names.

Parameters

default_rule_logging (bool or None) – Indicates if logging should be enabled for the default whitelisting rule for the VTI interface.
force_whitelisting (bool or None) – The default firewall rule Action is set to DROP if true otherwise set to ALLOW.
routing_config_path (str or None) – This is a deprecated field. Any specified value is not saved and will be ignored.
tunnel_subnets (list of TunnelSubnet) – Virtual tunnel interface (VTI) port IP subnets to be used to configure route-based L3Vpn session. A max of one tunnel subnet is allowed.
resource_type (str) –
Possible values are:
- L3VpnSession.RESOURCE_TYPE_POLICYBASEDL3VPNSESSION
- L3VpnSession.RESOURCE_TYPE_ROUTEBASEDL3VPNSESSION
- A Policy Based L3Vpn is a configuration in which protect rules to
match local and remote subnet needs to be defined. Tunnel is established for each pair of local and remote subnet defined in protect rules. - A Route Based L3Vpn is more flexible, more powerful and recommended over policy based. IP Tunnel subnet is created and all traffic routed through tunnel subnet (commonly known as VTI) is sent over tunnel. Routes can be learned through BGP. A route based L3Vpn is required when using redundant L3Vpn.

property resource_type¶: Return the discriminator value

class com.vmware.nsx_policy.model_client.RouteDetails(as_path=None, local_pref=None, med=None, network=None, next_hop=None, weight=None)¶

Bases: vmware.vapi.bindings.struct.VapiStruct

BGP route details.

Tip

The arguments are used to initialize data attributes with the same names.

Parameters

as_path (str or None) – BGP AS path attribute. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
local_pref (long or None) – BGP Local Preference attribute. format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
med (long or None) – BGP Multi Exit Discriminator attribute. format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
network (str or None) – CIDR network address. format: ip-cidr-block This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
next_hop (str or None) – Next hop IP address. format: ip This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
weight (long or None) – BGP Weight attribute. format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.

class com.vmware.nsx_policy.model_client.RouteMapEntry(action=None, community_list_matches=None, prefix_list_matches=None, set=None)¶

Bases: vmware.vapi.bindings.struct.VapiStruct

Route map entry

Tip

The arguments are used to initialize data attributes with the same names.

Parameters

action (str) –
Possible values are:
- RouteMapEntry.ACTION_PERMIT
- RouteMapEntry.ACTION_DENY
Action for the route map entry
community_list_matches (list of CommunityMatchCriteria or None) – Community list match criteria for route map. Properties community_list_matches and prefix_list_matches are mutually exclusive and cannot be used in the same route map entry.
prefix_list_matches (list of str or None) – Prefix list match criteria for route map. Properties community_list_matches and prefix_list_matches are mutually exclusive and cannot be used in the same route map entry.
set (RouteMapEntrySet or None) – Set criteria for route map entry

ACTION_DENY = 'DENY'¶

ACTION_PERMIT = 'PERMIT'¶

class com.vmware.nsx_policy.model_client.RouteMapEntrySet(as_path_prepend=None, community=None, local_preference=None, med=None, weight=None)¶

Bases: vmware.vapi.bindings.struct.VapiStruct

Set criteria for route map entry

Tip

The arguments are used to initialize data attributes with the same names.

Parameters

as_path_prepend (str or None) – AS path prepend to influence route selection.
community (str or None) – Set BGP regular or large community for matching routes. A maximum of one value for each community type separated by space. Well-known community name, community value in aa:nn (2byte:2byte) format for regular community and community value in aa:bb:nn (4byte:4byte:4byte) format for large community are supported.
local_preference (long or None) – Local preference indicates the degree of preference for one BGP route over other BGP routes. The path with highest local preference is preferred. format: int64
med (long or None) – Multi exit descriminator (MED) is a hint to BGP neighbors about the preferred path into an autonomous system (AS) that has multiple entry points. A lower MED value is preferred over a higher value. format: int32
weight (long or None) – Weight is used to select a route when multiple routes are available to the same network. Route with the highest weight is preferred. format: int32

class com.vmware.nsx_policy.model_client.RouterNexthop(admin_distance=None, ip_address=None, scope=None)¶

Bases: vmware.vapi.bindings.struct.VapiStruct

Next hop configuration for network

Tip

The arguments are used to initialize data attributes with the same names.

Parameters

admin_distance (long or None) – Cost associated with next hop route format: int32
ip_address (str or None) – Next hop gateway IP address format: ip
scope (list of str or None) – Interface path associated with current route. For example: specify a policy path referencing the IPSec VPN Session.

class com.vmware.nsx_policy.model_client.RoutesPerTransportNode(routes=None, source_address=None, transport_node_id=None)¶

Bases: vmware.vapi.bindings.struct.VapiStruct

BGP routes per transport node.

Tip

The arguments are used to initialize data attributes with the same names.

Parameters

routes (list of RouteDetails or None) – Array of BGP neighbor route details for this transport node. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
source_address (str or None) – BGP neighbor source address. format: ip This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
transport_node_id (str or None) – Transport node id This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.

class com.vmware.nsx_policy.model_client.RoutingEntry(admin_distance=None, network=None, next_hop=None, route_type=None)¶

Bases: vmware.vapi.bindings.struct.VapiStruct

Routing table entry.

Tip

The arguments are used to initialize data attributes with the same names.

Parameters

admin_distance (long or None) – Admin distance. format: int32 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
network (str or None) – Network CIDR. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
next_hop (str or None) – Next hop address. format: ip This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
route_type (str or None) – Network address CIDR. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.

class com.vmware.nsx_policy.model_client.RoutingTable(count=None, edge_node=None, route_entries=None)¶

Bases: vmware.vapi.bindings.struct.VapiStruct

Routing table.

Tip

The arguments are used to initialize data attributes with the same names.

Parameters

count (long or None) – Entry count. format: int32 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
edge_node (str or None) – Transport node ID. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
route_entries (list of RoutingEntry) – Route entries.

class com.vmware.nsx_policy.model_client.RoutingTableListResult(links=None, schema=None, self_=None, cursor=None, result_count=None, sort_ascending=None, sort_by=None, results=None)¶

Bases: vmware.vapi.bindings.struct.VapiStruct

Tip

The arguments are used to initialize data attributes with the same names.

Parameters

links (list of ResourceLink or None) – The server will populate this field when returing the resource. Ignored on PUT and POST. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
schema (str or None) – Schema for this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
self (SelfResourceLink or None) – Link to this resource
cursor (str or None) – Opaque cursor to be used for getting next page of records (supplied by current result page) This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
result_count (long or None) – Count of results found (across all pages), set only on first page format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
sort_ascending (bool or None) – If true, results are sorted in ascending order This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
sort_by (str or None) – Field by which records are sorted This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
results (list of RoutingTable or None) – Paged Collection of Routes per transport node ID.

class com.vmware.nsx_policy.model_client.RowListField(alias=None, path=None)¶

Bases: vmware.vapi.bindings.struct.VapiStruct

Root of the api result set for forming rows.

Tip

The arguments are used to initialize data attributes with the same names.

Parameters

alias (str or None) –
path (str) – JSON path to the root of the api result set for forming rows.

class com.vmware.nsx_policy.model_client.Rule(links=None, schema=None, self_=None, revision=None, create_time=None, create_user=None, last_modified_time=None, last_modified_user=None, protection=None, system_owned=None, description=None, display_name=None, id=None, resource_type=None, tags=None, parent_path=None, path=None, relative_path=None, children=None, marked_for_delete=None, destination_groups=None, destinations_excluded=None, direction=None, disabled=None, ip_protocol=None, logged=None, notes=None, profiles=None, scope=None, sequence_number=None, services=None, source_groups=None, sources_excluded=None, tag=None, action=None)¶

Bases: vmware.vapi.bindings.struct.VapiStruct

A rule indicates the action to be performed for various types of traffic flowing between workload groups.

Tip

The arguments are used to initialize data attributes with the same names.

Parameters

links (list of ResourceLink or None) – The server will populate this field when returing the resource. Ignored on PUT and POST. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
schema (str or None) – Schema for this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
self (SelfResourceLink or None) – Link to this resource
revision (long or None) – The _revision property describes the current revision of the resource. To prevent clients from overwriting each other’s changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected. format: int32
create_time (long or None) – Timestamp of resource creation format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
create_user (str or None) – ID of the user who created this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
last_modified_time (long or None) – Timestamp of last modification format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
last_modified_user (str or None) – ID of the user who last modified this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
protection (str or None) – Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super user and can modify it, but only when providing the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this entity. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
system_owned (bool or None) – Indicates system owned resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
description (str or None) – Description of this resource
display_name (str or None) – Defaults to ID if not set
id (str or None) – Unique identifier of this resource
resource_type (str or None) – The type of this resource.
tags (list of Tag or None) – Opaque identifiers meaningful to the API user
parent_path (str or None) – Path of its parent This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
path (str or None) – Absolute path of this object This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
relative_path (str or None) – Path relative from its parent This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
children (list of vmware.vapi.struct.VapiStruct or None) – subtree for this type within policy tree containing nested elements. When clients pass a value of this class as a parameter, the attribute must contain all the attributes defined in ChildPolicyConfigResource. When methods return a value of this class as a return value, the attribute will contain all the attributes defined in ChildPolicyConfigResource.
marked_for_delete (bool or None) – Intent objects are not directly deleted from the system when a delete is invoked on them. They are marked for deletion and only when all the realized entities for that intent object gets deleted, the intent object is deleted. Objects that are marked for deletion are not returned in GET call. One can use the search API to get these objects. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
destination_groups (list of str or None) – We need paths as duplicate names may exist for groups under different domains.In order to specify all groups, use the constant “ANY”. This is case insensitive. If “ANY” is used, it should be the ONLY element in the group array. Error will be thrown if ANY is used in conjunction with other values.
destinations_excluded (bool or None) – If set to true, the rule gets applied on all the groups that are NOT part of the destination groups. If false, the rule applies to the destination groups
direction (str or None) –
Possible values are:
- Rule.DIRECTION_IN
- Rule.DIRECTION_OUT
- Rule.DIRECTION_IN_OUT
Define direction of traffic.
disabled (bool or None) – Flag to disable the rule. Default is enabled.
ip_protocol (str or None) –
Possible values are:
- Rule.IP_PROTOCOL_IPV4
- Rule.IP_PROTOCOL_IPV6
- Rule.IP_PROTOCOL_IPV4_IPV6
Type of IP packet that should be matched while enforcing the rule. The value is set to IPV4_IPV6 for Layer3 rule if not specified. For Layer2/Ether rule the value must be null.
logged (bool or None) – Flag to enable packet logging. Default is disabled.
notes (str or None) – Text for additional notes on changes.
profiles (list of str or None) – Holds the list of layer 7 service profile paths. These profiles accept attributes and sub-attributes of various network services (e.g. L4 AppId, encryption algorithm, domain name, etc) as key value pairs.
scope (list of str or None) – The list of policy paths where the rule is applied LR/Edge/T0/T1/LRP etc. Note that a given rule can be applied on multiple LRs/LRPs.
sequence_number (long or None) – This field is used to resolve conflicts between multiple Rules under Security or Gateway Policy for a Domain If no sequence number is specified in the payload, a value of 0 is assigned by default. If there are multiple rules with the same sequence number then their order is not deterministic. If a specific order of rules is desired, then one has to specify unique sequence numbers or use the POST request on the rule entity with a query parameter action=revise to let the framework assign a sequence number format: int32
services (list of str or None) – In order to specify all services, use the constant “ANY”. This is case insensitive. If “ANY” is used, it should be the ONLY element in the services array. Error will be thrown if ANY is used in conjunction with other values.
source_groups (list of str or None) – We need paths as duplicate names may exist for groups under different domains. In order to specify all groups, use the constant “ANY”. This is case insensitive. If “ANY” is used, it should be the ONLY element in the group array. Error will be thrown if ANY is used in conjunction with other values.
sources_excluded (bool or None) – If set to true, the rule gets applied on all the groups that are NOT part of the source groups. If false, the rule applies to the source groups
tag (str or None) – User level field which will be printed in CLI and packet logs.
action (str or None) –
Possible values are:
- Rule.ACTION_ALLOW
- Rule.ACTION_DROP
- Rule.ACTION_REJECT
The action to be applied to all the services

ACTION_ALLOW = 'ALLOW'¶

ACTION_DROP = 'DROP'¶

ACTION_REJECT = 'REJECT'¶

DIRECTION_IN = 'IN'¶

DIRECTION_IN_OUT = 'IN_OUT'¶

DIRECTION_OUT = 'OUT'¶

IP_PROTOCOL_IPV4 = 'IPV4'¶

IP_PROTOCOL_IPV4_IPV6 = 'IPV4_IPV6'¶

IP_PROTOCOL_IPV6 = 'IPV6'¶

class com.vmware.nsx_policy.model_client.RuleListResult(links=None, schema=None, self_=None, cursor=None, result_count=None, sort_ascending=None, sort_by=None, results=None)¶

Bases: vmware.vapi.bindings.struct.VapiStruct

Paged Collection of Rules

Tip

The arguments are used to initialize data attributes with the same names.

Parameters

links (list of ResourceLink or None) – The server will populate this field when returing the resource. Ignored on PUT and POST. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
schema (str or None) – Schema for this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
self (SelfResourceLink or None) – Link to this resource
cursor (str or None) – Opaque cursor to be used for getting next page of records (supplied by current result page) This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
result_count (long or None) – Count of results found (across all pages), set only on first page format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
sort_ascending (bool or None) – If true, results are sorted in ascending order This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
sort_by (str or None) – Field by which records are sorted This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
results (list of Rule) – Rule list results

class com.vmware.nsx_policy.model_client.RuleStatistics(links=None, schema=None, self_=None, byte_count=None, hit_count=None, internal_rule_id=None, lr_path=None, max_popularity_index=None, max_session_count=None, packet_count=None, popularity_index=None, rule=None, session_count=None, total_session_count=None)¶

Bases: vmware.vapi.bindings.struct.VapiStruct

Tip

The arguments are used to initialize data attributes with the same names.

Parameters

links (list of ResourceLink or None) – The server will populate this field when returing the resource. Ignored on PUT and POST. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
schema (str or None) – Schema for this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
self (SelfResourceLink or None) – Link to this resource
byte_count (long or None) – Aggregated number of bytes processed by the rule. format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
hit_count (long or None) – Aggregated number of hits received by the rule. format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
internal_rule_id (str or None) – Realized id of the rule on NSX MP. Policy Manager can create more than one rule per policy rule, in which case this identifier helps to distinguish between the multple rules created. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
lr_path (str or None) – Path of the LR on which the section is applied in case of Edge FW. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
max_popularity_index (long or None) – Maximum value of popularity index of all rules of the type. This is aggregated statistic which are computed with lower frequency compared to individual generic rule statistics. It may have a computation delay up to 15 minutes in response to this API. format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
max_session_count (long or None) – Maximum value of sessions count of all rules of the type. This is aggregated statistic which are computed with lower frequency compared to generic rule statistics. It may have a computation delay up to 15 minutes in response to this API. format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
packet_count (long or None) – Aggregated number of packets processed by the rule. format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
popularity_index (long or None) – This is calculated by sessions count divided by age of the rule. format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
rule (str or None) – Path of the rule. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
session_count (long or None) – Aggregated number of sessions processed by the rule. format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
total_session_count (long or None) – Aggregated number of sessions processed by all the rules This is aggregated statistic which are computed with lower frequency compared to individual generic rule statistics. It may have a computation delay up to 15 minutes in response to this API. format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.

class com.vmware.nsx_policy.model_client.RuleStatisticsForEnforcementPoint(enforcement_point=None, statistics=None)¶

Bases: vmware.vapi.bindings.struct.VapiStruct

Rule statistics for a specfic enforcement point.

Tip

The arguments are used to initialize data attributes with the same names.

Parameters

enforcement_point (str or None) – Rule statistics for a single enforcement point This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
statistics (RuleStatistics or None) – Statistics for the specified enforcement point

class com.vmware.nsx_policy.model_client.RuleStatisticsListResult(links=None, schema=None, self_=None, cursor=None, result_count=None, sort_ascending=None, sort_by=None, results=None)¶

Bases: vmware.vapi.bindings.struct.VapiStruct

Paged Collection of rule statistics

Tip

The arguments are used to initialize data attributes with the same names.

Parameters

links (list of ResourceLink or None) – The server will populate this field when returing the resource. Ignored on PUT and POST. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
schema (str or None) – Schema for this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
self (SelfResourceLink or None) – Link to this resource
cursor (str or None) – Opaque cursor to be used for getting next page of records (supplied by current result page) This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
result_count (long or None) – Count of results found (across all pages), set only on first page format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
sort_ascending (bool or None) – If true, results are sorted in ascending order This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
sort_by (str or None) – Field by which records are sorted This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
results (list of RuleStatisticsForEnforcementPoint) – RuleStatistics list results

class com.vmware.nsx_policy.model_client.RuntimeInterfaceStatistics(rx_bytes=None, rx_packets=None, tx_bytes=None, tx_packets=None, dropped_by_security_packets=None, mac_learning=None, interface_index=None, last_update_timestamp=None)¶

Bases: vmware.vapi.bindings.struct.VapiStruct

Tip

The arguments are used to initialize data attributes with the same names.

Parameters

rx_bytes (SIDataCounter or None) –
rx_packets (SIDataCounter or None) –
tx_bytes (SIDataCounter or None) –
tx_packets (SIDataCounter or None) –
dropped_by_security_packets (SIPacketsDroppedBySecurity or None) –
mac_learning (SIMacLearningCounters or None) –
interface_index (long or None) – Index of the interface format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
last_update_timestamp (long or None) – Timestamp when the data was last updated; unset if data source has never updated the data. format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.

class com.vmware.nsx_policy.model_client.SIAggregatedDataCounter(rx_bytes=None, rx_packets=None, tx_bytes=None, tx_packets=None)¶

Bases: vmware.vapi.bindings.struct.VapiStruct

Tip

The arguments are used to initialize data attributes with the same names.

Parameters

rx_bytes (SIDataCounter or None) –
rx_packets (SIDataCounter or None) –
tx_bytes (SIDataCounter or None) –
tx_packets (SIDataCounter or None) –

class com.vmware.nsx_policy.model_client.SIAggregatedDataCounterEx(rx_bytes=None, rx_packets=None, tx_bytes=None, tx_packets=None, dropped_by_security_packets=None, mac_learning=None)¶

Bases: vmware.vapi.bindings.struct.VapiStruct

Tip

The arguments are used to initialize data attributes with the same names.

Parameters

rx_bytes (SIDataCounter or None) –
rx_packets (SIDataCounter or None) –
tx_bytes (SIDataCounter or None) –
tx_packets (SIDataCounter or None) –
dropped_by_security_packets (SIPacketsDroppedBySecurity or None) –
mac_learning (SIMacLearningCounters or None) –

class com.vmware.nsx_policy.model_client.SIDataCounter(dropped=None, multicast_broadcast=None, total=None)¶

Bases: vmware.vapi.bindings.struct.VapiStruct

Tip

The arguments are used to initialize data attributes with the same names.

Parameters

dropped (long or None) – The dropped packets or bytes format: int64
multicast_broadcast (long or None) – The multicast and broadcast packets or bytes format: int64
total (long) – The total packets or bytes format: int64

class com.vmware.nsx_policy.model_client.SIMacLearningCounters(mac_not_learned_packets_allowed=None, mac_not_learned_packets_dropped=None, macs_learned=None)¶

Bases: vmware.vapi.bindings.struct.VapiStruct

Tip

The arguments are used to initialize data attributes with the same names.

Parameters

mac_not_learned_packets_allowed (long or None) – The number of packets with unknown source MAC address that are dispatched without learning the source MAC address. Applicable only when the MAC limit is reached and MAC Limit policy is MAC_LEARNING_LIMIT_POLICY_ALLOW. format: int64
mac_not_learned_packets_dropped (long or None) – The number of packets with unknown source MAC address that are dropped without learning the source MAC address. Applicable only when the MAC limit is reached and MAC Limit policy is MAC_LEARNING_LIMIT_POLICY_DROP. format: int64
macs_learned (long or None) – Number of MACs learned format: int64

class com.vmware.nsx_policy.model_client.SIPacketTypeAndCounter(counter=None, packet_type=None)¶

Bases: vmware.vapi.bindings.struct.VapiStruct

Tip

The arguments are used to initialize data attributes with the same names.

Parameters

counter (long) – The number of packets. format: int64
packet_type (str) – The type of the packets

class com.vmware.nsx_policy.model_client.SIPacketsDroppedBySecurity(bpdu_filter_dropped=None, dhcp_client_dropped_ipv4=None, dhcp_client_dropped_ipv6=None, dhcp_server_dropped_ipv4=None, dhcp_server_dropped_ipv6=None, spoof_guard_dropped=None)¶

Bases: vmware.vapi.bindings.struct.VapiStruct

Tip

The arguments are used to initialize data attributes with the same names.

Parameters

bpdu_filter_dropped (long or None) – The number of packets dropped by “BPDU filter”. format: int64
dhcp_client_dropped_ipv4 (long or None) – The number of IPv4 packets dropped by “DHCP client block”. format: int64
dhcp_client_dropped_ipv6 (long or None) – The number of IPv6 packets dropped by “DHCP client block”. format: int64
dhcp_server_dropped_ipv4 (long or None) – The number of IPv4 packets dropped by “DHCP server block”. format: int64
dhcp_server_dropped_ipv6 (long or None) – The number of IPv6 packets dropped by “DHCP server block”. format: int64
spoof_guard_dropped (list of SIPacketTypeAndCounter or None) – The packets dropped by “Spoof Guard”; supported packet types are IPv4, IPv6, ARP, ND, non-IP.

class com.vmware.nsx_policy.model_client.SVMDeploymentSpec(host_type=None, min_host_version=None, name=None, ovf_url=None, service_form_factor=None)¶

Bases: vmware.vapi.bindings.struct.VapiStruct

Deployment Specs holds information required to deploy the Service-VMs.i.e. OVF url where the partner Service-VM OVF is hosted. The host type on which the OVF(Open Virtualization Format) can be deployed, Form factor to name a few.

Tip

The arguments are used to initialize data attributes with the same names.

Parameters

host_type (str) –
Possible values are:
Host Type on which the specified OVF can be deployed.
min_host_version (str or None) – Minimum host version supported by this ovf. If a host in the deployment cluster is having version less than this, then service deployment will not happen on that host.
name (str or None) – Deployment Spec name for ease of use, since multiple DeploymentSpec can be specified.
ovf_url (str) – Location of the partner VM OVF to be deployed.
service_form_factor (str or None) –
Possible values are:
Supported ServiceInsertion Form Factor for the OVF deployment. The default FormFactor is Medium.

HOST_TYPE_ESXI = 'ESXI'¶

HOST_TYPE_RHELKVM = 'RHELKVM'¶

HOST_TYPE_UBUNTUKVM = 'UBUNTUKVM'¶

SERVICE_FORM_FACTOR_LARGE = 'LARGE'¶

SERVICE_FORM_FACTOR_MEDIUM = 'MEDIUM'¶

SERVICE_FORM_FACTOR_SMALL = 'SMALL'¶

class com.vmware.nsx_policy.model_client.SearchResponse(links=None, schema=None, self_=None, cursor=None, result_count=None, sort_ascending=None, sort_by=None, results=None)¶

Bases: vmware.vapi.bindings.struct.VapiStruct

Search response

Tip

The arguments are used to initialize data attributes with the same names.

Parameters

links (list of ResourceLink or None) – The server will populate this field when returing the resource. Ignored on PUT and POST. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
schema (str or None) – Schema for this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
self (SelfResourceLink or None) – Link to this resource
cursor (str or None) – Opaque cursor to be used for getting next page of records (supplied by current result page) This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
result_count (long or None) – Count of results found (across all pages), set only on first page format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
sort_ascending (bool or None) – If true, results are sorted in ascending order This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
sort_by (str or None) – Field by which records are sorted This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
results (list of vmware.vapi.struct.VapiStruct) – Search results

class com.vmware.nsx_policy.model_client.SecurityPolicy(links=None, schema=None, self_=None, revision=None, create_time=None, create_user=None, last_modified_time=None, last_modified_user=None, protection=None, system_owned=None, description=None, display_name=None, id=None, resource_type=None, tags=None, parent_path=None, path=None, relative_path=None, children=None, marked_for_delete=None, category=None, comments=None, lock_modified_by=None, lock_modified_time=None, locked=None, scope=None, sequence_number=None, stateful=None, tcp_strict=None, rules=None)¶

Bases: vmware.vapi.bindings.struct.VapiStruct

Ordered list of Rules. This object is created by default along with the Domain.

Tip

The arguments are used to initialize data attributes with the same names.

Parameters

links (list of ResourceLink or None) – The server will populate this field when returing the resource. Ignored on PUT and POST. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
schema (str or None) – Schema for this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
self (SelfResourceLink or None) – Link to this resource
revision (long or None) – The _revision property describes the current revision of the resource. To prevent clients from overwriting each other’s changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected. format: int32
create_time (long or None) – Timestamp of resource creation format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
create_user (str or None) – ID of the user who created this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
last_modified_time (long or None) – Timestamp of last modification format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
last_modified_user (str or None) – ID of the user who last modified this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
protection (str or None) – Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super user and can modify it, but only when providing the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this entity. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
system_owned (bool or None) – Indicates system owned resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
description (str or None) – Description of this resource
display_name (str or None) – Defaults to ID if not set
id (str or None) – Unique identifier of this resource
resource_type (str or None) – The type of this resource.
tags (list of Tag or None) – Opaque identifiers meaningful to the API user
parent_path (str or None) – Path of its parent This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
path (str or None) – Absolute path of this object This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
relative_path (str or None) – Path relative from its parent This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
children (list of vmware.vapi.struct.VapiStruct or None) – subtree for this type within policy tree containing nested elements. When clients pass a value of this class as a parameter, the attribute must contain all the attributes defined in ChildPolicyConfigResource. When methods return a value of this class as a return value, the attribute will contain all the attributes defined in ChildPolicyConfigResource.
marked_for_delete (bool or None) – Intent objects are not directly deleted from the system when a delete is invoked on them. They are marked for deletion and only when all the realized entities for that intent object gets deleted, the intent object is deleted. Objects that are marked for deletion are not returned in GET call. One can use the search API to get these objects. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
category (str or None) –
- Distributed Firewall - Policy framework provides five pre-defined
categories for classifying a security policy. They are “Ethernet”,”Emergency”, “Infrastructure” “Environment” and “Application”. There is a pre-determined order in which the policy framework manages the priority of these security policies. Ethernet category is for supporting layer 2 firewall rules. The other four categories are applicable for layer 3 rules. Amongst them, the Emergency category has the highest priority followed by Infrastructure, Environment and then Application rules. Administrator can choose to categorize a security policy into the above categories or can choose to leave it empty. If empty it will have the least precedence w.r.t the above four categories. - Edge Firewall - Policy Framework for Edge Firewall provides six pre-defined categories “Emergency”, “SystemRules”, “SharedPreRules”, “LocalGatewayRules”, “AutoServiceRules” and “Default”, in order of priority of rules. All categories are allowed for Gatetway Policies that belong to ‘default’ Domain. However, for user created domains, category is restricted to “SharedPreRules” or “LocalGatewayRules” only. Also, the users can add/modify/delete rules from only the “SharedPreRules” and “LocalGatewayRules” categories. If user doesn’t specify the category then defaulted to “Rules”. System generated category is used by NSX created rules, for example BFD rules. Autoplumbed category used by NSX verticals to autoplumb data path rules. Finally, “Default” category is the placeholder default rules with lowest in the order of priority.
comments (str or None) – Comments for security policy lock/unlock.
lock_modified_by (str or None) – ID of the user who last modified the lock for the secruity policy. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
lock_modified_time (long or None) – SecurityPolicy locked/unlocked time in epoch milliseconds. format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
locked (bool or None) – Indicates whether a security policy should be locked. If the security policy is locked by a user, then no other user would be able to modify this security policy. Once the user releases the lock, other users can update this security policy.
scope (list of str or None) – The list of group paths where the rules in this policy will get applied. This scope will take precedence over rule level scope. Supported only for security policies.
sequence_number (long or None) – This field is used to resolve conflicts between security policies across domains. In order to change the sequence number of a policy one can fire a POST request on the policy entity with a query parameter action=revise The sequence number field will reflect the value of the computed sequence number upon execution of the above mentioned POST request. For scenarios where the administrator is using a template to update several security policies, the only way to set the sequence number is to explicitly specify the sequence number for each security policy. If no sequence number is specified in the payload, a value of 0 is assigned by default. If there are multiple policies with the same sequence number then their order is not deterministic. If a specific order of policies is desired, then one has to specify unique sequence numbers or use the POST request on the policy entity with a query parameter action=revise to let the framework assign a sequence number format: int32
stateful (bool or None) – Stateful or Stateless nature of security policy is enforced on all rules in this security policy. When it is stateful, the state of the network connects are tracked and a stateful packet inspection is performed. Layer3 security policies can be stateful or stateless. By default, they are stateful. Layer2 security policies can only be stateless.
tcp_strict (bool or None) – Ensures that a 3 way TCP handshake is done before the data packets are sent. tcp_strict=true is supported only for stateful security policies.
rules (list of Rule or None) – Rules that are a part of this SecurityPolicy

class com.vmware.nsx_policy.model_client.SecurityPolicyListResult(links=None, schema=None, self_=None, cursor=None, result_count=None, sort_ascending=None, sort_by=None, results=None)¶

Bases: vmware.vapi.bindings.struct.VapiStruct

Paged Collection of security policies

Tip

The arguments are used to initialize data attributes with the same names.

Parameters

links (list of ResourceLink or None) – The server will populate this field when returing the resource. Ignored on PUT and POST. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
schema (str or None) – Schema for this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
self (SelfResourceLink or None) – Link to this resource
cursor (str or None) – Opaque cursor to be used for getting next page of records (supplied by current result page) This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
result_count (long or None) – Count of results found (across all pages), set only on first page format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
sort_ascending (bool or None) – If true, results are sorted in ascending order This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
sort_by (str or None) – Field by which records are sorted This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
results (list of SecurityPolicy) – SecurityPolicy list results

class com.vmware.nsx_policy.model_client.SecurityPolicyStatistics(internal_section_id=None, lr_path=None, result_count=None, results=None)¶

Bases: vmware.vapi.bindings.struct.VapiStruct

Aggregate statistics of all the rules in a security policy.

Tip

The arguments are used to initialize data attributes with the same names.

Parameters

internal_section_id (str or None) – Realized id of the section on NSX MP. Policy Manager can create more than one section per SecurityPolicy, in which case this identifier helps to distinguish between the multiple sections created. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
lr_path (str or None) – Path of the LR on which the section is applied in case of Gateway Firewall. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
result_count (long or None) – Total count for rule statistics format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
results (list of RuleStatistics or None) – List of rule statistics. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.

class com.vmware.nsx_policy.model_client.SecurityPolicyStatisticsForEnforcementPoint(enforcement_point=None, statistics=None)¶

Bases: vmware.vapi.bindings.struct.VapiStruct

Aggregate statistics of all the rules in a security policy for a specific enforcement point.

Tip

The arguments are used to initialize data attributes with the same names.

Parameters

enforcement_point (str or None) – Enforcement point to fetch the statistics from. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
statistics (SecurityPolicyStatistics or None) – Statistics for the specified enforcement point

class com.vmware.nsx_policy.model_client.SecurityPolicyStatisticsListResult(links=None, schema=None, self_=None, cursor=None, result_count=None, sort_ascending=None, sort_by=None, results=None)¶

Bases: vmware.vapi.bindings.struct.VapiStruct

Paged Collection of Security Policy statistics

Tip

The arguments are used to initialize data attributes with the same names.

Parameters

links (list of ResourceLink or None) – The server will populate this field when returing the resource. Ignored on PUT and POST. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
schema (str or None) – Schema for this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
self (SelfResourceLink or None) – Link to this resource
cursor (str or None) – Opaque cursor to be used for getting next page of records (supplied by current result page) This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
result_count (long or None) – Count of results found (across all pages), set only on first page format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
sort_ascending (bool or None) – If true, results are sorted in ascending order This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
sort_by (str or None) – Field by which records are sorted This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
results (list of SecurityPolicyStatisticsForEnforcementPoint) – Security Policy statistics list results

class com.vmware.nsx_policy.model_client.SecurityProfileBindingMap(links=None, schema=None, self_=None, revision=None, create_time=None, create_user=None, last_modified_time=None, last_modified_user=None, protection=None, system_owned=None, description=None, display_name=None, id=None, resource_type=None, tags=None, parent_path=None, path=None, relative_path=None, children=None, marked_for_delete=None)¶

Bases: vmware.vapi.bindings.struct.VapiStruct

Base security profile binding map

Tip

The arguments are used to initialize data attributes with the same names.

Parameters

links (list of ResourceLink or None) – The server will populate this field when returing the resource. Ignored on PUT and POST. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
schema (str or None) – Schema for this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
self (SelfResourceLink or None) – Link to this resource
revision (long or None) – The _revision property describes the current revision of the resource. To prevent clients from overwriting each other’s changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected. format: int32
create_time (long or None) – Timestamp of resource creation format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
create_user (str or None) – ID of the user who created this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
last_modified_time (long or None) – Timestamp of last modification format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
last_modified_user (str or None) – ID of the user who last modified this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
protection (str or None) – Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super user and can modify it, but only when providing the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this entity. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
system_owned (bool or None) – Indicates system owned resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
description (str or None) – Description of this resource
display_name (str or None) – Defaults to ID if not set
id (str or None) – Unique identifier of this resource
resource_type (str or None) – The type of this resource.
tags (list of Tag or None) – Opaque identifiers meaningful to the API user
parent_path (str or None) – Path of its parent This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
path (str or None) – Absolute path of this object This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
relative_path (str or None) – Path relative from its parent This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
children (list of vmware.vapi.struct.VapiStruct or None) – subtree for this type within policy tree containing nested elements. When clients pass a value of this class as a parameter, the attribute must contain all the attributes defined in ChildPolicyConfigResource. When methods return a value of this class as a return value, the attribute will contain all the attributes defined in ChildPolicyConfigResource.
marked_for_delete (bool or None) – Intent objects are not directly deleted from the system when a delete is invoked on them. They are marked for deletion and only when all the realized entities for that intent object gets deleted, the intent object is deleted. Objects that are marked for deletion are not returned in GET call. One can use the search API to get these objects. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.

class com.vmware.nsx_policy.model_client.Segment(links=None, schema=None, self_=None, revision=None, create_time=None, create_user=None, last_modified_time=None, last_modified_user=None, protection=None, system_owned=None, description=None, display_name=None, id=None, resource_type=None, tags=None, parent_path=None, path=None, relative_path=None, children=None, marked_for_delete=None, advanced_config=None, connectivity_path=None, domain_name=None, l2_extension=None, ls_id=None, overlay_id=None, subnets=None, transport_zone_path=None, type=None, vlan_ids=None)¶

Bases: vmware.vapi.bindings.struct.VapiStruct

Segment configuration to attach workloads.

Tip

The arguments are used to initialize data attributes with the same names.

Parameters

links (list of ResourceLink or None) – The server will populate this field when returing the resource. Ignored on PUT and POST. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
schema (str or None) – Schema for this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
self (SelfResourceLink or None) – Link to this resource
revision (long or None) – The _revision property describes the current revision of the resource. To prevent clients from overwriting each other’s changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected. format: int32
create_time (long or None) – Timestamp of resource creation format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
create_user (str or None) – ID of the user who created this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
last_modified_time (long or None) – Timestamp of last modification format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
last_modified_user (str or None) – ID of the user who last modified this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
protection (str or None) – Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super user and can modify it, but only when providing the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this entity. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
system_owned (bool or None) – Indicates system owned resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
description (str or None) – Description of this resource
display_name (str or None) – Defaults to ID if not set
id (str or None) – Unique identifier of this resource
resource_type (str or None) – The type of this resource.
tags (list of Tag or None) – Opaque identifiers meaningful to the API user
parent_path (str or None) – Path of its parent This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
path (str or None) – Absolute path of this object This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
relative_path (str or None) – Path relative from its parent This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
children (list of vmware.vapi.struct.VapiStruct or None) – subtree for this type within policy tree containing nested elements. When clients pass a value of this class as a parameter, the attribute must contain all the attributes defined in ChildPolicyConfigResource. When methods return a value of this class as a return value, the attribute will contain all the attributes defined in ChildPolicyConfigResource.
marked_for_delete (bool or None) – Intent objects are not directly deleted from the system when a delete is invoked on them. They are marked for deletion and only when all the realized entities for that intent object gets deleted, the intent object is deleted. Objects that are marked for deletion are not returned in GET call. One can use the search API to get these objects. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
advanced_config (SegmentAdvancedConfig or None) – Advanced configuration for Segment.
connectivity_path (str or None) – Policy path to the connecting Tier-0 or Tier-1. Valid only for segments created under Infra.
domain_name (str or None) – DNS domain name
l2_extension (L2Extension or None) – Configuration for extending Segment through L2 VPN
ls_id (str or None) – This property is deprecated. The property will continue to work as expected for existing segments. The segments that are newly created with ls_id will be ignored. Sepcify pre-creted logical switch id for Segment.
overlay_id (long or None) – Used for overlay connectivity of segments. The overlay_id should be allocated from the pool as definied by enforcement-point. If not provided, it is auto-allocated from the default pool on the enforcement-point. format: int32
subnets (list of SegmentSubnet or None) – Subnet configuration. Max 1 subnet
transport_zone_path (str or None) – Policy path to the transport zone. Supported for VLAN backed segments as well as Overlay Segments. This field is required for VLAN backed Segments. Auto assigned if only one transport zone exists in the enforcement point. Default transport zone is auto assigned for overlay segments if none specified.
type (str or None) –
Possible values are:
- Segment.TYPE_ROUTED
- Segment.TYPE_EXTENDED
- Segment.TYPE_ROUTED_AND_EXTENDED
- Segment.TYPE_DISCONNECTED
Segment type based on configuration.

This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
vlan_ids (list of str or None) – VLAN ids for a VLAN backed Segment. Can be a VLAN id or a range of VLAN ids specified with ‘-‘ in between.

TYPE_DISCONNECTED = 'DISCONNECTED'¶

TYPE_EXTENDED = 'EXTENDED'¶

TYPE_ROUTED = 'ROUTED'¶

TYPE_ROUTED_AND_EXTENDED = 'ROUTED_AND_EXTENDED'¶

class com.vmware.nsx_policy.model_client.SegmentAdvancedConfig(connectivity=None, address_pool_paths=None, hybrid=None, local_egress=None)¶

Bases: vmware.vapi.bindings.struct.VapiStruct

Advanced configuration for Segment

Tip

The arguments are used to initialize data attributes with the same names.

Parameters

connectivity (str or None) –
Possible values are:
- SegmentAdvancedConfig.CONNECTIVITY_ON
- SegmentAdvancedConfig.CONNECTIVITY_OFF
Connectivity configuration to manually connect (ON) or disconnect (OFF) a logical entity from network topology.
address_pool_paths (list of str or None) – Policy path to IP address pools.
hybrid (bool or None) – When set to true, all the ports created on this segment will behave in a hybrid fashion. The hybrid port indicates to NSX that the VM intends to operate in underlay mode, but retains the ability to forward egress traffic to the NSX overlay network. This property is only applicable for segment created with transport zone type OVERLAY_STANDARD. This property cannot be modified after segment is created.
local_egress (bool or None) – This property is used to enable proximity routing with local egress. When set to true, logical router interface (downlink) connecting Segment to Tier0/Tier1 gateway is configured with prefix-length 32.

CONNECTIVITY_OFF = 'OFF'¶

CONNECTIVITY_ON = 'ON'¶

class com.vmware.nsx_policy.model_client.SegmentDiscoveryProfileBindingMap(links=None, schema=None, self_=None, revision=None, create_time=None, create_user=None, last_modified_time=None, last_modified_user=None, protection=None, system_owned=None, description=None, display_name=None, id=None, resource_type=None, tags=None, parent_path=None, path=None, relative_path=None, children=None, marked_for_delete=None, ip_discovery_profile_path=None, mac_discovery_profile_path=None)¶

Bases: vmware.vapi.bindings.struct.VapiStruct

This entity will be used to establish association between discovery profile and Segment. Using this entity, user can specify intent for applying discovery profile to particular segments.

Tip

The arguments are used to initialize data attributes with the same names.

Parameters

links (list of ResourceLink or None) – The server will populate this field when returing the resource. Ignored on PUT and POST. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
schema (str or None) – Schema for this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
self (SelfResourceLink or None) – Link to this resource
revision (long or None) – The _revision property describes the current revision of the resource. To prevent clients from overwriting each other’s changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected. format: int32
create_time (long or None) – Timestamp of resource creation format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
create_user (str or None) – ID of the user who created this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
last_modified_time (long or None) – Timestamp of last modification format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
last_modified_user (str or None) – ID of the user who last modified this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
protection (str or None) – Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super user and can modify it, but only when providing the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this entity. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
system_owned (bool or None) – Indicates system owned resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
description (str or None) – Description of this resource
display_name (str or None) – Defaults to ID if not set
id (str or None) – Unique identifier of this resource
resource_type (str or None) – The type of this resource.
tags (list of Tag or None) – Opaque identifiers meaningful to the API user
parent_path (str or None) – Path of its parent This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
path (str or None) – Absolute path of this object This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
relative_path (str or None) – Path relative from its parent This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
children (list of vmware.vapi.struct.VapiStruct or None) – subtree for this type within policy tree containing nested elements. When clients pass a value of this class as a parameter, the attribute must contain all the attributes defined in ChildPolicyConfigResource. When methods return a value of this class as a return value, the attribute will contain all the attributes defined in ChildPolicyConfigResource.
marked_for_delete (bool or None) – Intent objects are not directly deleted from the system when a delete is invoked on them. They are marked for deletion and only when all the realized entities for that intent object gets deleted, the intent object is deleted. Objects that are marked for deletion are not returned in GET call. One can use the search API to get these objects. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
ip_discovery_profile_path (str or None) – PolicyPath of associated IP Discovery Profile
mac_discovery_profile_path (str or None) – PolicyPath of associated Mac Discovery Profile

class com.vmware.nsx_policy.model_client.SegmentDiscoveryProfileBindingMapListResult(links=None, schema=None, self_=None, cursor=None, result_count=None, sort_ascending=None, sort_by=None, results=None)¶

Bases: vmware.vapi.bindings.struct.VapiStruct

Paged collection of Segment Discovery Profile Binding Maps

Tip

The arguments are used to initialize data attributes with the same names.

Parameters

links (list of ResourceLink or None) – The server will populate this field when returing the resource. Ignored on PUT and POST. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
schema (str or None) – Schema for this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
self (SelfResourceLink or None) – Link to this resource
cursor (str or None) – Opaque cursor to be used for getting next page of records (supplied by current result page) This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
result_count (long or None) – Count of results found (across all pages), set only on first page format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
sort_ascending (bool or None) – If true, results are sorted in ascending order This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
sort_by (str or None) – Field by which records are sorted This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
results (list of SegmentDiscoveryProfileBindingMap) – Segment Discovery Profile Binding Map list results

class com.vmware.nsx_policy.model_client.SegmentListResult(links=None, schema=None, self_=None, cursor=None, result_count=None, sort_ascending=None, sort_by=None, results=None)¶

Bases: vmware.vapi.bindings.struct.VapiStruct

Paged collection of Segments

Tip

The arguments are used to initialize data attributes with the same names.

Parameters

links (list of ResourceLink or None) – The server will populate this field when returing the resource. Ignored on PUT and POST. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
schema (str or None) – Schema for this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
self (SelfResourceLink or None) – Link to this resource
cursor (str or None) – Opaque cursor to be used for getting next page of records (supplied by current result page) This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
result_count (long or None) – Count of results found (across all pages), set only on first page format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
sort_ascending (bool or None) – If true, results are sorted in ascending order This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
sort_by (str or None) – Field by which records are sorted This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
results (list of Segment) – Segment list results

class com.vmware.nsx_policy.model_client.SegmentMonitoringProfileBindingMap(links=None, schema=None, self_=None, revision=None, create_time=None, create_user=None, last_modified_time=None, last_modified_user=None, protection=None, system_owned=None, description=None, display_name=None, id=None, resource_type=None, tags=None, parent_path=None, path=None, relative_path=None, children=None, marked_for_delete=None, ipfix_l2_profile_path=None, port_mirroring_profile_path=None)¶

Bases: vmware.vapi.bindings.struct.VapiStruct

This entity will be used to establish association between monitoring profile and Segment. Using this entity, you can specify intent for applying monitoring profile to particular segment.

Tip

The arguments are used to initialize data attributes with the same names.

Parameters

links (list of ResourceLink or None) – The server will populate this field when returing the resource. Ignored on PUT and POST. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
schema (str or None) – Schema for this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
self (SelfResourceLink or None) – Link to this resource
revision (long or None) – The _revision property describes the current revision of the resource. To prevent clients from overwriting each other’s changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected. format: int32
create_time (long or None) – Timestamp of resource creation format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
create_user (str or None) – ID of the user who created this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
last_modified_time (long or None) – Timestamp of last modification format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
last_modified_user (str or None) – ID of the user who last modified this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
protection (str or None) – Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super user and can modify it, but only when providing the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this entity. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
system_owned (bool or None) – Indicates system owned resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
description (str or None) – Description of this resource
display_name (str or None) – Defaults to ID if not set
id (str or None) – Unique identifier of this resource
resource_type (str or None) – The type of this resource.
tags (list of Tag or None) – Opaque identifiers meaningful to the API user
parent_path (str or None) – Path of its parent This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
path (str or None) – Absolute path of this object This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
relative_path (str or None) – Path relative from its parent This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
children (list of vmware.vapi.struct.VapiStruct or None) – subtree for this type within policy tree containing nested elements. When clients pass a value of this class as a parameter, the attribute must contain all the attributes defined in ChildPolicyConfigResource. When methods return a value of this class as a return value, the attribute will contain all the attributes defined in ChildPolicyConfigResource.
marked_for_delete (bool or None) – Intent objects are not directly deleted from the system when a delete is invoked on them. They are marked for deletion and only when all the realized entities for that intent object gets deleted, the intent object is deleted. Objects that are marked for deletion are not returned in GET call. One can use the search API to get these objects. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
ipfix_l2_profile_path (str or None) – PolicyPath of associated IPFIX L2 Profile
port_mirroring_profile_path (str or None) – PolicyPath of associated Port Mirroring Profile

class com.vmware.nsx_policy.model_client.SegmentMonitoringProfileBindingMapListResult(links=None, schema=None, self_=None, cursor=None, result_count=None, sort_ascending=None, sort_by=None, results=None)¶

Bases: vmware.vapi.bindings.struct.VapiStruct

Paged collection of Segment Monitoring Profile Binding Maps

Tip

The arguments are used to initialize data attributes with the same names.

Parameters

links (list of ResourceLink or None) – The server will populate this field when returing the resource. Ignored on PUT and POST. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
schema (str or None) – Schema for this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
self (SelfResourceLink or None) – Link to this resource
cursor (str or None) – Opaque cursor to be used for getting next page of records (supplied by current result page) This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
result_count (long or None) – Count of results found (across all pages), set only on first page format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
sort_ascending (bool or None) – If true, results are sorted in ascending order This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
sort_by (str or None) – Field by which records are sorted This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
results (list of SegmentMonitoringProfileBindingMap) – Segment Monitoring Profile Binding Map list results

class com.vmware.nsx_policy.model_client.SegmentPort(links=None, schema=None, self_=None, revision=None, create_time=None, create_user=None, last_modified_time=None, last_modified_user=None, protection=None, system_owned=None, description=None, display_name=None, id=None, resource_type=None, tags=None, parent_path=None, path=None, relative_path=None, children=None, marked_for_delete=None, address_bindings=None, attachment=None)¶

Bases: vmware.vapi.bindings.struct.VapiStruct

Policy port will create LogicalPort on LogicalSwitch corresponding to the Segment.

Tip

The arguments are used to initialize data attributes with the same names.

Parameters

links (list of ResourceLink or None) – The server will populate this field when returing the resource. Ignored on PUT and POST. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
schema (str or None) – Schema for this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
self (SelfResourceLink or None) – Link to this resource
revision (long or None) – The _revision property describes the current revision of the resource. To prevent clients from overwriting each other’s changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected. format: int32
create_time (long or None) – Timestamp of resource creation format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
create_user (str or None) – ID of the user who created this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
last_modified_time (long or None) – Timestamp of last modification format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
last_modified_user (str or None) – ID of the user who last modified this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
protection (str or None) – Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super user and can modify it, but only when providing the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this entity. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
system_owned (bool or None) – Indicates system owned resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
description (str or None) – Description of this resource
display_name (str or None) – Defaults to ID if not set
id (str or None) – Unique identifier of this resource
resource_type (str or None) – The type of this resource.
tags (list of Tag or None) – Opaque identifiers meaningful to the API user
parent_path (str or None) – Path of its parent This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
path (str or None) – Absolute path of this object This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
relative_path (str or None) – Path relative from its parent This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
children (list of vmware.vapi.struct.VapiStruct or None) – subtree for this type within policy tree containing nested elements. When clients pass a value of this class as a parameter, the attribute must contain all the attributes defined in ChildPolicyConfigResource. When methods return a value of this class as a return value, the attribute will contain all the attributes defined in ChildPolicyConfigResource.
marked_for_delete (bool or None) – Intent objects are not directly deleted from the system when a delete is invoked on them. They are marked for deletion and only when all the realized entities for that intent object gets deleted, the intent object is deleted. Objects that are marked for deletion are not returned in GET call. One can use the search API to get these objects. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
address_bindings (list of PortAddressBindingEntry or None) – Static address binding used for the port.
attachment (PortAttachment or None) – Only VIF attachment is supported

class com.vmware.nsx_policy.model_client.SegmentPortListResult(links=None, schema=None, self_=None, cursor=None, result_count=None, sort_ascending=None, sort_by=None, results=None)¶

Bases: vmware.vapi.bindings.struct.VapiStruct

List SegmentPort objects

Tip

The arguments are used to initialize data attributes with the same names.

Parameters

links (list of ResourceLink or None) – The server will populate this field when returing the resource. Ignored on PUT and POST. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
schema (str or None) – Schema for this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
self (SelfResourceLink or None) – Link to this resource
cursor (str or None) – Opaque cursor to be used for getting next page of records (supplied by current result page) This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
result_count (long or None) – Count of results found (across all pages), set only on first page format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
sort_ascending (bool or None) – If true, results are sorted in ascending order This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
sort_by (str or None) – Field by which records are sorted This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
results (list of SegmentPort) – Place holder for the list result

class com.vmware.nsx_policy.model_client.SegmentPortStatistics(rx_bytes=None, rx_packets=None, tx_bytes=None, tx_packets=None, dropped_by_security_packets=None, mac_learning=None, last_update_timestamp=None, logical_port_id=None)¶

Bases: vmware.vapi.bindings.struct.VapiStruct

Segment port statistics on specific Enforcement Point.

Tip

The arguments are used to initialize data attributes with the same names.

Parameters

rx_bytes (DataCounter or None) –
rx_packets (DataCounter or None) –
tx_bytes (DataCounter or None) –
tx_packets (DataCounter or None) –
dropped_by_security_packets (PacketsDroppedBySecurity or None) –
mac_learning (MacLearningCounters or None) –
last_update_timestamp (long or None) – Timestamp when the data was last updated; unset if data source has never updated the data. format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
logical_port_id (str or None) – The id of the logical port This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.

class com.vmware.nsx_policy.model_client.SegmentQosProfileBindingMap(links=None, schema=None, self_=None, revision=None, create_time=None, create_user=None, last_modified_time=None, last_modified_user=None, protection=None, system_owned=None, description=None, display_name=None, id=None, resource_type=None, tags=None, parent_path=None, path=None, relative_path=None, children=None, marked_for_delete=None, qos_profile_path=None)¶

Bases: vmware.vapi.bindings.struct.VapiStruct

This entity will be used to establish association between qos profile and Segment. Using this entity, you can specify intent for applying qos profile to particular segment.

Tip

The arguments are used to initialize data attributes with the same names.

Parameters

links (list of ResourceLink or None) – The server will populate this field when returing the resource. Ignored on PUT and POST. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
schema (str or None) – Schema for this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
self (SelfResourceLink or None) – Link to this resource
revision (long or None) – The _revision property describes the current revision of the resource. To prevent clients from overwriting each other’s changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected. format: int32
create_time (long or None) – Timestamp of resource creation format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
create_user (str or None) – ID of the user who created this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
last_modified_time (long or None) – Timestamp of last modification format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
last_modified_user (str or None) – ID of the user who last modified this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
protection (str or None) – Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super user and can modify it, but only when providing the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this entity. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
system_owned (bool or None) – Indicates system owned resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
description (str or None) – Description of this resource
display_name (str or None) – Defaults to ID if not set
id (str or None) – Unique identifier of this resource
resource_type (str or None) – The type of this resource.
tags (list of Tag or None) – Opaque identifiers meaningful to the API user
parent_path (str or None) – Path of its parent This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
path (str or None) – Absolute path of this object This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
relative_path (str or None) – Path relative from its parent This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
children (list of vmware.vapi.struct.VapiStruct or None) – subtree for this type within policy tree containing nested elements. When clients pass a value of this class as a parameter, the attribute must contain all the attributes defined in ChildPolicyConfigResource. When methods return a value of this class as a return value, the attribute will contain all the attributes defined in ChildPolicyConfigResource.
marked_for_delete (bool or None) – Intent objects are not directly deleted from the system when a delete is invoked on them. They are marked for deletion and only when all the realized entities for that intent object gets deleted, the intent object is deleted. Objects that are marked for deletion are not returned in GET call. One can use the search API to get these objects. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
qos_profile_path (str or None) – PolicyPath of associated QoS Profile

class com.vmware.nsx_policy.model_client.SegmentQosProfileBindingMapListResult(links=None, schema=None, self_=None, cursor=None, result_count=None, sort_ascending=None, sort_by=None, results=None)¶

Bases: vmware.vapi.bindings.struct.VapiStruct

Paged collection of Segment QoS Profile Binding Maps

Tip

The arguments are used to initialize data attributes with the same names.

Parameters

links (list of ResourceLink or None) – The server will populate this field when returing the resource. Ignored on PUT and POST. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
schema (str or None) – Schema for this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
self (SelfResourceLink or None) – Link to this resource
cursor (str or None) – Opaque cursor to be used for getting next page of records (supplied by current result page) This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
result_count (long or None) – Count of results found (across all pages), set only on first page format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
sort_ascending (bool or None) – If true, results are sorted in ascending order This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
sort_by (str or None) – Field by which records are sorted This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
results (list of SegmentQosProfileBindingMap) – Segment QoS Profile Binding Map list results

class com.vmware.nsx_policy.model_client.SegmentSecurityProfile(links=None, schema=None, self_=None, revision=None, create_time=None, create_user=None, last_modified_time=None, last_modified_user=None, protection=None, system_owned=None, description=None, display_name=None, id=None, resource_type=None, tags=None, parent_path=None, path=None, relative_path=None, children=None, marked_for_delete=None, bpdu_filter_allow=None, bpdu_filter_enable=None, dhcp_client_block_enabled=None, dhcp_client_block_v6_enabled=None, dhcp_server_block_enabled=None, dhcp_server_block_v6_enabled=None, non_ip_traffic_block_enabled=None, ra_guard_enabled=None, rate_limits=None, rate_limits_enabled=None)¶

Bases: vmware.vapi.bindings.struct.VapiStruct

Security features extended by policy operations for securing logical segments.

Tip

The arguments are used to initialize data attributes with the same names.

Parameters

links (list of ResourceLink or None) – The server will populate this field when returing the resource. Ignored on PUT and POST. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
schema (str or None) – Schema for this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
self (SelfResourceLink or None) – Link to this resource
revision (long or None) – The _revision property describes the current revision of the resource. To prevent clients from overwriting each other’s changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected. format: int32
create_time (long or None) – Timestamp of resource creation format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
create_user (str or None) – ID of the user who created this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
last_modified_time (long or None) – Timestamp of last modification format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
last_modified_user (str or None) – ID of the user who last modified this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
protection (str or None) – Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super user and can modify it, but only when providing the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this entity. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
system_owned (bool or None) – Indicates system owned resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
description (str or None) – Description of this resource
display_name (str or None) – Defaults to ID if not set
id (str or None) – Unique identifier of this resource
resource_type (str or None) – The type of this resource.
tags (list of Tag or None) – Opaque identifiers meaningful to the API user
parent_path (str or None) – Path of its parent This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
path (str or None) – Absolute path of this object This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
relative_path (str or None) – Path relative from its parent This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
children (list of vmware.vapi.struct.VapiStruct or None) – subtree for this type within policy tree containing nested elements. When clients pass a value of this class as a parameter, the attribute must contain all the attributes defined in ChildPolicyConfigResource. When methods return a value of this class as a return value, the attribute will contain all the attributes defined in ChildPolicyConfigResource.
marked_for_delete (bool or None) – Intent objects are not directly deleted from the system when a delete is invoked on them. They are marked for deletion and only when all the realized entities for that intent object gets deleted, the intent object is deleted. Objects that are marked for deletion are not returned in GET call. One can use the search API to get these objects. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
bpdu_filter_allow (list of str or None) – Pre-defined list of allowed MAC addresses to be excluded from BPDU filtering. List of allowed MACs - 01:80:c2:00:00:00, 01:80:c2:00:00:01, 01:80:c2:00:00:02, 01:80:c2:00:00:03, 01:80:c2:00:00:04, 01:80:c2:00:00:05, 01:80:c2:00:00:06, 01:80:c2:00:00:07, 01:80:c2:00:00:08, 01:80:c2:00:00:09, 01:80:c2:00:00:0a, 01:80:c2:00:00:0b, 01:80:c2:00:00:0c, 01:80:c2:00:00:0d, 01:80:c2:00:00:0e, 01:80:c2:00:00:0f, 00:e0:2b:00:00:00, 00:e0:2b:00:00:04, 00:e0:2b:00:00:06, 01:00:0c:00:00:00, 01:00:0c:cc:cc:cc, 01:00:0c:cc:cc:cd, 01:00:0c:cd:cd:cd, 01:00:0c:cc:cc:c0, 01:00:0c:cc:cc:c1, 01:00:0c:cc:cc:c2, 01:00:0c:cc:cc:c3, 01:00:0c:cc:cc:c4, 01:00:0c:cc:cc:c5, 01:00:0c:cc:cc:c6, 01:00:0c:cc:cc:c7
bpdu_filter_enable (bool or None) – Indicates whether BPDU filter is enabled. BPDU filtering is enabled by default.
dhcp_client_block_enabled (bool or None) – Filters DHCP server and/or client traffic. DHCP server blocking is enabled and client blocking is disabled by default.
dhcp_client_block_v6_enabled (bool or None) – Filters DHCP server and/or client IPv6 traffic. DHCP server blocking is enabled and client blocking is disabled by default.
dhcp_server_block_enabled (bool or None) – Filters DHCP server and/or client traffic. DHCP server blocking is enabled and client blocking is disabled by default.
dhcp_server_block_v6_enabled (bool or None) – Filters DHCP server and/or client IPv6 traffic. DHCP server blocking is enabled and client blocking is disabled by default.
non_ip_traffic_block_enabled (bool or None) – A flag to block all traffic except IP/(G)ARP/BPDU.
ra_guard_enabled (bool or None) – Enable or disable Router Advertisement Guard.
rate_limits (TrafficRateLimits or None) – Allows configuration of rate limits for broadcast and multicast traffic. Rate limiting is disabled by default
rate_limits_enabled (bool or None) – Enable or disable Rate Limits

class com.vmware.nsx_policy.model_client.SegmentSecurityProfileBindingMap(links=None, schema=None, self_=None, revision=None, create_time=None, create_user=None, last_modified_time=None, last_modified_user=None, protection=None, system_owned=None, description=None, display_name=None, id=None, resource_type=None, tags=None, parent_path=None, path=None, relative_path=None, children=None, marked_for_delete=None, segment_security_profile_path=None, spoofguard_profile_path=None)¶

Bases: vmware.vapi.bindings.struct.VapiStruct

Contains the binding relationship between segment and security profile.

Tip

The arguments are used to initialize data attributes with the same names.

Parameters

links (list of ResourceLink or None) – The server will populate this field when returing the resource. Ignored on PUT and POST. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
schema (str or None) – Schema for this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
self (SelfResourceLink or None) – Link to this resource
revision (long or None) – The _revision property describes the current revision of the resource. To prevent clients from overwriting each other’s changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected. format: int32
create_time (long or None) – Timestamp of resource creation format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
create_user (str or None) – ID of the user who created this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
last_modified_time (long or None) – Timestamp of last modification format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
last_modified_user (str or None) – ID of the user who last modified this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
protection (str or None) – Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super user and can modify it, but only when providing the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this entity. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
system_owned (bool or None) – Indicates system owned resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
description (str or None) – Description of this resource
display_name (str or None) – Defaults to ID if not set
id (str or None) – Unique identifier of this resource
resource_type (str or None) – The type of this resource.
tags (list of Tag or None) – Opaque identifiers meaningful to the API user
parent_path (str or None) – Path of its parent This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
path (str or None) – Absolute path of this object This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
relative_path (str or None) – Path relative from its parent This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
children (list of vmware.vapi.struct.VapiStruct or None) – subtree for this type within policy tree containing nested elements. When clients pass a value of this class as a parameter, the attribute must contain all the attributes defined in ChildPolicyConfigResource. When methods return a value of this class as a return value, the attribute will contain all the attributes defined in ChildPolicyConfigResource.
marked_for_delete (bool or None) – Intent objects are not directly deleted from the system when a delete is invoked on them. They are marked for deletion and only when all the realized entities for that intent object gets deleted, the intent object is deleted. Objects that are marked for deletion are not returned in GET call. One can use the search API to get these objects. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
segment_security_profile_path (str or None) – The policy path of the asscociated Segment Security profile
spoofguard_profile_path (str or None) – The policy path of the asscociated SpoofGuard profile

class com.vmware.nsx_policy.model_client.SegmentSecurityProfileBindingMapListResult(links=None, schema=None, self_=None, cursor=None, result_count=None, sort_ascending=None, sort_by=None, results=None)¶

Bases: vmware.vapi.bindings.struct.VapiStruct

Paged collection of segment security profile binding maps

Tip

The arguments are used to initialize data attributes with the same names.

Parameters

links (list of ResourceLink or None) – The server will populate this field when returing the resource. Ignored on PUT and POST. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
schema (str or None) – Schema for this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
self (SelfResourceLink or None) – Link to this resource
cursor (str or None) – Opaque cursor to be used for getting next page of records (supplied by current result page) This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
result_count (long or None) – Count of results found (across all pages), set only on first page format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
sort_ascending (bool or None) – If true, results are sorted in ascending order This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
sort_by (str or None) – Field by which records are sorted This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
results (list of SegmentSecurityProfileBindingMap) – Segment security profile binding map list results

class com.vmware.nsx_policy.model_client.SegmentSecurityProfileListResult(links=None, schema=None, self_=None, cursor=None, result_count=None, sort_ascending=None, sort_by=None, results=None)¶

Bases: vmware.vapi.bindings.struct.VapiStruct

Paged collection of segment security profiles

Tip

The arguments are used to initialize data attributes with the same names.

Parameters

links (list of ResourceLink or None) – The server will populate this field when returing the resource. Ignored on PUT and POST. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
schema (str or None) – Schema for this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
self (SelfResourceLink or None) – Link to this resource
cursor (str or None) – Opaque cursor to be used for getting next page of records (supplied by current result page) This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
result_count (long or None) – Count of results found (across all pages), set only on first page format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
sort_ascending (bool or None) – If true, results are sorted in ascending order This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
sort_by (str or None) – Field by which records are sorted This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
results (list of SegmentSecurityProfile) – Segment Security profile list results

class com.vmware.nsx_policy.model_client.SegmentStatistics(rx_bytes=None, rx_packets=None, tx_bytes=None, tx_packets=None, dropped_by_security_packets=None, mac_learning=None, last_update_timestamp=None, logical_switch_id=None)¶

Bases: vmware.vapi.bindings.struct.VapiStruct

Segment statistics on specific Enforcement Point.

Tip

The arguments are used to initialize data attributes with the same names.

Parameters

rx_bytes (DataCounter or None) –
rx_packets (DataCounter or None) –
tx_bytes (DataCounter or None) –
tx_packets (DataCounter or None) –
dropped_by_security_packets (PacketsDroppedBySecurity or None) –
mac_learning (MacLearningCounters or None) –
last_update_timestamp (long or None) – Timestamp when the data was last updated; unset if data source has never updated the data. format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
logical_switch_id (str or None) – The id of the logical Switch This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.

class com.vmware.nsx_policy.model_client.SegmentSubnet(dhcp_ranges=None, gateway_address=None, network=None)¶

Bases: vmware.vapi.bindings.struct.VapiStruct

Subnet configuration for segment

Tip

The arguments are used to initialize data attributes with the same names.

Parameters

dhcp_ranges (list of str or None) – DHCP address ranges are used for dynamic IP allocation. Supports address range and CIDR formats. First valid host address from the first value is assigned to DHCP server IP address. Existing values cannot be deleted or modified, but additional DHCP ranges can be added. format: address-or-block-or-range
gateway_address (str or None) – Gateway IP address in CIDR format for both IPv4 and IPv6. format: ip-cidr-block
network (str or None) – Network CIDR for this subnet calculated from gateway_addresses and prefix_len. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.

class com.vmware.nsx_policy.model_client.SelfResourceLink(action=None, href=None, rel=None)¶

Bases: vmware.vapi.bindings.struct.VapiStruct

The server will populate this field when returing the resource. Ignored on PUT and POST.

Tip

The arguments are used to initialize data attributes with the same names.

Parameters

action (str or None) – Optional action This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
href (str or None) – Link to resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
rel (str or None) – Custom relation type (follows RFC 5988 where appropriate definitions exist) This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.

class com.vmware.nsx_policy.model_client.Service(links=None, schema=None, self_=None, revision=None, create_time=None, create_user=None, last_modified_time=None, last_modified_user=None, protection=None, system_owned=None, description=None, display_name=None, id=None, resource_type=None, tags=None, parent_path=None, path=None, relative_path=None, children=None, marked_for_delete=None, is_default=None, service_entries=None)¶

Bases: vmware.vapi.bindings.struct.VapiStruct

Used while defining a CommunicationEntry. A service may have multiple service entries.

Tip

The arguments are used to initialize data attributes with the same names.

Parameters

links (list of ResourceLink or None) – The server will populate this field when returing the resource. Ignored on PUT and POST. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
schema (str or None) – Schema for this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
self (SelfResourceLink or None) – Link to this resource
revision (long or None) – The _revision property describes the current revision of the resource. To prevent clients from overwriting each other’s changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected. format: int32
create_time (long or None) – Timestamp of resource creation format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
create_user (str or None) – ID of the user who created this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
last_modified_time (long or None) – Timestamp of last modification format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
last_modified_user (str or None) – ID of the user who last modified this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
protection (str or None) – Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super user and can modify it, but only when providing the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this entity. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
system_owned (bool or None) – Indicates system owned resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
description (str or None) – Description of this resource
display_name (str or None) – Defaults to ID if not set
id (str or None) – Unique identifier of this resource
resource_type (str or None) – The type of this resource.
tags (list of Tag or None) – Opaque identifiers meaningful to the API user
parent_path (str or None) – Path of its parent This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
path (str or None) – Absolute path of this object This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
relative_path (str or None) – Path relative from its parent This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
children (list of vmware.vapi.struct.VapiStruct or None) – subtree for this type within policy tree containing nested elements. When clients pass a value of this class as a parameter, the attribute must contain all the attributes defined in ChildPolicyConfigResource. When methods return a value of this class as a return value, the attribute will contain all the attributes defined in ChildPolicyConfigResource.
marked_for_delete (bool or None) – Intent objects are not directly deleted from the system when a delete is invoked on them. They are marked for deletion and only when all the realized entities for that intent object gets deleted, the intent object is deleted. Objects that are marked for deletion are not returned in GET call. One can use the search API to get these objects. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
is_default (bool or None) – The flag, if true, indicates that service is created in the system by default. Such default services can’t be modified/deleted. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
service_entries (list of vmware.vapi.struct.VapiStruct or None) – Service type When clients pass a value of this class as a parameter, the attribute must contain all the attributes defined in ServiceEntry. When methods return a value of this class as a return value, the attribute will contain all the attributes defined in ServiceEntry.

class com.vmware.nsx_policy.model_client.ServiceCapability(can_decrement_si=None, nsh_liveness_support_enabled=None)¶

Bases: vmware.vapi.bindings.struct.VapiStruct

Service capabilities that will be inherited by service VMs created using a service definition that contains this service capability.

Tip

The arguments are used to initialize data attributes with the same names.

Parameters

can_decrement_si (bool or None) – Indicating whether service is configured to decrement SI field in NSH metadata. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
nsh_liveness_support_enabled (bool or None) – Indicating whether service supports NSH liveness detection.

class com.vmware.nsx_policy.model_client.ServiceChainMapping(direction=None, service_chain_id=None, service_index=None)¶

Bases: vmware.vapi.bindings.struct.VapiStruct

A ServiceInsertionServiceProfile can be part of multiple ServiceChains. ServiceChainMapping for a particular profile will contain a list of all the ServiceChains it’s part of. Each Mapping will also contain some metadata to uniquely identify a profile from other profiles.

Tip

The arguments are used to initialize data attributes with the same names.

Parameters

direction (str or None) –
Possible values are:
- ServiceChainMapping.DIRECTION_FORWARD
- ServiceChainMapping.DIRECTION_REVERSE
Each ServiceChain has forward_path_service_profiles and reverse_path_service_profiles. This property will indicate which of them being used. FORWARD - forward_path_service_profiles REVERSE - reverse_path_service_profiles This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
service_chain_id (str or None) – A unique id generated for every ServiceChain. This is not a uuid. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
service_index (long or None) – Service Index represents a numerical position of a ServiceInsertionServiceProfile in a ServiceChain. It will be in reverse order. Service Index can point to either forward_path_service_profiles or reverse_path_service_profiles indicated by direction property. Example - For a ServiceChain A-B-C, A will have index of 3, B will have index of 2 and C will have index of 1. format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.

DIRECTION_FORWARD = 'FORWARD'¶

DIRECTION_REVERSE = 'REVERSE'¶

class com.vmware.nsx_policy.model_client.ServiceChainMappingListResult(links=None, schema=None, self_=None, cursor=None, result_count=None, sort_ascending=None, sort_by=None, results=None)¶

Bases: vmware.vapi.bindings.struct.VapiStruct

Service Chain Mapping List

Tip

The arguments are used to initialize data attributes with the same names.

Parameters

links (list of ResourceLink or None) – The server will populate this field when returing the resource. Ignored on PUT and POST. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
schema (str or None) – Schema for this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
self (SelfResourceLink or None) – Link to this resource
cursor (str or None) – Opaque cursor to be used for getting next page of records (supplied by current result page) This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
result_count (long or None) – Count of results found (across all pages), set only on first page format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
sort_ascending (bool or None) – If true, results are sorted in ascending order This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
sort_by (str or None) – Field by which records are sorted This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
results (list of ServiceChainMapping or None) – List of the Service Chain Mappings. The list has to be homogenous. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.

class com.vmware.nsx_policy.model_client.ServiceDefinition(links=None, schema=None, self_=None, revision=None, create_time=None, create_user=None, last_modified_time=None, last_modified_user=None, protection=None, system_owned=None, description=None, display_name=None, id=None, resource_type=None, tags=None, attachment_point=None, functionalities=None, implementations=None, on_failure_policy=None, service_capability=None, service_deployment_spec=None, service_manager_id=None, transports=None, vendor_id=None)¶

Bases: vmware.vapi.bindings.struct.VapiStruct

Registering a Service is the first step in the ServiceInsertion mechanism. A ServiceDefinition is used to create a service.

Tip

The arguments are used to initialize data attributes with the same names.

Parameters

links (list of ResourceLink or None) – The server will populate this field when returing the resource. Ignored on PUT and POST. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
schema (str or None) – Schema for this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
self (SelfResourceLink or None) – Link to this resource
revision (long or None) – The _revision property describes the current revision of the resource. To prevent clients from overwriting each other’s changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected. format: int32
create_time (long or None) – Timestamp of resource creation format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
create_user (str or None) – ID of the user who created this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
last_modified_time (long or None) – Timestamp of last modification format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
last_modified_user (str or None) – ID of the user who last modified this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
protection (str or None) – Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super user and can modify it, but only when providing the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this entity. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
system_owned (bool or None) – Indicates system owned resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
description (str or None) – Description of this resource
display_name (str or None) – Defaults to ID if not set
id (str or None) – Unique identifier of this resource
resource_type (str or None) – The type of this resource.
tags (list of Tag or None) – Opaque identifiers meaningful to the API user
attachment_point (list of str or None) –
Possible values are:
- ServiceDefinition.ATTACHMENT_POINT_TIER0_LR
- ServiceDefinition.ATTACHMENT_POINT_TIER1_LR
- ServiceDefinition.ATTACHMENT_POINT_SERVICE_PLANE
The point at which the service is deployed/attached for redirecting the traffic to the the partner appliance. Attachment Point is required if Service caters to any functionality other than EPP.
functionalities (list of str) –
Possible values are:
- ServiceDefinition.FUNCTIONALITIES_NG_FW
- ServiceDefinition.FUNCTIONALITIES_IDS_IPS
- ServiceDefinition.FUNCTIONALITIES_NET_MON
- ServiceDefinition.FUNCTIONALITIES_HCX
- ServiceDefinition.FUNCTIONALITIES_BYOD
- ServiceDefinition.FUNCTIONALITIES_EPP
The capabilities provided by the services. Needs to be one or more of the following | NG_FW - Next Generation Firewall | IDS_IPS - Intrusion detection System / Intrusion Prevention System | NET_MON - Network Monitoring | HCX - Hybrid Cloud Exchange | BYOD - Bring Your Own Device | EPP - Endpoint Protection.(Third party AntiVirus partners using NXGI should use this functionality for the service)
implementations (list of str) –
Possible values are:
- ServiceDefinition.IMPLEMENTATIONS_NORTH_SOUTH
- ServiceDefinition.IMPLEMENTATIONS_EAST_WEST
This indicates the insertion point of the service i.e whether the service will be used to protect North-South or East-West traffic in the datacenter.
on_failure_policy (str or None) –
Possible values are:
- ServiceDefinition.ON_FAILURE_POLICY_ALLOW
- ServiceDefinition.ON_FAILURE_POLICY_BLOCK
Failure policy for the service tells datapath, the action to take i.e to Allow or Block traffic during failure scenarios. For north-south ServiceInsertion, failure policy in the service instance takes precedence. For east-west ServiceInsertion, failure policy in the service chain takes precedence. BLOCK is not supported for Endpoint protection (EPP) functionality.
service_capability (ServiceCapability or None) – Service capability.
service_deployment_spec (ServiceDeploymentSpec or None) – Service Deployment Specification defines takes in information required to deploy and configure a partner appliance/service-vm.
service_manager_id (str or None) – ID of the service manager to which this service is attached with. This field is not set during creation of service. This field will be set explicitly when Service Manager is created successfully using this service. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
transports (list of str or None) –
Possible values are:
- ServiceDefinition.TRANSPORTS_L2_BRIDGE
- ServiceDefinition.TRANSPORTS_L3_ROUTED
- ServiceDefinition.TRANSPORTS_NSH
Transport Type of the service, which is the mechanism of redirecting the traffic to the the partner appliance. Transport type is required if Service caters to any functionality other than EPP.
vendor_id (str) – Id which is unique to a vendor or partner for which the service is created.

ATTACHMENT_POINT_SERVICE_PLANE = 'SERVICE_PLANE'¶

ATTACHMENT_POINT_TIER0_LR = 'TIER0_LR'¶

ATTACHMENT_POINT_TIER1_LR = 'TIER1_LR'¶

FUNCTIONALITIES_BYOD = 'BYOD'¶

FUNCTIONALITIES_EPP = 'EPP'¶

FUNCTIONALITIES_HCX = 'HCX'¶

FUNCTIONALITIES_IDS_IPS = 'IDS_IPS'¶

FUNCTIONALITIES_NET_MON = 'NET_MON'¶

FUNCTIONALITIES_NG_FW = 'NG_FW'¶

IMPLEMENTATIONS_EAST_WEST = 'EAST_WEST'¶

IMPLEMENTATIONS_NORTH_SOUTH = 'NORTH_SOUTH'¶

ON_FAILURE_POLICY_ALLOW = 'ALLOW'¶

ON_FAILURE_POLICY_BLOCK = 'BLOCK'¶

TRANSPORTS_L2_BRIDGE = 'L2_BRIDGE'¶

TRANSPORTS_L3_ROUTED = 'L3_ROUTED'¶

TRANSPORTS_NSH = 'NSH'¶

class com.vmware.nsx_policy.model_client.ServiceDeploymentSpec(deployment_specs=None, deployment_template=None, nic_metadata_list=None, svm_version=None)¶

Bases: vmware.vapi.bindings.struct.VapiStruct

ServiceDeployment Spec consists of information required to deploy and configure the partner appliances. viz. Deployment template, deployment spec and NIC metatdata.

Tip

The arguments are used to initialize data attributes with the same names.

Parameters

deployment_specs (list of SVMDeploymentSpec or None) – Deployment Specs holds information required to deploy the Service-VMs. i.e. OVF url where the partner Service-VM OVF is hosted. The host type on which the OVF can be deployed, Form factor to name a few.
deployment_template (list of DeploymentTemplate) – Deployment Template holds the attributes specific to partner for which the service is created. These attributes are opaque to NSX Manager.
nic_metadata_list (list of NicMetadata or None) – NIC metadata associated with the deployment spec.
svm_version (str or None) – Partner needs to specify the Service VM version which will get deployed. Modification of this field would notify administrators that new upgrade is available.

class com.vmware.nsx_policy.model_client.ServiceEntry(links=None, schema=None, self_=None, revision=None, create_time=None, create_user=None, last_modified_time=None, last_modified_user=None, protection=None, system_owned=None, description=None, display_name=None, id=None, resource_type='ServiceEntry', tags=None, parent_path=None, path=None, relative_path=None, children=None, marked_for_delete=None)¶

Bases: vmware.vapi.bindings.struct.VapiStruct

A Service entry that describes traffic

Tip

The arguments are used to initialize data attributes with the same names.

Parameters

links (list of ResourceLink or None) – The server will populate this field when returing the resource. Ignored on PUT and POST. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
schema (str or None) – Schema for this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
self (SelfResourceLink or None) – Link to this resource
revision (long or None) – The _revision property describes the current revision of the resource. To prevent clients from overwriting each other’s changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected. format: int32
create_time (long or None) – Timestamp of resource creation format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
create_user (str or None) – ID of the user who created this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
last_modified_time (long or None) – Timestamp of last modification format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
last_modified_user (str or None) – ID of the user who last modified this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
protection (str or None) – Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super user and can modify it, but only when providing the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this entity. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
system_owned (bool or None) – Indicates system owned resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
description (str or None) – Description of this resource
display_name (str or None) – Defaults to ID if not set
id (str or None) – Unique identifier of this resource
resource_type (str) –
Possible values are:
- ServiceEntry.RESOURCE_TYPE_IPPROTOCOLSERVICEENTRY
- ServiceEntry.RESOURCE_TYPE_IGMPTYPESERVICEENTRY
- ServiceEntry.RESOURCE_TYPE_ICMPTYPESERVICEENTRY
- ServiceEntry.RESOURCE_TYPE_ALGTYPESERVICEENTRY
- ServiceEntry.RESOURCE_TYPE_L4PORTSETSERVICEENTRY
- ServiceEntry.RESOURCE_TYPE_ETHERTYPESERVICEENTRY
tags (list of Tag or None) – Opaque identifiers meaningful to the API user
parent_path (str or None) – Path of its parent This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
path (str or None) – Absolute path of this object This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
relative_path (str or None) – Path relative from its parent This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
children (list of vmware.vapi.struct.VapiStruct or None) – subtree for this type within policy tree containing nested elements. When clients pass a value of this class as a parameter, the attribute must contain all the attributes defined in ChildPolicyConfigResource. When methods return a value of this class as a return value, the attribute will contain all the attributes defined in ChildPolicyConfigResource.
marked_for_delete (bool or None) – Intent objects are not directly deleted from the system when a delete is invoked on them. They are marked for deletion and only when all the realized entities for that intent object gets deleted, the intent object is deleted. Objects that are marked for deletion are not returned in GET call. One can use the search API to get these objects. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.

RESOURCE_TYPE_ALGTYPESERVICEENTRY = 'ALGTypeServiceEntry'¶

RESOURCE_TYPE_ETHERTYPESERVICEENTRY = 'EtherTypeServiceEntry'¶

RESOURCE_TYPE_ICMPTYPESERVICEENTRY = 'ICMPTypeServiceEntry'¶

RESOURCE_TYPE_IGMPTYPESERVICEENTRY = 'IGMPTypeServiceEntry'¶

RESOURCE_TYPE_IPPROTOCOLSERVICEENTRY = 'IPProtocolServiceEntry'¶

RESOURCE_TYPE_L4PORTSETSERVICEENTRY = 'L4PortSetServiceEntry'¶

property resource_type¶: Return the discriminator value

class com.vmware.nsx_policy.model_client.ServiceEntryListResult(links=None, schema=None, self_=None, cursor=None, result_count=None, sort_ascending=None, sort_by=None, results=None)¶

Bases: vmware.vapi.bindings.struct.VapiStruct

Paged Collection of Service entries

Tip

The arguments are used to initialize data attributes with the same names.

Parameters

links (list of ResourceLink or None) – The server will populate this field when returing the resource. Ignored on PUT and POST. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
schema (str or None) – Schema for this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
self (SelfResourceLink or None) – Link to this resource
cursor (str or None) – Opaque cursor to be used for getting next page of records (supplied by current result page) This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
result_count (long or None) – Count of results found (across all pages), set only on first page format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
sort_ascending (bool or None) – If true, results are sorted in ascending order This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
sort_by (str or None) – Field by which records are sorted This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
results (list of vmware.vapi.struct.VapiStruct) – Service entry list results When clients pass a value of this class as a parameter, the attribute must contain all the attributes defined in ServiceEntry. When methods return a value of this class as a return value, the attribute will contain all the attributes defined in ServiceEntry.

class com.vmware.nsx_policy.model_client.ServiceInsertionServiceListResult(links=None, schema=None, self_=None, cursor=None, result_count=None, sort_ascending=None, sort_by=None, results=None)¶

Bases: vmware.vapi.bindings.struct.VapiStruct

Service List

Tip

The arguments are used to initialize data attributes with the same names.

Parameters

links (list of ResourceLink or None) – The server will populate this field when returing the resource. Ignored on PUT and POST. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
schema (str or None) – Schema for this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
self (SelfResourceLink or None) – Link to this resource
cursor (str or None) – Opaque cursor to be used for getting next page of records (supplied by current result page) This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
result_count (long or None) – Count of results found (across all pages), set only on first page format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
sort_ascending (bool or None) – If true, results are sorted in ascending order This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
sort_by (str or None) – Field by which records are sorted This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
results (list of ServiceDefinition or None) – List of the Service-Insertion Services. The list has to be homogenous. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.

class com.vmware.nsx_policy.model_client.ServiceInstanceEndpoint(service_interface_path=None, links=None, schema=None, self_=None, revision=None, create_time=None, create_user=None, last_modified_time=None, last_modified_user=None, protection=None, system_owned=None, description=None, display_name=None, id=None, resource_type='ServiceInstanceEndpoint', tags=None, parent_path=None, path=None, relative_path=None, children=None, marked_for_delete=None, target_ips=None)¶

Bases: vmware.vapi.bindings.struct.VapiStruct

A ServiceInstanceEndpoint belongs to one ByodPolicyServiceInstance and is attached to one ServiceInterface. A ServiceInstanceEndpoint represents a redirection target for a RedirectionPolicy.

Tip

The arguments are used to initialize data attributes with the same names.

Parameters

service_interface_path (str) – Path of Service Interface to which this ServiceInstanceEndpoint is connected.
links (list of ResourceLink or None) – The server will populate this field when returing the resource. Ignored on PUT and POST. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
schema (str or None) – Schema for this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
self (SelfResourceLink or None) – Link to this resource
revision (long or None) – The _revision property describes the current revision of the resource. To prevent clients from overwriting each other’s changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected. format: int32
create_time (long or None) – Timestamp of resource creation format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
create_user (str or None) – ID of the user who created this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
last_modified_time (long or None) – Timestamp of last modification format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
last_modified_user (str or None) – ID of the user who last modified this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
protection (str or None) – Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super user and can modify it, but only when providing the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this entity. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
system_owned (bool or None) – Indicates system owned resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
description (str or None) – Description of this resource
display_name (str or None) – Defaults to ID if not set
id (str or None) – Unique identifier of this resource
resource_type (str) –
Possible values are:
- BaseEndpoint.RESOURCE_TYPE_VIRTUALENDPOINT
- BaseEndpoint.RESOURCE_TYPE_SERVICEINSTANCEENDPOINT
tags (list of Tag or None) – Opaque identifiers meaningful to the API user
parent_path (str or None) – Path of its parent This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
path (str or None) – Absolute path of this object This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
relative_path (str or None) – Path relative from its parent This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
children (list of vmware.vapi.struct.VapiStruct or None) – subtree for this type within policy tree containing nested elements. When clients pass a value of this class as a parameter, the attribute must contain all the attributes defined in ChildPolicyConfigResource. When methods return a value of this class as a return value, the attribute will contain all the attributes defined in ChildPolicyConfigResource.
marked_for_delete (bool or None) – Intent objects are not directly deleted from the system when a delete is invoked on them. They are marked for deletion and only when all the realized entities for that intent object gets deleted, the intent object is deleted. Objects that are marked for deletion are not returned in GET call. One can use the search API to get these objects. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
target_ips (list of IPInfo) – IPs where either inbound or outbound traffic is to be redirected.

property resource_type¶: Return the discriminator value

class com.vmware.nsx_policy.model_client.ServiceInstanceEndpointListResult(links=None, schema=None, self_=None, cursor=None, result_count=None, sort_ascending=None, sort_by=None, results=None)¶

Bases: vmware.vapi.bindings.struct.VapiStruct

Paged Collection of ServiceInstanceEndpoint

Tip

The arguments are used to initialize data attributes with the same names.

Parameters

links (list of ResourceLink or None) – The server will populate this field when returing the resource. Ignored on PUT and POST. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
schema (str or None) – Schema for this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
self (SelfResourceLink or None) – Link to this resource
cursor (str or None) – Opaque cursor to be used for getting next page of records (supplied by current result page) This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
result_count (long or None) – Count of results found (across all pages), set only on first page format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
sort_ascending (bool or None) – If true, results are sorted in ascending order This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
sort_by (str or None) – Field by which records are sorted This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
results (list of ServiceInstanceEndpoint) – ServiceInstanceEndpoint list results

class com.vmware.nsx_policy.model_client.ServiceInterface(links=None, schema=None, self_=None, revision=None, create_time=None, create_user=None, last_modified_time=None, last_modified_user=None, protection=None, system_owned=None, description=None, display_name=None, id=None, resource_type=None, tags=None, parent_path=None, path=None, relative_path=None, children=None, marked_for_delete=None, subnets=None)¶

Bases: vmware.vapi.bindings.struct.VapiStruct

Service interface configuration for internal connectivity.

Tip

The arguments are used to initialize data attributes with the same names.

Parameters

links (list of ResourceLink or None) – The server will populate this field when returing the resource. Ignored on PUT and POST. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
schema (str or None) – Schema for this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
self (SelfResourceLink or None) – Link to this resource
revision (long or None) – The _revision property describes the current revision of the resource. To prevent clients from overwriting each other’s changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected. format: int32
create_time (long or None) – Timestamp of resource creation format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
create_user (str or None) – ID of the user who created this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
last_modified_time (long or None) – Timestamp of last modification format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
last_modified_user (str or None) – ID of the user who last modified this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
protection (str or None) – Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super user and can modify it, but only when providing the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this entity. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
system_owned (bool or None) – Indicates system owned resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
description (str or None) – Description of this resource
display_name (str or None) – Defaults to ID if not set
id (str or None) – Unique identifier of this resource
resource_type (str or None) – The type of this resource.
tags (list of Tag or None) – Opaque identifiers meaningful to the API user
parent_path (str or None) – Path of its parent This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
path (str or None) – Absolute path of this object This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
relative_path (str or None) – Path relative from its parent This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
children (list of vmware.vapi.struct.VapiStruct or None) – subtree for this type within policy tree containing nested elements. When clients pass a value of this class as a parameter, the attribute must contain all the attributes defined in ChildPolicyConfigResource. When methods return a value of this class as a return value, the attribute will contain all the attributes defined in ChildPolicyConfigResource.
marked_for_delete (bool or None) – Intent objects are not directly deleted from the system when a delete is invoked on them. They are marked for deletion and only when all the realized entities for that intent object gets deleted, the intent object is deleted. Objects that are marked for deletion are not returned in GET call. One can use the search API to get these objects. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
subnets (list of InterfaceSubnet) – Specify IP address and network prefix for interface.

class com.vmware.nsx_policy.model_client.ServiceInterfaceListResult(links=None, schema=None, self_=None, cursor=None, result_count=None, sort_ascending=None, sort_by=None, results=None)¶

Bases: vmware.vapi.bindings.struct.VapiStruct

Paged collection of Service Interfaces

Tip

The arguments are used to initialize data attributes with the same names.

Parameters

links (list of ResourceLink or None) – The server will populate this field when returing the resource. Ignored on PUT and POST. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
schema (str or None) – Schema for this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
self (SelfResourceLink or None) – Link to this resource
cursor (str or None) – Opaque cursor to be used for getting next page of records (supplied by current result page) This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
result_count (long or None) – Count of results found (across all pages), set only on first page format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
sort_ascending (bool or None) – If true, results are sorted in ascending order This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
sort_by (str or None) – Field by which records are sorted This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
results (list of ServiceInterface) – Service Interface list results

class com.vmware.nsx_policy.model_client.ServiceListResult(links=None, schema=None, self_=None, cursor=None, result_count=None, sort_ascending=None, sort_by=None, results=None)¶

Bases: vmware.vapi.bindings.struct.VapiStruct

Paged Collection of Services

Tip

The arguments are used to initialize data attributes with the same names.

Parameters

links (list of ResourceLink or None) – The server will populate this field when returing the resource. Ignored on PUT and POST. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
schema (str or None) – Schema for this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
self (SelfResourceLink or None) – Link to this resource
cursor (str or None) – Opaque cursor to be used for getting next page of records (supplied by current result page) This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
result_count (long or None) – Count of results found (across all pages), set only on first page format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
sort_ascending (bool or None) – If true, results are sorted in ascending order This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
sort_by (str or None) – Field by which records are sorted This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
results (list of Service) – Service list results

class com.vmware.nsx_policy.model_client.ServiceProfileGroups(links=None, schema=None, self_=None, revision=None, create_time=None, create_user=None, last_modified_time=None, last_modified_user=None, protection=None, system_owned=None, description=None, display_name=None, id=None, resource_type=None, tags=None, groups=None)¶

Bases: vmware.vapi.bindings.struct.VapiStruct

ServiceProfileGroups contains list of Groups referenced in Service Insertion Rules.To be considered, Service profile must be part of a Service chain and that Service chain must be used in a Rule.

Tip

The arguments are used to initialize data attributes with the same names.

Parameters

links (list of ResourceLink or None) – The server will populate this field when returing the resource. Ignored on PUT and POST. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
schema (str or None) – Schema for this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
self (SelfResourceLink or None) – Link to this resource
revision (long or None) – The _revision property describes the current revision of the resource. To prevent clients from overwriting each other’s changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected. format: int32
create_time (long or None) – Timestamp of resource creation format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
create_user (str or None) – ID of the user who created this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
last_modified_time (long or None) – Timestamp of last modification format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
last_modified_user (str or None) – ID of the user who last modified this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
protection (str or None) – Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super user and can modify it, but only when providing the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this entity. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
system_owned (bool or None) – Indicates system owned resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
description (str or None) – Description of this resource
display_name (str or None) – Defaults to ID if not set
id (str or None) – Unique identifier of this resource
resource_type (str or None) – The type of this resource.
tags (list of Tag or None) – Opaque identifiers meaningful to the API user
groups (list of GroupInfo or None) – List of Groups Used in ServiceInsertion Rules. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.

class com.vmware.nsx_policy.model_client.ServiceReference(links=None, schema=None, self_=None, revision=None, create_time=None, create_user=None, last_modified_time=None, last_modified_user=None, protection=None, system_owned=None, description=None, display_name=None, id=None, resource_type=None, tags=None, parent_path=None, path=None, relative_path=None, children=None, marked_for_delete=None, enabled=None, partner_service_name=None)¶

Bases: vmware.vapi.bindings.struct.VapiStruct

An anchor object representing the intent to consume a given 3rd party service.

Tip

The arguments are used to initialize data attributes with the same names.

Parameters

links (list of ResourceLink or None) – The server will populate this field when returing the resource. Ignored on PUT and POST. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
schema (str or None) – Schema for this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
self (SelfResourceLink or None) – Link to this resource
revision (long or None) – The _revision property describes the current revision of the resource. To prevent clients from overwriting each other’s changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected. format: int32
create_time (long or None) – Timestamp of resource creation format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
create_user (str or None) – ID of the user who created this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
last_modified_time (long or None) – Timestamp of last modification format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
last_modified_user (str or None) – ID of the user who last modified this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
protection (str or None) – Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super user and can modify it, but only when providing the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this entity. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
system_owned (bool or None) – Indicates system owned resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
description (str or None) – Description of this resource
display_name (str or None) – Defaults to ID if not set
id (str or None) – Unique identifier of this resource
resource_type (str or None) – The type of this resource.
tags (list of Tag or None) – Opaque identifiers meaningful to the API user
parent_path (str or None) – Path of its parent This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
path (str or None) – Absolute path of this object This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
relative_path (str or None) – Path relative from its parent This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
children (list of vmware.vapi.struct.VapiStruct or None) – subtree for this type within policy tree containing nested elements. When clients pass a value of this class as a parameter, the attribute must contain all the attributes defined in ChildPolicyConfigResource. When methods return a value of this class as a return value, the attribute will contain all the attributes defined in ChildPolicyConfigResource.
marked_for_delete (bool or None) – Intent objects are not directly deleted from the system when a delete is invoked on them. They are marked for deletion and only when all the realized entities for that intent object gets deleted, the intent object is deleted. Objects that are marked for deletion are not returned in GET call. One can use the search API to get these objects. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
enabled (bool or None) – A Service’s operational state can be enabled or disabled. Note that would work only for NetX type of services and would not work for Guest Introsp- ection type of Services. TRUE - The Service should be enabled FALSE - The Service should be disabled
partner_service_name (str) – Unique name of Partner Service to be consumed for redirection.

class com.vmware.nsx_policy.model_client.ServiceSegment(links=None, schema=None, self_=None, revision=None, create_time=None, create_user=None, last_modified_time=None, last_modified_user=None, protection=None, system_owned=None, description=None, display_name=None, id=None, resource_type=None, tags=None, parent_path=None, path=None, relative_path=None, children=None, marked_for_delete=None, transport_zone_path=None)¶

Bases: vmware.vapi.bindings.struct.VapiStruct

Service Segment configuration to attach Service Insertion VM.

Tip

The arguments are used to initialize data attributes with the same names.

Parameters

links (list of ResourceLink or None) – The server will populate this field when returing the resource. Ignored on PUT and POST. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
schema (str or None) – Schema for this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
self (SelfResourceLink or None) – Link to this resource
revision (long or None) – The _revision property describes the current revision of the resource. To prevent clients from overwriting each other’s changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected. format: int32
create_time (long or None) – Timestamp of resource creation format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
create_user (str or None) – ID of the user who created this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
last_modified_time (long or None) – Timestamp of last modification format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
last_modified_user (str or None) – ID of the user who last modified this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
protection (str or None) – Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super user and can modify it, but only when providing the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this entity. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
system_owned (bool or None) – Indicates system owned resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
description (str or None) – Description of this resource
display_name (str or None) – Defaults to ID if not set
id (str or None) – Unique identifier of this resource
resource_type (str or None) – The type of this resource.
tags (list of Tag or None) – Opaque identifiers meaningful to the API user
parent_path (str or None) – Path of its parent This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
path (str or None) – Absolute path of this object This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
relative_path (str or None) – Path relative from its parent This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
children (list of vmware.vapi.struct.VapiStruct or None) – subtree for this type within policy tree containing nested elements. When clients pass a value of this class as a parameter, the attribute must contain all the attributes defined in ChildPolicyConfigResource. When methods return a value of this class as a return value, the attribute will contain all the attributes defined in ChildPolicyConfigResource.
marked_for_delete (bool or None) – Intent objects are not directly deleted from the system when a delete is invoked on them. They are marked for deletion and only when all the realized entities for that intent object gets deleted, the intent object is deleted. Objects that are marked for deletion are not returned in GET call. One can use the search API to get these objects. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
transport_zone_path (str) – Policy path to transport zone. Only overlay transport zone is supported.

class com.vmware.nsx_policy.model_client.ServiceSegmentListResult(links=None, schema=None, self_=None, cursor=None, result_count=None, sort_ascending=None, sort_by=None, results=None)¶

Bases: vmware.vapi.bindings.struct.VapiStruct

Paged collection of Service Segment

Tip

The arguments are used to initialize data attributes with the same names.

Parameters

links (list of ResourceLink or None) – The server will populate this field when returing the resource. Ignored on PUT and POST. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
schema (str or None) – Schema for this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
self (SelfResourceLink or None) – Link to this resource
cursor (str or None) – Opaque cursor to be used for getting next page of records (supplied by current result page) This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
result_count (long or None) – Count of results found (across all pages), set only on first page format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
sort_ascending (bool or None) – If true, results are sorted in ascending order This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
sort_by (str or None) – Field by which records are sorted This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
results (list of ServiceSegment) – Service Segment list results

class com.vmware.nsx_policy.model_client.SessionTimerProfileBindingListResult(links=None, schema=None, self_=None, cursor=None, result_count=None, sort_ascending=None, sort_by=None, results=None)¶

Bases: vmware.vapi.bindings.struct.VapiStruct

Paged Collection of session timer profile binding maps

Tip

The arguments are used to initialize data attributes with the same names.

Parameters

links (list of ResourceLink or None) – The server will populate this field when returing the resource. Ignored on PUT and POST. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
schema (str or None) – Schema for this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
self (SelfResourceLink or None) – Link to this resource
cursor (str or None) – Opaque cursor to be used for getting next page of records (supplied by current result page) This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
result_count (long or None) – Count of results found (across all pages), set only on first page format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
sort_ascending (bool or None) – If true, results are sorted in ascending order This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
sort_by (str or None) – Field by which records are sorted This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
results (list of SessionTimerProfileBindingMap) – Session timer profile binding maps list results

class com.vmware.nsx_policy.model_client.SessionTimerProfileBindingMap(links=None, schema=None, self_=None, revision=None, create_time=None, create_user=None, last_modified_time=None, last_modified_user=None, protection=None, system_owned=None, description=None, display_name=None, id=None, resource_type=None, tags=None, parent_path=None, path=None, relative_path=None, children=None, marked_for_delete=None, profile_path=None)¶

Bases: vmware.vapi.bindings.struct.VapiStruct

This entity will be used to establish association between Session Timer profile and Logical Routers.

Tip

The arguments are used to initialize data attributes with the same names.

Parameters

links (list of ResourceLink or None) – The server will populate this field when returing the resource. Ignored on PUT and POST. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
schema (str or None) – Schema for this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
self (SelfResourceLink or None) – Link to this resource
revision (long or None) – The _revision property describes the current revision of the resource. To prevent clients from overwriting each other’s changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected. format: int32
create_time (long or None) – Timestamp of resource creation format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
create_user (str or None) – ID of the user who created this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
last_modified_time (long or None) – Timestamp of last modification format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
last_modified_user (str or None) – ID of the user who last modified this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
protection (str or None) – Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super user and can modify it, but only when providing the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this entity. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
system_owned (bool or None) – Indicates system owned resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
description (str or None) – Description of this resource
display_name (str or None) – Defaults to ID if not set
id (str or None) – Unique identifier of this resource
resource_type (str or None) – The type of this resource.
tags (list of Tag or None) – Opaque identifiers meaningful to the API user
parent_path (str or None) – Path of its parent This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
path (str or None) – Absolute path of this object This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
relative_path (str or None) – Path relative from its parent This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
children (list of vmware.vapi.struct.VapiStruct or None) – subtree for this type within policy tree containing nested elements. When clients pass a value of this class as a parameter, the attribute must contain all the attributes defined in ChildPolicyConfigResource. When methods return a value of this class as a return value, the attribute will contain all the attributes defined in ChildPolicyConfigResource.
marked_for_delete (bool or None) – Intent objects are not directly deleted from the system when a delete is invoked on them. They are marked for deletion and only when all the realized entities for that intent object gets deleted, the intent object is deleted. Objects that are marked for deletion are not returned in GET call. One can use the search API to get these objects. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
profile_path (str) – PolicyPath of associated Profile

class com.vmware.nsx_policy.model_client.SetFields(field_settings=None, resource_type='SetFields')¶

Bases: vmware.vapi.bindings.struct.VapiStruct

Set Fields is an action to set fields of the source event.

Tip

The arguments are used to initialize data attributes with the same names.

Parameters

field_settings (list of FieldSetting or None) – Field Settings.
resource_type (str) –
Possible values are:
- Action.RESOURCE_TYPE_PATCHRESOURCES
- Action.RESOURCE_TYPE_SETFIELDS
Reaction Action resource type.

property resource_type¶: Return the discriminator value

class com.vmware.nsx_policy.model_client.Site(links=None, schema=None, self_=None, revision=None, create_time=None, create_user=None, last_modified_time=None, last_modified_user=None, protection=None, system_owned=None, description=None, display_name=None, id=None, resource_type=None, tags=None, parent_path=None, path=None, relative_path=None, children=None, marked_for_delete=None, enforcement_points=None)¶

Bases: vmware.vapi.bindings.struct.VapiStruct

Logical grouping of enforcement points

Tip

The arguments are used to initialize data attributes with the same names.

Parameters

links (list of ResourceLink or None) – The server will populate this field when returing the resource. Ignored on PUT and POST. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
schema (str or None) – Schema for this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
self (SelfResourceLink or None) – Link to this resource
revision (long or None) – The _revision property describes the current revision of the resource. To prevent clients from overwriting each other’s changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected. format: int32
create_time (long or None) – Timestamp of resource creation format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
create_user (str or None) – ID of the user who created this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
last_modified_time (long or None) – Timestamp of last modification format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
last_modified_user (str or None) – ID of the user who last modified this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
protection (str or None) – Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super user and can modify it, but only when providing the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this entity. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
system_owned (bool or None) – Indicates system owned resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
description (str or None) – Description of this resource
display_name (str or None) – Defaults to ID if not set
id (str or None) – Unique identifier of this resource
resource_type (str or None) – The type of this resource.
tags (list of Tag or None) – Opaque identifiers meaningful to the API user
parent_path (str or None) – Path of its parent This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
path (str or None) – Absolute path of this object This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
relative_path (str or None) – Path relative from its parent This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
children (list of vmware.vapi.struct.VapiStruct or None) – subtree for this type within policy tree containing nested elements. When clients pass a value of this class as a parameter, the attribute must contain all the attributes defined in ChildPolicyConfigResource. When methods return a value of this class as a return value, the attribute will contain all the attributes defined in ChildPolicyConfigResource.
marked_for_delete (bool or None) – Intent objects are not directly deleted from the system when a delete is invoked on them. They are marked for deletion and only when all the realized entities for that intent object gets deleted, the intent object is deleted. Objects that are marked for deletion are not returned in GET call. One can use the search API to get these objects. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
enforcement_points (list of EnforcementPoint or None) – Logical grouping of enforcement points

class com.vmware.nsx_policy.model_client.SiteListResult(links=None, schema=None, self_=None, cursor=None, result_count=None, sort_ascending=None, sort_by=None, results=None)¶

Bases: vmware.vapi.bindings.struct.VapiStruct

Paged Collection of Sites

Tip

The arguments are used to initialize data attributes with the same names.

Parameters

links (list of ResourceLink or None) – The server will populate this field when returing the resource. Ignored on PUT and POST. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
schema (str or None) – Schema for this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
self (SelfResourceLink or None) – Link to this resource
cursor (str or None) – Opaque cursor to be used for getting next page of records (supplied by current result page) This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
result_count (long or None) – Count of results found (across all pages), set only on first page format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
sort_ascending (bool or None) – If true, results are sorted in ascending order This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
sort_by (str or None) – Field by which records are sorted This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
results (list of Site) – Site

class com.vmware.nsx_policy.model_client.Source(resource_type='Source')¶

Bases: vmware.vapi.bindings.struct.VapiStruct

Source that is logically deemed to be the “object” upon which the Event in question initially occurred upon. The Source is responsible for providing information of the occurred event. Some example sources include: - Resource. - API.

Tip

The arguments are used to initialize data attributes with the same names.

Parameters

resource_type (str) –

Possible values are:

Source.RESOURCE_TYPE_RESOURCEOPERATION
Source.RESOURCE_TYPE_APIREQUESTBODY

Event Source resource type.

RESOURCE_TYPE_APIREQUESTBODY = 'ApiRequestBody'¶

RESOURCE_TYPE_RESOURCEOPERATION = 'ResourceOperation'¶

property resource_type¶: Return the discriminator value

class com.vmware.nsx_policy.model_client.SourceFieldEvaluation(expected=None, field_pointer=None, operator=None, resource_type='SourceFieldEvaluation')¶

Bases: vmware.vapi.bindings.struct.VapiStruct

Source Field Evaluation represents an evaluation on resource fields. A source field evaluation will be evaluated against an Event Source which is of type Resource Operation. For instance, the attribute constraint could be related to the necessity that one of the source fields equals one of the specified values.

Tip

The arguments are used to initialize data attributes with the same names.

Parameters

expected (list of str) – Expected values necessary to apply the specified operation on the source field value.
field_pointer (str) – Field in the form of a pointer, describing the location of the attribute within the source of the event.
operator (str) –
Possible values are:
- SourceFieldEvaluation.OPERATOR_EQ
- SourceFieldEvaluation.OPERATOR_NOT_EQ
Logical operator.
resource_type (str) –
Possible values are:
- Evaluation.RESOURCE_TYPE_SOURCEFIELDEVALUATION
Criterion Evaluation resource type.

OPERATOR_EQ = 'EQ'¶

OPERATOR_NOT_EQ = 'NOT_EQ'¶

property resource_type¶: Return the discriminator value

class com.vmware.nsx_policy.model_client.SpoofGuardProfile(links=None, schema=None, self_=None, revision=None, create_time=None, create_user=None, last_modified_time=None, last_modified_user=None, protection=None, system_owned=None, description=None, display_name=None, id=None, resource_type=None, tags=None, parent_path=None, path=None, relative_path=None, children=None, marked_for_delete=None, address_binding_whitelist=None)¶

Bases: vmware.vapi.bindings.struct.VapiStruct

SpoofGuard is a tool that is designed to prevent virtual machines in your environment from sending traffic with IP addresses which are not authorized to send traffic from. A SpoofGuard policy profile once enabled blocks the traffic determined to be spoofed.

Tip

The arguments are used to initialize data attributes with the same names.

Parameters

links (list of ResourceLink or None) – The server will populate this field when returing the resource. Ignored on PUT and POST. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
schema (str or None) – Schema for this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
self (SelfResourceLink or None) – Link to this resource
revision (long or None) – The _revision property describes the current revision of the resource. To prevent clients from overwriting each other’s changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected. format: int32
create_time (long or None) – Timestamp of resource creation format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
create_user (str or None) – ID of the user who created this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
last_modified_time (long or None) – Timestamp of last modification format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
last_modified_user (str or None) – ID of the user who last modified this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
protection (str or None) – Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super user and can modify it, but only when providing the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this entity. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
system_owned (bool or None) – Indicates system owned resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
description (str or None) – Description of this resource
display_name (str or None) – Defaults to ID if not set
id (str or None) – Unique identifier of this resource
resource_type (str or None) – The type of this resource.
tags (list of Tag or None) – Opaque identifiers meaningful to the API user
parent_path (str or None) – Path of its parent This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
path (str or None) – Absolute path of this object This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
relative_path (str or None) – Path relative from its parent This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
children (list of vmware.vapi.struct.VapiStruct or None) – subtree for this type within policy tree containing nested elements. When clients pass a value of this class as a parameter, the attribute must contain all the attributes defined in ChildPolicyConfigResource. When methods return a value of this class as a return value, the attribute will contain all the attributes defined in ChildPolicyConfigResource.
marked_for_delete (bool or None) – Intent objects are not directly deleted from the system when a delete is invoked on them. They are marked for deletion and only when all the realized entities for that intent object gets deleted, the intent object is deleted. Objects that are marked for deletion are not returned in GET call. One can use the search API to get these objects. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
address_binding_whitelist (bool) – If true, enable the SpoofGuard, which only allows VM sending traffic with the IPs in the whitelist.

class com.vmware.nsx_policy.model_client.SpoofGuardProfileListResult(links=None, schema=None, self_=None, cursor=None, result_count=None, sort_ascending=None, sort_by=None, results=None)¶

Bases: vmware.vapi.bindings.struct.VapiStruct

Paged collection of SpoofGuard profiles

Tip

The arguments are used to initialize data attributes with the same names.

Parameters

links (list of ResourceLink or None) – The server will populate this field when returing the resource. Ignored on PUT and POST. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
schema (str or None) – Schema for this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
self (SelfResourceLink or None) – Link to this resource
cursor (str or None) – Opaque cursor to be used for getting next page of records (supplied by current result page) This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
result_count (long or None) – Count of results found (across all pages), set only on first page format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
sort_ascending (bool or None) – If true, results are sorted in ascending order This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
sort_by (str or None) – Field by which records are sorted This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
results (list of SpoofGuardProfile) – SpoofGuard profile list results

class com.vmware.nsx_policy.model_client.SslTrustObjectData(links=None, schema=None, self_=None, revision=None, create_time=None, create_user=None, last_modified_time=None, last_modified_user=None, protection=None, system_owned=None, description=None, display_name=None, id=None, resource_type=None, tags=None, parent_path=None, path=None, relative_path=None, children=None, marked_for_delete=None, key_algo=None, passphrase=None, pem_encoded=None, private_key=None)¶

Bases: vmware.vapi.bindings.struct.VapiStruct

Tip

The arguments are used to initialize data attributes with the same names.

Parameters

links (list of ResourceLink or None) – The server will populate this field when returing the resource. Ignored on PUT and POST. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
schema (str or None) – Schema for this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
self (SelfResourceLink or None) – Link to this resource
revision (long or None) – The _revision property describes the current revision of the resource. To prevent clients from overwriting each other’s changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected. format: int32
create_time (long or None) – Timestamp of resource creation format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
create_user (str or None) – ID of the user who created this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
last_modified_time (long or None) – Timestamp of last modification format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
last_modified_user (str or None) – ID of the user who last modified this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
protection (str or None) – Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super user and can modify it, but only when providing the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this entity. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
system_owned (bool or None) – Indicates system owned resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
description (str or None) – Description of this resource
display_name (str or None) – Defaults to ID if not set
id (str or None) – Unique identifier of this resource
resource_type (str or None) – The type of this resource.
tags (list of Tag or None) – Opaque identifiers meaningful to the API user
parent_path (str or None) – Path of its parent This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
path (str or None) – Absolute path of this object This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
relative_path (str or None) – Path relative from its parent This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
children (list of vmware.vapi.struct.VapiStruct or None) – subtree for this type within policy tree containing nested elements. When clients pass a value of this class as a parameter, the attribute must contain all the attributes defined in ChildPolicyConfigResource. When methods return a value of this class as a return value, the attribute will contain all the attributes defined in ChildPolicyConfigResource.
marked_for_delete (bool or None) – Intent objects are not directly deleted from the system when a delete is invoked on them. They are marked for deletion and only when all the realized entities for that intent object gets deleted, the intent object is deleted. Objects that are marked for deletion are not returned in GET call. One can use the search API to get these objects. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
key_algo (str or None) – Key algorithm contained in this certificate
passphrase (str or None) – Password for private key encryption
pem_encoded (str) – pem encoded certificate data
private_key (str or None) – private key data

class com.vmware.nsx_policy.model_client.StandaloneHostIdfwConfiguration(links=None, schema=None, self_=None, revision=None, create_time=None, create_user=None, last_modified_time=None, last_modified_user=None, protection=None, system_owned=None, description=None, display_name=None, id=None, resource_type=None, tags=None, parent_path=None, path=None, relative_path=None, children=None, marked_for_delete=None, idfw_enabled=None)¶

Bases: vmware.vapi.bindings.struct.VapiStruct

Idfw configuration for enable/disable idfw on standalone hosts.

Tip

The arguments are used to initialize data attributes with the same names.

Parameters

links (list of ResourceLink or None) – The server will populate this field when returing the resource. Ignored on PUT and POST. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
schema (str or None) – Schema for this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
self (SelfResourceLink or None) – Link to this resource
revision (long or None) – The _revision property describes the current revision of the resource. To prevent clients from overwriting each other’s changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected. format: int32
create_time (long or None) – Timestamp of resource creation format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
create_user (str or None) – ID of the user who created this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
last_modified_time (long or None) – Timestamp of last modification format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
last_modified_user (str or None) – ID of the user who last modified this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
protection (str or None) – Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super user and can modify it, but only when providing the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this entity. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
system_owned (bool or None) – Indicates system owned resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
description (str or None) – Description of this resource
display_name (str or None) – Defaults to ID if not set
id (str or None) – Unique identifier of this resource
resource_type (str or None) – The type of this resource.
tags (list of Tag or None) – Opaque identifiers meaningful to the API user
parent_path (str or None) – Path of its parent This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
path (str or None) – Absolute path of this object This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
relative_path (str or None) – Path relative from its parent This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
children (list of vmware.vapi.struct.VapiStruct or None) – subtree for this type within policy tree containing nested elements. When clients pass a value of this class as a parameter, the attribute must contain all the attributes defined in ChildPolicyConfigResource. When methods return a value of this class as a return value, the attribute will contain all the attributes defined in ChildPolicyConfigResource.
marked_for_delete (bool or None) – Intent objects are not directly deleted from the system when a delete is invoked on them. They are marked for deletion and only when all the realized entities for that intent object gets deleted, the intent object is deleted. Objects that are marked for deletion are not returned in GET call. One can use the search API to get these objects. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
idfw_enabled (bool) – If set to true, Idfw is enabled for standalone hosts

class com.vmware.nsx_policy.model_client.StatItem(drilldown_id=None, tooltip=None, total=None, value=None)¶

Bases: vmware.vapi.bindings.struct.VapiStruct

Displayed as a single number. It can be used to show the characteristics of entities such as Logical Switches, Firewall Rules, and so on. For example, number of logical switches and their admin states.

Tip

The arguments are used to initialize data attributes with the same names.

Parameters

drilldown_id (str or None) – Id of drilldown widget, if any. Id should be a valid id of an existing widget.
tooltip (list of Tooltip or None) – Multi-line text to be shown on tooltip while hovering over the stat.
total (str or None) – If expression for total is specified, it evaluates it. Total can be omitted if not needed to be shown.
value (str) – Expression for stat to be displayed.

class com.vmware.nsx_policy.model_client.StaticARPConfig(links=None, schema=None, self_=None, revision=None, create_time=None, create_user=None, last_modified_time=None, last_modified_user=None, protection=None, system_owned=None, description=None, display_name=None, id=None, resource_type=None, tags=None, parent_path=None, path=None, relative_path=None, children=None, marked_for_delete=None, ip_address=None, mac_address=None)¶

Bases: vmware.vapi.bindings.struct.VapiStruct

Contains Static ARP configuration for Segment.

Tip

The arguments are used to initialize data attributes with the same names.

Parameters

links (list of ResourceLink or None) – The server will populate this field when returing the resource. Ignored on PUT and POST. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
schema (str or None) – Schema for this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
self (SelfResourceLink or None) – Link to this resource
revision (long or None) – The _revision property describes the current revision of the resource. To prevent clients from overwriting each other’s changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected. format: int32
create_time (long or None) – Timestamp of resource creation format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
create_user (str or None) – ID of the user who created this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
last_modified_time (long or None) – Timestamp of last modification format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
last_modified_user (str or None) – ID of the user who last modified this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
protection (str or None) – Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super user and can modify it, but only when providing the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this entity. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
system_owned (bool or None) – Indicates system owned resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
description (str or None) – Description of this resource
display_name (str or None) – Defaults to ID if not set
id (str or None) – Unique identifier of this resource
resource_type (str or None) – The type of this resource.
tags (list of Tag or None) – Opaque identifiers meaningful to the API user
parent_path (str or None) – Path of its parent This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
path (str or None) – Absolute path of this object This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
relative_path (str or None) – Path relative from its parent This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
children (list of vmware.vapi.struct.VapiStruct or None) – subtree for this type within policy tree containing nested elements. When clients pass a value of this class as a parameter, the attribute must contain all the attributes defined in ChildPolicyConfigResource. When methods return a value of this class as a return value, the attribute will contain all the attributes defined in ChildPolicyConfigResource.
marked_for_delete (bool or None) – Intent objects are not directly deleted from the system when a delete is invoked on them. They are marked for deletion and only when all the realized entities for that intent object gets deleted, the intent object is deleted. Objects that are marked for deletion are not returned in GET call. One can use the search API to get these objects. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
ip_address (str) – IP Address format: ip
mac_address (str) – MAC Address

class com.vmware.nsx_policy.model_client.StaticRoutes(links=None, schema=None, self_=None, revision=None, create_time=None, create_user=None, last_modified_time=None, last_modified_user=None, protection=None, system_owned=None, description=None, display_name=None, id=None, resource_type=None, tags=None, parent_path=None, path=None, relative_path=None, children=None, marked_for_delete=None, network=None, next_hops=None)¶

Bases: vmware.vapi.bindings.struct.VapiStruct

Static routes configuration on Tier-0 or Tier-1.

Tip

The arguments are used to initialize data attributes with the same names.

Parameters

links (list of ResourceLink or None) – The server will populate this field when returing the resource. Ignored on PUT and POST. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
schema (str or None) – Schema for this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
self (SelfResourceLink or None) – Link to this resource
revision (long or None) – The _revision property describes the current revision of the resource. To prevent clients from overwriting each other’s changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected. format: int32
create_time (long or None) – Timestamp of resource creation format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
create_user (str or None) – ID of the user who created this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
last_modified_time (long or None) – Timestamp of last modification format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
last_modified_user (str or None) – ID of the user who last modified this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
protection (str or None) – Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super user and can modify it, but only when providing the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this entity. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
system_owned (bool or None) – Indicates system owned resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
description (str or None) – Description of this resource
display_name (str or None) – Defaults to ID if not set
id (str or None) – Unique identifier of this resource
resource_type (str or None) – The type of this resource.
tags (list of Tag or None) – Opaque identifiers meaningful to the API user
parent_path (str or None) – Path of its parent This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
path (str or None) – Absolute path of this object This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
relative_path (str or None) – Path relative from its parent This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
children (list of vmware.vapi.struct.VapiStruct or None) – subtree for this type within policy tree containing nested elements. When clients pass a value of this class as a parameter, the attribute must contain all the attributes defined in ChildPolicyConfigResource. When methods return a value of this class as a return value, the attribute will contain all the attributes defined in ChildPolicyConfigResource.
marked_for_delete (bool or None) – Intent objects are not directly deleted from the system when a delete is invoked on them. They are marked for deletion and only when all the realized entities for that intent object gets deleted, the intent object is deleted. Objects that are marked for deletion are not returned in GET call. One can use the search API to get these objects. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
network (str) – Specify network address in CIDR format. format: address-or-block-or-range
next_hops (list of RouterNexthop) – Specify next hop routes for network.

class com.vmware.nsx_policy.model_client.StaticRoutesListResult(links=None, schema=None, self_=None, cursor=None, result_count=None, sort_ascending=None, sort_by=None, results=None)¶

Bases: vmware.vapi.bindings.struct.VapiStruct

Paged collection of Static Routes

Tip

The arguments are used to initialize data attributes with the same names.

Parameters

links (list of ResourceLink or None) – The server will populate this field when returing the resource. Ignored on PUT and POST. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
schema (str or None) – Schema for this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
self (SelfResourceLink or None) – Link to this resource
cursor (str or None) – Opaque cursor to be used for getting next page of records (supplied by current result page) This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
result_count (long or None) – Count of results found (across all pages), set only on first page format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
sort_ascending (bool or None) – If true, results are sorted in ascending order This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
sort_by (str or None) – Field by which records are sorted This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
results (list of StaticRoutes) – Static Routes list results

class com.vmware.nsx_policy.model_client.StatsConfiguration(label=None, navigation=None, sections=None, stat=None, sub_type=None, links=None, schema=None, self_=None, revision=None, create_time=None, create_user=None, last_modified_time=None, last_modified_user=None, protection=None, system_owned=None, description=None, display_name=None, id=None, resource_type='StatsConfiguration', tags=None, datasources=None, drilldown_id=None, footer=None, icons=None, is_drilldown=None, legend=None, shared=None, weight=None)¶

Bases: vmware.vapi.bindings.struct.VapiStruct

Represents configuration of a statistic for an entity. Example, number of logical switches and their admin states.

Tip

The arguments are used to initialize data attributes with the same names.

Parameters

label (Label or None) – Displayed at the sections, by default. It labels the entities of sections. If label is not provided, the sections are not labelled.
navigation (str or None) – Hyperlink of the specified UI page that provides details.
sections (list of DonutSection or None) – Sections
stat (StatItem or None) – Expression that fetches statistic. It can be used to show the characteristics of entities such as Logical Switches, Firewall Rules, and so on. For example, number of logical switches and their admin states. If stat is not provided, then it will not be displayed.
sub_type (str or None) –
Possible values are:
- StatsConfiguration.SUB_TYPE_COMPACT
A sub-type of StatsConfiguration. If sub-type is not specified the parent type is rendered. The COMPACT sub_type, conserves the space for the widget. The statistic is placed on the right side on top of the status bar and the title of the widget is placed on the left side on the top of the status bar. The COMPACT style aligns itself horizontally as per the width of the container. If multiple widgets are placed insided the container then the widgets are placed one below the other to conserve the space.
links (list of ResourceLink or None) – The server will populate this field when returing the resource. Ignored on PUT and POST. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
schema (str or None) – Schema for this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
self (SelfResourceLink or None) – Link to this resource
revision (long or None) – The _revision property describes the current revision of the resource. To prevent clients from overwriting each other’s changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected. format: int32
create_time (long or None) – Timestamp of resource creation format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
create_user (str or None) – ID of the user who created this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
last_modified_time (long or None) – Timestamp of last modification format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
last_modified_user (str or None) – ID of the user who last modified this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
protection (str or None) – Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super user and can modify it, but only when providing the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this entity. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
system_owned (bool or None) – Indicates system owned resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
description (str or None) – Description of this resource
display_name (str or None) – Title of the widget. If display_name is omitted, the widget will be shown without a title.
id (str or None) – Unique identifier of this resource
resource_type (str) –
Possible values are:
- WidgetConfiguration.RESOURCE_TYPE_LABELVALUECONFIGURATION
- WidgetConfiguration.RESOURCE_TYPE_DONUTCONFIGURATION
- WidgetConfiguration.RESOURCE_TYPE_MULTIWIDGETCONFIGURATION
- WidgetConfiguration.RESOURCE_TYPE_CONTAINERCONFIGURATION
- WidgetConfiguration.RESOURCE_TYPE_STATSCONFIGURATION
- WidgetConfiguration.RESOURCE_TYPE_GRIDCONFIGURATION
- WidgetConfiguration.RESOURCE_TYPE_GRAPHCONFIGURATION
Supported visualization types are LabelValueConfiguration, DonutConfiguration, GridConfiguration, StatsConfiguration, MultiWidgetConfiguration, GraphConfiguration and ContainerConfiguration.
tags (list of Tag or None) – Opaque identifiers meaningful to the API user
datasources (list of Datasource or None) – The ‘datasources’ represent the sources from which data will be fetched. Currently, only NSX-API is supported as a ‘default’ datasource. An example of specifying ‘default’ datasource along with the urls to fetch data from is given at ‘example_request’ section of ‘CreateWidgetConfiguration’ API.
drilldown_id (str or None) – Id of drilldown widget, if any. Id should be a valid id of an existing widget. A widget is considered as drilldown widget when it is associated with any other widget and provides more detailed information about any data item from the parent widget.
footer (Footer or None) –
icons (list of Icon or None) – Icons to be applied at dashboard for widgets and UI elements.
is_drilldown (bool or None) – Set to true if this widget should be used as a drilldown.
legend (Legend or None) – Legend to be displayed. If legend is not needed, do not include it.
shared (bool or None) – Please use the property ‘shared’ of View instead of this. The widgets of a shared view are visible to other users.
weight (long or None) – Specify relavite weight in WidgetItem for placement in a view. Please see WidgetItem for details. format: int32

SUB_TYPE_COMPACT = 'COMPACT'¶

property resource_type¶: Return the discriminator value

class com.vmware.nsx_policy.model_client.StubFactory(stub_config)¶

Bases: vmware.vapi.bindings.stub.StubFactoryBase

Initialize StubFactoryBase

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

class com.vmware.nsx_policy.model_client.Tag(scope=None, tag=None)¶

Bases: vmware.vapi.bindings.struct.VapiStruct

Arbitrary key-value pairs that may be attached to an entity

Tip

The arguments are used to initialize data attributes with the same names.

Parameters

scope (str or None) – Tag searches may optionally be restricted by scope
tag (str or None) – Identifier meaningful to user with maximum length of 256 characters

class com.vmware.nsx_policy.model_client.TcpMaximumSegmentSizeClamping(direction=None, max_segment_size=None)¶

Bases: vmware.vapi.bindings.struct.VapiStruct

TCP MSS Clamping Direction and Value.

Tip

The arguments are used to initialize data attributes with the same names.

Parameters

direction (str or None) –
Possible values are:
Specifies the traffic direction for which to apply MSS Clamping.
max_segment_size (long or None) – MSS defines the maximum amount of data that a host is willing to accept in a single TCP segment. This field is set in TCP header during connection establishment. To avoid packet fragmentation, you can set this field depending on uplink MTU and VPN overhead. This is an optional field and in case it is left unconfigured, best possible MSS value will be calculated based on effective mtu of uplink interface. Supported MSS range is 216 to 8960. format: int64

DIRECTION_BOTH = 'BOTH'¶

DIRECTION_INBOUND_CONNECTION = 'INBOUND_CONNECTION'¶

DIRECTION_NONE = 'NONE'¶

DIRECTION_OUTBOUND_CONNECTION = 'OUTBOUND_CONNECTION'¶

class com.vmware.nsx_policy.model_client.TcpPolicyLbMonitorProfile(links=None, schema=None, self_=None, revision=None, create_time=None, create_user=None, last_modified_time=None, last_modified_user=None, protection=None, system_owned=None, description=None, display_name=None, id=None, resource_type='TcpPolicyLbMonitorProfile', tags=None, parent_path=None, path=None, relative_path=None, children=None, marked_for_delete=None, fall_count=None, interval=None, monitor_port=None, rise_count=None, timeout=None)¶

Bases: vmware.vapi.bindings.struct.VapiStruct

Active healthchecks are disabled by default and can be enabled for a server pool by binding a health monitor to the Group through the PolicyLbRule object. This represents active health monitoring over TCP. Active healthchecks are initiated periodically, at a configurable interval, to each member of the Group. Only if a healthcheck fails consecutively for a specified number of times (fall_count) to a member will the member status be marked DOWN. Once a member is DOWN, a specified number of consecutive successful healthchecks (rise_count) will bring the member back to UP state. After a healthcheck is initiated, if it does not complete within a certain period, then also the healthcheck is considered to be unsuccessful. Completing a healthcheck within timeout means establishing a connection (TCP or SSL), if applicable, sending the request and receiving the response, all within the configured timeout.

Tip

The arguments are used to initialize data attributes with the same names.

Parameters

links (list of ResourceLink or None) – The server will populate this field when returing the resource. Ignored on PUT and POST. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
schema (str or None) – Schema for this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
self (SelfResourceLink or None) – Link to this resource
revision (long or None) – The _revision property describes the current revision of the resource. To prevent clients from overwriting each other’s changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected. format: int32
create_time (long or None) – Timestamp of resource creation format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
create_user (str or None) – ID of the user who created this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
last_modified_time (long or None) – Timestamp of last modification format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
last_modified_user (str or None) – ID of the user who last modified this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
protection (str or None) – Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super user and can modify it, but only when providing the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this entity. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
system_owned (bool or None) – Indicates system owned resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
description (str or None) – Description of this resource
display_name (str or None) – Defaults to ID if not set
id (str or None) – Unique identifier of this resource
resource_type (str) –
Possible values are:
- PolicyLbMonitorProfile.RESOURCE_TYPE_TCPPOLICYLBMONITORPROFILE
- PolicyLbMonitorProfile.RESOURCE_TYPE_UDPPOLICYLBMONITORPROFILE
- PolicyLbMonitorProfile.RESOURCE_TYPE_ICMPPOLICYLBMONITORPROFILE
- PolicyLbMonitorProfile.RESOURCE_TYPE_HTTPPOLICYLBMONITORPROFILE
- PolicyLbMonitorProfile.RESOURCE_TYPE_HTTPSPOLICYLBMONITORPROFILE
tags (list of Tag or None) – Opaque identifiers meaningful to the API user
parent_path (str or None) – Path of its parent This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
path (str or None) – Absolute path of this object This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
relative_path (str or None) – Path relative from its parent This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
children (list of vmware.vapi.struct.VapiStruct or None) – subtree for this type within policy tree containing nested elements. When clients pass a value of this class as a parameter, the attribute must contain all the attributes defined in ChildPolicyConfigResource. When methods return a value of this class as a return value, the attribute will contain all the attributes defined in ChildPolicyConfigResource.
marked_for_delete (bool or None) – Intent objects are not directly deleted from the system when a delete is invoked on them. They are marked for deletion and only when all the realized entities for that intent object gets deleted, the intent object is deleted. Objects that are marked for deletion are not returned in GET call. One can use the search API to get these objects. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
fall_count (long or None) – Only if a healthcheck fails consecutively for a specified number of times, given with fall_count, to a member will the member status be marked DOWN. format: int64
interval (long or None) – Active healthchecks are initiated periodically, at a configurable interval (in seconds), to each member of the Group. format: int64
monitor_port (long or None) – Typically, monitors perform healthchecks to Group members using the member IP address and pool_port. However, in some cases, customers prefer to run healthchecks against a different port than the pool member port which handles actual application traffic. In such cases, the port to run healthchecks against can be specified in the monitor_port value. format: int32
rise_count (long or None) – Once a member is DOWN, a specified number of consecutive successful healthchecks specified by rise_count will bring the member back to UP state. format: int64
timeout (long or None) – Timeout specified in seconds. After a healthcheck is initiated, if it does not complete within a certain period, then also the healthcheck is considered to be unsuccessful. Completing a healthcheck within timeout means establishing a connection (TCP or SSL), if applicable, sending the request and receiving the response, all within the configured timeout. format: int64

property resource_type¶: Return the discriminator value

class com.vmware.nsx_policy.model_client.TcpPolicyLbVirtualServer(links=None, schema=None, self_=None, revision=None, create_time=None, create_user=None, last_modified_time=None, last_modified_user=None, protection=None, system_owned=None, description=None, display_name=None, id=None, resource_type='TcpPolicyLbVirtualServer', tags=None, parent_path=None, path=None, relative_path=None, children=None, marked_for_delete=None, access_log_enabled=None, ip_address=None, lb_persistence_profile=None, ports=None, router_path=None, traffic_source=None)¶

Bases: vmware.vapi.bindings.struct.VapiStruct

Virtual server acts as a facade to an application, receives all client connections over TCP and distributes them among the backend servers.

Tip

The arguments are used to initialize data attributes with the same names.

Parameters

links (list of ResourceLink or None) – The server will populate this field when returing the resource. Ignored on PUT and POST. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
schema (str or None) – Schema for this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
self (SelfResourceLink or None) – Link to this resource
revision (long or None) – The _revision property describes the current revision of the resource. To prevent clients from overwriting each other’s changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected. format: int32
create_time (long or None) – Timestamp of resource creation format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
create_user (str or None) – ID of the user who created this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
last_modified_time (long or None) – Timestamp of last modification format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
last_modified_user (str or None) – ID of the user who last modified this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
protection (str or None) – Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super user and can modify it, but only when providing the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this entity. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
system_owned (bool or None) – Indicates system owned resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
description (str or None) – Description of this resource
display_name (str or None) – Defaults to ID if not set
id (str or None) – Unique identifier of this resource
resource_type (str) –
Possible values are:
- PolicyLbVirtualServer.RESOURCE_TYPE_TCPPOLICYLBVIRTUALSERVER
- PolicyLbVirtualServer.RESOURCE_TYPE_UDPPOLICYLBVIRTUALSERVER
- PolicyLbVirtualServer.RESOURCE_TYPE_HTTPPOLICYLBVIRTUALSERVER
- PolicyLbVirtualServer.RESOURCE_TYPE_HTTPSPOLICYLBVIRTUALSERVER
- PolicyLbVirtualServer.RESOURCE_TYPE_CUSTOMPOLICYLBVIRTUALSERVER
tags (list of Tag or None) – Opaque identifiers meaningful to the API user
parent_path (str or None) – Path of its parent This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
path (str or None) – Absolute path of this object This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
relative_path (str or None) – Path relative from its parent This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
children (list of vmware.vapi.struct.VapiStruct or None) – subtree for this type within policy tree containing nested elements. When clients pass a value of this class as a parameter, the attribute must contain all the attributes defined in ChildPolicyConfigResource. When methods return a value of this class as a return value, the attribute will contain all the attributes defined in ChildPolicyConfigResource.
marked_for_delete (bool or None) – Intent objects are not directly deleted from the system when a delete is invoked on them. They are marked for deletion and only when all the realized entities for that intent object gets deleted, the intent object is deleted. Objects that are marked for deletion are not returned in GET call. One can use the search API to get these objects. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
access_log_enabled (bool or None) – If access log is enabled, all HTTP requests sent to an L7 virtual server are logged to the access log file. Both successful requests (backend server returns 2xx) and unsuccessful requests (backend server returns 4xx or 5xx) are logged to access log, if enabled.
ip_address (str) – Configures the IP address of the PolicyLbVirtualServer where it receives all client connections and distributes them among the backend servers. format: ip
lb_persistence_profile (str or None) – Path to optional object that enables persistence on a virtual server allowing related client connections to be sent to the same backend server. Persistence is disabled by default.
ports (list of str) – Ports contains a list of at least one port or port range such as “80”, “1234-1236”. Each port element in the list should be a single port or a single port range. format: port-or-range
router_path (str) – Path to router type object that PolicyLbVirtualServer connects to. The only supported router object is Network.
traffic_source (str or None) –

property resource_type¶: Return the discriminator value

class com.vmware.nsx_policy.model_client.Tier0(links=None, schema=None, self_=None, revision=None, create_time=None, create_user=None, last_modified_time=None, last_modified_user=None, protection=None, system_owned=None, description=None, display_name=None, id=None, resource_type=None, tags=None, parent_path=None, path=None, relative_path=None, children=None, marked_for_delete=None, default_rule_logging=None, dhcp_config_paths=None, disable_firewall=None, failover_mode=None, force_whitelisting=None, ha_mode=None, internal_transit_subnets=None, ipv6_profile_paths=None, transit_subnets=None)¶

Bases: vmware.vapi.bindings.struct.VapiStruct

Tier-0 configuration for external connectivity.

Tip

The arguments are used to initialize data attributes with the same names.

Parameters

links (list of ResourceLink or None) – The server will populate this field when returing the resource. Ignored on PUT and POST. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
schema (str or None) – Schema for this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
self (SelfResourceLink or None) – Link to this resource
revision (long or None) – The _revision property describes the current revision of the resource. To prevent clients from overwriting each other’s changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected. format: int32
create_time (long or None) – Timestamp of resource creation format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
create_user (str or None) – ID of the user who created this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
last_modified_time (long or None) – Timestamp of last modification format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
last_modified_user (str or None) – ID of the user who last modified this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
protection (str or None) – Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super user and can modify it, but only when providing the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this entity. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
system_owned (bool or None) – Indicates system owned resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
description (str or None) – Description of this resource
display_name (str or None) – Defaults to ID if not set
id (str or None) – Unique identifier of this resource
resource_type (str or None) – The type of this resource.
tags (list of Tag or None) – Opaque identifiers meaningful to the API user
parent_path (str or None) – Path of its parent This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
path (str or None) – Absolute path of this object This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
relative_path (str or None) – Path relative from its parent This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
children (list of vmware.vapi.struct.VapiStruct or None) – subtree for this type within policy tree containing nested elements. When clients pass a value of this class as a parameter, the attribute must contain all the attributes defined in ChildPolicyConfigResource. When methods return a value of this class as a return value, the attribute will contain all the attributes defined in ChildPolicyConfigResource.
marked_for_delete (bool or None) – Intent objects are not directly deleted from the system when a delete is invoked on them. They are marked for deletion and only when all the realized entities for that intent object gets deleted, the intent object is deleted. Objects that are marked for deletion are not returned in GET call. One can use the search API to get these objects. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
default_rule_logging (bool or None) – Indicates if logging should be enabled for the default whitelisting rule. This filed is deprecated and recommended to change Rule logging filed. Note that this filed is not synchornied with default logging field.
dhcp_config_paths (list of str or None) – DHCP configuration for Segments connected to Tier-0. DHCP service is configured in relay mode.
disable_firewall (bool or None) – Disable or enable gateway fiewall.
failover_mode (str or None) –
Possible values are:
- Tier0.FAILOVER_MODE_PREEMPTIVE
- Tier0.FAILOVER_MODE_NON_PREEMPTIVE
Determines the behavior when a Tier-0 instance in ACTIVE-STANDBY high-availability mode restarts after a failure. If set to PREEMPTIVE, the preferred node will take over, even if it causes another failure. If set to NON_PREEMPTIVE, then the instance that restarted will remain secondary. This property is not used when the ha_mode property is set to ACTIVE_ACTIVE. Only applicable when edge cluster is configured in Tier0 locale-service.
force_whitelisting (bool or None) – This filed is deprecated and recommended to change Rule action filed. Note that this filed is not synchornied with default rule field.
ha_mode (str or None) –
Possible values are:
- Tier0.HA_MODE_ACTIVE
- Tier0.HA_MODE_STANDBY
Specify high-availability mode for Tier-0. Default is ACTIVE_ACTIVE.
internal_transit_subnets (list of str or None) – Specify subnets that are used to assign addresses to logical links connecting service routers and distributed routers. Only IPv4 addresses are supported. When not specified, subnet 169.254.0.0/24 is assigned by default in ACTIVE_ACTIVE HA mode or 169.254.0.0/28 in ACTIVE_STANDBY mode. format: ip-cidr-block
ipv6_profile_paths (list of str or None) – IPv6 NDRA and DAD profiles configuration on Tier0. Either or both NDRA and/or DAD profiles can be configured.
transit_subnets (list of str or None) – Specify transit subnets that are used to assign addresses to logical links connecting tier-0 and tier-1s. Both IPv4 and IPv6 addresses are supported. When not specified, subnet 100.64.0.0/16 is configured by default. format: ip-cidr-block

FAILOVER_MODE_NON_PREEMPTIVE = 'NON_PREEMPTIVE'¶

FAILOVER_MODE_PREEMPTIVE = 'PREEMPTIVE'¶

HA_MODE_ACTIVE = 'ACTIVE_ACTIVE'¶

HA_MODE_STANDBY = 'ACTIVE_STANDBY'¶

class com.vmware.nsx_policy.model_client.Tier0DeploymentMap(links=None, schema=None, self_=None, revision=None, create_time=None, create_user=None, last_modified_time=None, last_modified_user=None, protection=None, system_owned=None, description=None, display_name=None, id=None, resource_type=None, tags=None, parent_path=None, path=None, relative_path=None, children=None, marked_for_delete=None, enforcement_point=None)¶

Bases: vmware.vapi.bindings.struct.VapiStruct

Associate tier-0 to the enforcement point to realize policy intent

Tip

The arguments are used to initialize data attributes with the same names.

Parameters

links (list of ResourceLink or None) – The server will populate this field when returing the resource. Ignored on PUT and POST. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
schema (str or None) – Schema for this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
self (SelfResourceLink or None) – Link to this resource
revision (long or None) – The _revision property describes the current revision of the resource. To prevent clients from overwriting each other’s changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected. format: int32
create_time (long or None) – Timestamp of resource creation format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
create_user (str or None) – ID of the user who created this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
last_modified_time (long or None) – Timestamp of last modification format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
last_modified_user (str or None) – ID of the user who last modified this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
protection (str or None) – Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super user and can modify it, but only when providing the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this entity. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
system_owned (bool or None) – Indicates system owned resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
description (str or None) – Description of this resource
display_name (str or None) – Defaults to ID if not set
id (str or None) – Unique identifier of this resource
resource_type (str or None) – The type of this resource.
tags (list of Tag or None) – Opaque identifiers meaningful to the API user
parent_path (str or None) – Path of its parent This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
path (str or None) – Absolute path of this object This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
relative_path (str or None) – Path relative from its parent This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
children (list of vmware.vapi.struct.VapiStruct or None) – subtree for this type within policy tree containing nested elements. When clients pass a value of this class as a parameter, the attribute must contain all the attributes defined in ChildPolicyConfigResource. When methods return a value of this class as a return value, the attribute will contain all the attributes defined in ChildPolicyConfigResource.
marked_for_delete (bool or None) – Intent objects are not directly deleted from the system when a delete is invoked on them. They are marked for deletion and only when all the realized entities for that intent object gets deleted, the intent object is deleted. Objects that are marked for deletion are not returned in GET call. One can use the search API to get these objects. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
enforcement_point (str) – Path of enforcement point on which Tier-0 will be deployed

class com.vmware.nsx_policy.model_client.Tier0GatewayState(enforcement_point_path=None, ipv6_status=None, tier0_state=None, tier0_status=None)¶

Bases: vmware.vapi.bindings.struct.VapiStruct

Tier0 gateway state

Tip

The arguments are used to initialize data attributes with the same names.

Parameters

enforcement_point_path (str or None) – String Path of the enforcement point. When not specified, routes from all enforcement-points are returned.
ipv6_status (list of IPv6Status or None) – IPv6 DAD status for interfaces configured on Tier0
tier0_state (LogicalRouterState or None) – Detailed realized state information for Tier0
tier0_status (LogicalRouterStatus or None) – Detailed realized status information for Tier0

class com.vmware.nsx_policy.model_client.Tier0HaVipConfig(enabled=None, external_interface_paths=None, vip_subnets=None)¶

Bases: vmware.vapi.bindings.struct.VapiStruct

Tier0 HA VIP Config

Tip

The arguments are used to initialize data attributes with the same names.

Parameters

enabled (bool or None) – Flag to enable this HA VIP config.
external_interface_paths (list of str) – Policy paths to Tier0 external interfaces which are to be paired to provide redundancy. Floating IP will be owned by one of these interfaces depending upon which edge node is Active.
vip_subnets (list of InterfaceSubnet) – Array of IP address subnets which will be used as floating IP addresses.

class com.vmware.nsx_policy.model_client.Tier0Interface(links=None, schema=None, self_=None, revision=None, create_time=None, create_user=None, last_modified_time=None, last_modified_user=None, protection=None, system_owned=None, description=None, display_name=None, id=None, resource_type=None, tags=None, parent_path=None, path=None, relative_path=None, children=None, marked_for_delete=None, subnets=None, edge_cluster_member_index=None, edge_path=None, ipv6_profile_paths=None, ls_id=None, mtu=None, segment_path=None, type=None)¶

Bases: vmware.vapi.bindings.struct.VapiStruct

Tier-0 interface configuration for external connectivity.

Tip

The arguments are used to initialize data attributes with the same names.

Parameters

links (list of ResourceLink or None) – The server will populate this field when returing the resource. Ignored on PUT and POST. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
schema (str or None) – Schema for this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
self (SelfResourceLink or None) – Link to this resource
revision (long or None) – The _revision property describes the current revision of the resource. To prevent clients from overwriting each other’s changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected. format: int32
create_time (long or None) – Timestamp of resource creation format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
create_user (str or None) – ID of the user who created this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
last_modified_time (long or None) – Timestamp of last modification format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
last_modified_user (str or None) – ID of the user who last modified this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
protection (str or None) – Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super user and can modify it, but only when providing the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this entity. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
system_owned (bool or None) – Indicates system owned resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
description (str or None) – Description of this resource
display_name (str or None) – Defaults to ID if not set
id (str or None) – Unique identifier of this resource
resource_type (str or None) – The type of this resource.
tags (list of Tag or None) – Opaque identifiers meaningful to the API user
parent_path (str or None) – Path of its parent This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
path (str or None) – Absolute path of this object This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
relative_path (str or None) – Path relative from its parent This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
children (list of vmware.vapi.struct.VapiStruct or None) – subtree for this type within policy tree containing nested elements. When clients pass a value of this class as a parameter, the attribute must contain all the attributes defined in ChildPolicyConfigResource. When methods return a value of this class as a return value, the attribute will contain all the attributes defined in ChildPolicyConfigResource.
marked_for_delete (bool or None) – Intent objects are not directly deleted from the system when a delete is invoked on them. They are marked for deletion and only when all the realized entities for that intent object gets deleted, the intent object is deleted. Objects that are marked for deletion are not returned in GET call. One can use the search API to get these objects. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
subnets (list of InterfaceSubnet) – Specify IP address and network prefix for interface.
edge_cluster_member_index (long or None) – Specify association of interface with edge cluster member. This property is deprecated, use edge_path instead. When both properties are specifed, only edge_path property is used. format: int32
edge_path (str or None) – Policy path to edge node to handle external connectivity. Required when interface type is EXTERNAL.
ipv6_profile_paths (list of str or None) – Configuration IPv6 NDRA profile. Only one NDRA profile can be configured.
ls_id (str or None) – Specify logical switch to which tier-0 interface is connected for external access. This property is deprecated, use segment_path instead. Both properties cannot be used together.
mtu (long or None) – Maximum transmission unit (MTU) specifies the size of the largest packet that a network protocol can transmit. format: int32
segment_path (str or None) – Specify Segment to which this interface is connected to. Either segment_path or ls_id property is required.
type (str or None) –
Possible values are:
- Tier0Interface.TYPE_EXTERNAL
- Tier0Interface.TYPE_SERVICE
- Tier0Interface.TYPE_LOOPBACK
Interface type

TYPE_EXTERNAL = 'EXTERNAL'¶

TYPE_LOOPBACK = 'LOOPBACK'¶

TYPE_SERVICE = 'SERVICE'¶

class com.vmware.nsx_policy.model_client.Tier0InterfaceListResult(links=None, schema=None, self_=None, cursor=None, result_count=None, sort_ascending=None, sort_by=None, results=None)¶

Bases: vmware.vapi.bindings.struct.VapiStruct

Paged collection of Tier-0 Interfaces

Tip

The arguments are used to initialize data attributes with the same names.

Parameters

links (list of ResourceLink or None) – The server will populate this field when returing the resource. Ignored on PUT and POST. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
schema (str or None) – Schema for this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
self (SelfResourceLink or None) – Link to this resource
cursor (str or None) – Opaque cursor to be used for getting next page of records (supplied by current result page) This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
result_count (long or None) – Count of results found (across all pages), set only on first page format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
sort_ascending (bool or None) – If true, results are sorted in ascending order This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
sort_by (str or None) – Field by which records are sorted This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
results (list of Tier0Interface) – Tier-0 Interface list results

class com.vmware.nsx_policy.model_client.Tier0ListResult(links=None, schema=None, self_=None, cursor=None, result_count=None, sort_ascending=None, sort_by=None, results=None)¶

Bases: vmware.vapi.bindings.struct.VapiStruct

Paged collection of Tier-0s

Tip

The arguments are used to initialize data attributes with the same names.

Parameters

links (list of ResourceLink or None) – The server will populate this field when returing the resource. Ignored on PUT and POST. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
schema (str or None) – Schema for this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
self (SelfResourceLink or None) – Link to this resource
cursor (str or None) – Opaque cursor to be used for getting next page of records (supplied by current result page) This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
result_count (long or None) – Count of results found (across all pages), set only on first page format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
sort_ascending (bool or None) – If true, results are sorted in ascending order This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
sort_by (str or None) – Field by which records are sorted This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
results (list of Tier0) – Tier-0 list results

class com.vmware.nsx_policy.model_client.Tier0RouteMap(links=None, schema=None, self_=None, revision=None, create_time=None, create_user=None, last_modified_time=None, last_modified_user=None, protection=None, system_owned=None, description=None, display_name=None, id=None, resource_type=None, tags=None, parent_path=None, path=None, relative_path=None, children=None, marked_for_delete=None, entries=None)¶

Bases: vmware.vapi.bindings.struct.VapiStruct

RouteMap for redistributing routes to BGP and other routing protocols

Tip

The arguments are used to initialize data attributes with the same names.

Parameters

links (list of ResourceLink or None) – The server will populate this field when returing the resource. Ignored on PUT and POST. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
schema (str or None) – Schema for this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
self (SelfResourceLink or None) – Link to this resource
revision (long or None) – The _revision property describes the current revision of the resource. To prevent clients from overwriting each other’s changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected. format: int32
create_time (long or None) – Timestamp of resource creation format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
create_user (str or None) – ID of the user who created this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
last_modified_time (long or None) – Timestamp of last modification format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
last_modified_user (str or None) – ID of the user who last modified this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
protection (str or None) – Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super user and can modify it, but only when providing the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this entity. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
system_owned (bool or None) – Indicates system owned resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
description (str or None) – Description of this resource
display_name (str or None) – Defaults to ID if not set
id (str or None) – Unique identifier of this resource
resource_type (str or None) – The type of this resource.
tags (list of Tag or None) – Opaque identifiers meaningful to the API user
parent_path (str or None) – Path of its parent This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
path (str or None) – Absolute path of this object This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
relative_path (str or None) – Path relative from its parent This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
children (list of vmware.vapi.struct.VapiStruct or None) – subtree for this type within policy tree containing nested elements. When clients pass a value of this class as a parameter, the attribute must contain all the attributes defined in ChildPolicyConfigResource. When methods return a value of this class as a return value, the attribute will contain all the attributes defined in ChildPolicyConfigResource.
marked_for_delete (bool or None) – Intent objects are not directly deleted from the system when a delete is invoked on them. They are marked for deletion and only when all the realized entities for that intent object gets deleted, the intent object is deleted. Objects that are marked for deletion are not returned in GET call. One can use the search API to get these objects. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
entries (list of RouteMapEntry) – Ordered list of route map entries.

class com.vmware.nsx_policy.model_client.Tier0RouteMapListResult(links=None, schema=None, self_=None, cursor=None, result_count=None, sort_ascending=None, sort_by=None, results=None)¶

Bases: vmware.vapi.bindings.struct.VapiStruct

Paged collection of RouteMaps

Tip

The arguments are used to initialize data attributes with the same names.

Parameters

links (list of ResourceLink or None) – The server will populate this field when returing the resource. Ignored on PUT and POST. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
schema (str or None) – Schema for this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
self (SelfResourceLink or None) – Link to this resource
cursor (str or None) – Opaque cursor to be used for getting next page of records (supplied by current result page) This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
result_count (long or None) – Count of results found (across all pages), set only on first page format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
sort_ascending (bool or None) – If true, results are sorted in ascending order This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
sort_by (str or None) – Field by which records are sorted This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
results (list of Tier0RouteMap) – Tier0RouteMap results

class com.vmware.nsx_policy.model_client.Tier1(links=None, schema=None, self_=None, revision=None, create_time=None, create_user=None, last_modified_time=None, last_modified_user=None, protection=None, system_owned=None, description=None, display_name=None, id=None, resource_type=None, tags=None, parent_path=None, path=None, relative_path=None, children=None, marked_for_delete=None, default_rule_logging=None, dhcp_config_paths=None, disable_firewall=None, enable_standby_relocation=None, failover_mode=None, force_whitelisting=None, ipv6_profile_paths=None, route_advertisement_rules=None, route_advertisement_types=None, tier0_path=None, type=None)¶

Bases: vmware.vapi.bindings.struct.VapiStruct

Tier-1 instance configuration.

Tip

The arguments are used to initialize data attributes with the same names.

Parameters

links (list of ResourceLink or None) – The server will populate this field when returing the resource. Ignored on PUT and POST. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
schema (str or None) – Schema for this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
self (SelfResourceLink or None) – Link to this resource
revision (long or None) – The _revision property describes the current revision of the resource. To prevent clients from overwriting each other’s changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected. format: int32
create_time (long or None) – Timestamp of resource creation format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
create_user (str or None) – ID of the user who created this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
last_modified_time (long or None) – Timestamp of last modification format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
last_modified_user (str or None) – ID of the user who last modified this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
protection (str or None) – Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super user and can modify it, but only when providing the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this entity. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
system_owned (bool or None) – Indicates system owned resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
description (str or None) – Description of this resource
display_name (str or None) – Defaults to ID if not set
id (str or None) – Unique identifier of this resource
resource_type (str or None) – The type of this resource.
tags (list of Tag or None) – Opaque identifiers meaningful to the API user
parent_path (str or None) – Path of its parent This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
path (str or None) – Absolute path of this object This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
relative_path (str or None) – Path relative from its parent This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
children (list of vmware.vapi.struct.VapiStruct or None) – subtree for this type within policy tree containing nested elements. When clients pass a value of this class as a parameter, the attribute must contain all the attributes defined in ChildPolicyConfigResource. When methods return a value of this class as a return value, the attribute will contain all the attributes defined in ChildPolicyConfigResource.
marked_for_delete (bool or None) – Intent objects are not directly deleted from the system when a delete is invoked on them. They are marked for deletion and only when all the realized entities for that intent object gets deleted, the intent object is deleted. Objects that are marked for deletion are not returned in GET call. One can use the search API to get these objects. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
default_rule_logging (bool or None) – Indicates if logging should be enabled for the default whitelisting rule. This filed is deprecated and recommended to change Rule logging filed. Note that this filed is not synchornied with default logging field.
dhcp_config_paths (list of str or None) – DHCP configuration for Segments connected to Tier-1. DHCP service is enabled in relay mode.
disable_firewall (bool or None) – Disable or enable gateway fiewall.
enable_standby_relocation (bool or None) – Flag to enable standby service router relocation. Standby relocation is not enabled until edge cluster is configured for Tier1.
failover_mode (str or None) –
Possible values are:
- Tier1.FAILOVER_MODE_PREEMPTIVE
- Tier1.FAILOVER_MODE_NON_PREEMPTIVE
Determines the behavior when a Tier-1 instance restarts after a failure. If set to PREEMPTIVE, the preferred node will take over, even if it causes another failure. If set to NON_PREEMPTIVE, then the instance that restarted will remain secondary. Only applicable when edge cluster is configured in Tier1 locale-service.
force_whitelisting (bool or None) – This filed is deprecated and recommended to change Rule action filed. Note that this filed is not synchornied with default rule field.
ipv6_profile_paths (list of str or None) – Configuration IPv6 NDRA and DAD profiles. Either or both NDRA and/or DAD profiles can be configured.
route_advertisement_rules (list of RouteAdvertisementRule or None) – Route advertisement rules and filtering
route_advertisement_types (list of str or None) –
Possible values are:
- Tier1.ROUTE_ADVERTISEMENT_TYPES_STATIC_ROUTES
- Tier1.ROUTE_ADVERTISEMENT_TYPES_CONNECTED
- Tier1.ROUTE_ADVERTISEMENT_TYPES_NAT
- Tier1.ROUTE_ADVERTISEMENT_TYPES_LB_VIP
- Tier1.ROUTE_ADVERTISEMENT_TYPES_LB_SNAT
- Tier1.ROUTE_ADVERTISEMENT_TYPES_DNS_FORWARDER_IP
- Tier1.ROUTE_ADVERTISEMENT_TYPES_IPSEC_LOCAL_ENDPOINT
Enable different types of route advertisements. When not specified, routes to IPSec VPN local-endpoint subnets (TIER1_IPSEC_LOCAL_ENDPOINT) are automatically advertised.
tier0_path (str or None) – Specify Tier-1 connectivity to Tier-0 instance.
type (str or None) –
Possible values are:
- Tier1.TYPE_ROUTED
- Tier1.TYPE_ISOLATED
- Tier1.TYPE_NATTED
Tier1 connectivity type for reference. Property value is not validated with Tier1 configuration. ROUTED: Tier1 is connected to Tier0 gateway and routing is enabled. ISOLATED: Tier1 is not connected to any Tier0 gateway. NATTED: Tier1 is in ROUTED type with NAT configured locally.

FAILOVER_MODE_NON_PREEMPTIVE = 'NON_PREEMPTIVE'¶

FAILOVER_MODE_PREEMPTIVE = 'PREEMPTIVE'¶

ROUTE_ADVERTISEMENT_TYPES_CONNECTED = 'TIER1_CONNECTED'¶

ROUTE_ADVERTISEMENT_TYPES_DNS_FORWARDER_IP = 'TIER1_DNS_FORWARDER_IP'¶

ROUTE_ADVERTISEMENT_TYPES_IPSEC_LOCAL_ENDPOINT = 'TIER1_IPSEC_LOCAL_ENDPOINT'¶

ROUTE_ADVERTISEMENT_TYPES_LB_SNAT = 'TIER1_LB_SNAT'¶

ROUTE_ADVERTISEMENT_TYPES_LB_VIP = 'TIER1_LB_VIP'¶

ROUTE_ADVERTISEMENT_TYPES_NAT = 'TIER1_NAT'¶

ROUTE_ADVERTISEMENT_TYPES_STATIC_ROUTES = 'TIER1_STATIC_ROUTES'¶

TYPE_ISOLATED = 'ISOLATED'¶

TYPE_NATTED = 'NATTED'¶

TYPE_ROUTED = 'ROUTED'¶

class com.vmware.nsx_policy.model_client.Tier1DeploymentMap(links=None, schema=None, self_=None, revision=None, create_time=None, create_user=None, last_modified_time=None, last_modified_user=None, protection=None, system_owned=None, description=None, display_name=None, id=None, resource_type=None, tags=None, parent_path=None, path=None, relative_path=None, children=None, marked_for_delete=None, enforcement_point=None)¶

Bases: vmware.vapi.bindings.struct.VapiStruct

Binding the Tier-1 and its associated child objects to the enforcement point for realization.

Tip

The arguments are used to initialize data attributes with the same names.

Parameters

links (list of ResourceLink or None) – The server will populate this field when returing the resource. Ignored on PUT and POST. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
schema (str or None) – Schema for this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
self (SelfResourceLink or None) – Link to this resource
revision (long or None) – The _revision property describes the current revision of the resource. To prevent clients from overwriting each other’s changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected. format: int32
create_time (long or None) – Timestamp of resource creation format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
create_user (str or None) – ID of the user who created this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
last_modified_time (long or None) – Timestamp of last modification format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
last_modified_user (str or None) – ID of the user who last modified this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
protection (str or None) – Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super user and can modify it, but only when providing the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this entity. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
system_owned (bool or None) – Indicates system owned resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
description (str or None) – Description of this resource
display_name (str or None) – Defaults to ID if not set
id (str or None) – Unique identifier of this resource
resource_type (str or None) – The type of this resource.
tags (list of Tag or None) – Opaque identifiers meaningful to the API user
parent_path (str or None) – Path of its parent This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
path (str or None) – Absolute path of this object This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
relative_path (str or None) – Path relative from its parent This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
children (list of vmware.vapi.struct.VapiStruct or None) – subtree for this type within policy tree containing nested elements. When clients pass a value of this class as a parameter, the attribute must contain all the attributes defined in ChildPolicyConfigResource. When methods return a value of this class as a return value, the attribute will contain all the attributes defined in ChildPolicyConfigResource.
marked_for_delete (bool or None) – Intent objects are not directly deleted from the system when a delete is invoked on them. They are marked for deletion and only when all the realized entities for that intent object gets deleted, the intent object is deleted. Objects that are marked for deletion are not returned in GET call. One can use the search API to get these objects. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
enforcement_point (str) – Path of enforcement point on which Tier-1 will be deployed

class com.vmware.nsx_policy.model_client.Tier1GatewayState(enforcement_point_path=None, ipv6_status=None, tier1_state=None, tier1_status=None)¶

Bases: vmware.vapi.bindings.struct.VapiStruct

Tier1 gateway state

Tip

The arguments are used to initialize data attributes with the same names.

Parameters

enforcement_point_path (str or None) – String Path of the enforcement point. When not specified, routes from all enforcement-points are returned.
ipv6_status (list of IPv6Status or None) – IPv6 DAD status for interfaces configured on Tier1
tier1_state (LogicalRouterState or None) – Detailed realized state information for Tier1
tier1_status (LogicalRouterStatus or None) – Detailed realized status information for Tier1

class com.vmware.nsx_policy.model_client.Tier1Interface(links=None, schema=None, self_=None, revision=None, create_time=None, create_user=None, last_modified_time=None, last_modified_user=None, protection=None, system_owned=None, description=None, display_name=None, id=None, resource_type=None, tags=None, parent_path=None, path=None, relative_path=None, children=None, marked_for_delete=None, subnets=None, ipv6_profile_paths=None, mtu=None, segment_path=None)¶

Bases: vmware.vapi.bindings.struct.VapiStruct

Tier-1 interface configuration for attaching services.

Tip

The arguments are used to initialize data attributes with the same names.

Parameters

links (list of ResourceLink or None) – The server will populate this field when returing the resource. Ignored on PUT and POST. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
schema (str or None) – Schema for this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
self (SelfResourceLink or None) – Link to this resource
revision (long or None) – The _revision property describes the current revision of the resource. To prevent clients from overwriting each other’s changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected. format: int32
create_time (long or None) – Timestamp of resource creation format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
create_user (str or None) – ID of the user who created this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
last_modified_time (long or None) – Timestamp of last modification format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
last_modified_user (str or None) – ID of the user who last modified this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
protection (str or None) – Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super user and can modify it, but only when providing the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this entity. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
system_owned (bool or None) – Indicates system owned resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
description (str or None) – Description of this resource
display_name (str or None) – Defaults to ID if not set
id (str or None) – Unique identifier of this resource
resource_type (str or None) – The type of this resource.
tags (list of Tag or None) – Opaque identifiers meaningful to the API user
parent_path (str or None) – Path of its parent This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
path (str or None) – Absolute path of this object This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
relative_path (str or None) – Path relative from its parent This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
children (list of vmware.vapi.struct.VapiStruct or None) – subtree for this type within policy tree containing nested elements. When clients pass a value of this class as a parameter, the attribute must contain all the attributes defined in ChildPolicyConfigResource. When methods return a value of this class as a return value, the attribute will contain all the attributes defined in ChildPolicyConfigResource.
marked_for_delete (bool or None) – Intent objects are not directly deleted from the system when a delete is invoked on them. They are marked for deletion and only when all the realized entities for that intent object gets deleted, the intent object is deleted. Objects that are marked for deletion are not returned in GET call. One can use the search API to get these objects. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
subnets (list of InterfaceSubnet) – Specify IP address and network prefix for interface.
ipv6_profile_paths (list of str or None) – Configrue IPv6 NDRA profile. Only one NDRA profile can be configured.
mtu (long or None) – Maximum transmission unit (MTU) specifies the size of the largest packet that a network protocol can transmit. format: int32
segment_path (str) – Policy path of Segment to which interface is connected to.

class com.vmware.nsx_policy.model_client.Tier1InterfaceListResult(links=None, schema=None, self_=None, cursor=None, result_count=None, sort_ascending=None, sort_by=None, results=None)¶

Bases: vmware.vapi.bindings.struct.VapiStruct

Paged collection of Tier-1 Interfaces

Tip

The arguments are used to initialize data attributes with the same names.

Parameters

links (list of ResourceLink or None) – The server will populate this field when returing the resource. Ignored on PUT and POST. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
schema (str or None) – Schema for this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
self (SelfResourceLink or None) – Link to this resource
cursor (str or None) – Opaque cursor to be used for getting next page of records (supplied by current result page) This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
result_count (long or None) – Count of results found (across all pages), set only on first page format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
sort_ascending (bool or None) – If true, results are sorted in ascending order This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
sort_by (str or None) – Field by which records are sorted This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
results (list of Tier1Interface) – Tier-1 Interface list results

class com.vmware.nsx_policy.model_client.TlsCertificate(links=None, schema=None, self_=None, revision=None, create_time=None, create_user=None, last_modified_time=None, last_modified_user=None, protection=None, system_owned=None, description=None, display_name=None, id=None, resource_type=None, tags=None, parent_path=None, path=None, relative_path=None, children=None, marked_for_delete=None, details=None, pem_encoded=None)¶

Bases: vmware.vapi.bindings.struct.VapiStruct

Tip

The arguments are used to initialize data attributes with the same names.

Parameters

links (list of ResourceLink or None) – The server will populate this field when returing the resource. Ignored on PUT and POST. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
schema (str or None) – Schema for this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
self (SelfResourceLink or None) – Link to this resource
revision (long or None) – The _revision property describes the current revision of the resource. To prevent clients from overwriting each other’s changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected. format: int32
create_time (long or None) – Timestamp of resource creation format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
create_user (str or None) – ID of the user who created this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
last_modified_time (long or None) – Timestamp of last modification format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
last_modified_user (str or None) – ID of the user who last modified this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
protection (str or None) – Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super user and can modify it, but only when providing the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this entity. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
system_owned (bool or None) – Indicates system owned resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
description (str or None) – Description of this resource
display_name (str or None) – Defaults to ID if not set
id (str or None) – Unique identifier of this resource
resource_type (str or None) – The type of this resource.
tags (list of Tag or None) – Opaque identifiers meaningful to the API user
parent_path (str or None) – Path of its parent This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
path (str or None) – Absolute path of this object This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
relative_path (str or None) – Path relative from its parent This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
children (list of vmware.vapi.struct.VapiStruct or None) – subtree for this type within policy tree containing nested elements. When clients pass a value of this class as a parameter, the attribute must contain all the attributes defined in ChildPolicyConfigResource. When methods return a value of this class as a return value, the attribute will contain all the attributes defined in ChildPolicyConfigResource.
marked_for_delete (bool or None) – Intent objects are not directly deleted from the system when a delete is invoked on them. They are marked for deletion and only when all the realized entities for that intent object gets deleted, the intent object is deleted. Objects that are marked for deletion are not returned in GET call. One can use the search API to get these objects. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
details (list of X509Certificate or None) – list of X509Certificates. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
pem_encoded (str) – pem encoded certificate data.

class com.vmware.nsx_policy.model_client.TlsCertificateList(links=None, schema=None, self_=None, cursor=None, result_count=None, sort_ascending=None, sort_by=None, results=None)¶

Bases: vmware.vapi.bindings.struct.VapiStruct

Certificate queries result

Tip

The arguments are used to initialize data attributes with the same names.

Parameters

links (list of ResourceLink or None) – The server will populate this field when returing the resource. Ignored on PUT and POST. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
schema (str or None) – Schema for this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
self (SelfResourceLink or None) – Link to this resource
cursor (str or None) – Opaque cursor to be used for getting next page of records (supplied by current result page) This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
result_count (long or None) – Count of results found (across all pages), set only on first page format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
sort_ascending (bool or None) – If true, results are sorted in ascending order This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
sort_by (str or None) – Field by which records are sorted This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
results (list of TlsCertificate or None) – TlsCertificate list. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.

class com.vmware.nsx_policy.model_client.TlsCrl(links=None, schema=None, self_=None, revision=None, create_time=None, create_user=None, last_modified_time=None, last_modified_user=None, protection=None, system_owned=None, description=None, display_name=None, id=None, resource_type=None, tags=None, parent_path=None, path=None, relative_path=None, children=None, marked_for_delete=None, details=None, pem_encoded=None)¶

Bases: vmware.vapi.bindings.struct.VapiStruct

Tip

The arguments are used to initialize data attributes with the same names.

Parameters

links (list of ResourceLink or None) – The server will populate this field when returing the resource. Ignored on PUT and POST. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
schema (str or None) – Schema for this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
self (SelfResourceLink or None) – Link to this resource
revision (long or None) – The _revision property describes the current revision of the resource. To prevent clients from overwriting each other’s changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected. format: int32
create_time (long or None) – Timestamp of resource creation format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
create_user (str or None) – ID of the user who created this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
last_modified_time (long or None) – Timestamp of last modification format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
last_modified_user (str or None) – ID of the user who last modified this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
protection (str or None) – Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super user and can modify it, but only when providing the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this entity. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
system_owned (bool or None) – Indicates system owned resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
description (str or None) – Description of this resource
display_name (str or None) – Defaults to ID if not set
id (str or None) – Unique identifier of this resource
resource_type (str or None) – The type of this resource.
tags (list of Tag or None) – Opaque identifiers meaningful to the API user
parent_path (str or None) – Path of its parent This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
path (str or None) – Absolute path of this object This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
relative_path (str or None) – Path relative from its parent This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
children (list of vmware.vapi.struct.VapiStruct or None) – subtree for this type within policy tree containing nested elements. When clients pass a value of this class as a parameter, the attribute must contain all the attributes defined in ChildPolicyConfigResource. When methods return a value of this class as a return value, the attribute will contain all the attributes defined in ChildPolicyConfigResource.
marked_for_delete (bool or None) – Intent objects are not directly deleted from the system when a delete is invoked on them. They are marked for deletion and only when all the realized entities for that intent object gets deleted, the intent object is deleted. Objects that are marked for deletion are not returned in GET call. One can use the search API to get these objects. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
details (X509Crl or None) – Details of the X509Crl object.
pem_encoded (str) – Pem encoded crl data.

class com.vmware.nsx_policy.model_client.TlsCrlListResult(links=None, schema=None, self_=None, cursor=None, result_count=None, sort_ascending=None, sort_by=None, results=None)¶

Bases: vmware.vapi.bindings.struct.VapiStruct

Paged Collection of TlsCrl

Tip

The arguments are used to initialize data attributes with the same names.

Parameters

links (list of ResourceLink or None) – The server will populate this field when returing the resource. Ignored on PUT and POST. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
schema (str or None) – Schema for this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
self (SelfResourceLink or None) – Link to this resource
cursor (str or None) – Opaque cursor to be used for getting next page of records (supplied by current result page) This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
result_count (long or None) – Count of results found (across all pages), set only on first page format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
sort_ascending (bool or None) – If true, results are sorted in ascending order This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
sort_by (str or None) – Field by which records are sorted This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
results (list of TlsCrl) – TlsCrl list results

class com.vmware.nsx_policy.model_client.TlsTrustData(links=None, schema=None, self_=None, revision=None, create_time=None, create_user=None, last_modified_time=None, last_modified_user=None, protection=None, system_owned=None, description=None, display_name=None, id=None, resource_type=None, tags=None, parent_path=None, path=None, relative_path=None, children=None, marked_for_delete=None, key_algo=None, passphrase=None, pem_encoded=None, private_key=None)¶

Bases: vmware.vapi.bindings.struct.VapiStruct

Tip

The arguments are used to initialize data attributes with the same names.

Parameters

links (list of ResourceLink or None) – The server will populate this field when returing the resource. Ignored on PUT and POST. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
schema (str or None) – Schema for this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
self (SelfResourceLink or None) – Link to this resource
revision (long or None) – The _revision property describes the current revision of the resource. To prevent clients from overwriting each other’s changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected. format: int32
create_time (long or None) – Timestamp of resource creation format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
create_user (str or None) – ID of the user who created this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
last_modified_time (long or None) – Timestamp of last modification format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
last_modified_user (str or None) – ID of the user who last modified this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
protection (str or None) – Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super user and can modify it, but only when providing the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this entity. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
system_owned (bool or None) – Indicates system owned resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
description (str or None) – Description of this resource
display_name (str or None) – Defaults to ID if not set
id (str or None) – Unique identifier of this resource
resource_type (str or None) – The type of this resource.
tags (list of Tag or None) – Opaque identifiers meaningful to the API user
parent_path (str or None) – Path of its parent This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
path (str or None) – Absolute path of this object This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
relative_path (str or None) – Path relative from its parent This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
children (list of vmware.vapi.struct.VapiStruct or None) – subtree for this type within policy tree containing nested elements. When clients pass a value of this class as a parameter, the attribute must contain all the attributes defined in ChildPolicyConfigResource. When methods return a value of this class as a return value, the attribute will contain all the attributes defined in ChildPolicyConfigResource.
marked_for_delete (bool or None) – Intent objects are not directly deleted from the system when a delete is invoked on them. They are marked for deletion and only when all the realized entities for that intent object gets deleted, the intent object is deleted. Objects that are marked for deletion are not returned in GET call. One can use the search API to get these objects. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
key_algo (str or None) – Key algorithm contained in this certificate.
passphrase (str or None) – Password for private key encryption.
pem_encoded (str) – pem encoded certificate data.
private_key (str or None) – private key data

class com.vmware.nsx_policy.model_client.Tooltip(condition=None, heading=None, text=None)¶

Bases: vmware.vapi.bindings.struct.VapiStruct

Tooltip to be shown while hovering over the dashboard UI element.

Tip

The arguments are used to initialize data attributes with the same names.

Parameters

condition (str or None) – If the condition is met then the tooltip will be applied. If no condition is provided, then the tooltip will be applied unconditionally. Examples of expression syntax are provided under ‘example_request’ section of ‘CreateWidgetConfiguration’ API.
heading (bool or None) – If true, displays tooltip text in bold
text (str) – Text to be shown on tooltip while hovering over UI element. The text would be wrapped if it exceeds 80 chars.

class com.vmware.nsx_policy.model_client.TrafficRateLimits(rx_broadcast=None, rx_multicast=None, tx_broadcast=None, tx_multicast=None)¶

Bases: vmware.vapi.bindings.struct.VapiStruct

Enables traffic limit for incoming/outgoing broadcast and multicast packets. Use 0 to disable rate limiting for a specific traffic type

Tip

The arguments are used to initialize data attributes with the same names.

Parameters

rx_broadcast (long or None) – Incoming broadcast traffic limit in packets per second format: int32
rx_multicast (long or None) – Incoming multicast traffic limit in packets per second format: int32
tx_broadcast (long or None) – Outgoing broadcast traffic limit in packets per second format: int32
tx_multicast (long or None) – Outgoing multicast traffic limit in packets per second format: int32

class com.vmware.nsx_policy.model_client.TunnelInterfaceIPSubnet(ip_addresses=None, prefix_length=None)¶

Bases: vmware.vapi.bindings.struct.VapiStruct

Tip

The arguments are used to initialize data attributes with the same names.

Parameters

ip_addresses (list of str) – IPv4 Addresses format: ipv4
prefix_length (long) – Subnet Prefix Length format: int64

class com.vmware.nsx_policy.model_client.TunnelSubnet(ip_addresses=None, prefix_length=None)¶

Bases: vmware.vapi.bindings.struct.VapiStruct

Tip

The arguments are used to initialize data attributes with the same names.

Parameters

ip_addresses (list of str) – Subnet ip addresses format: ipv4
prefix_length (long) – Subnet Prefix Length format: int64

class com.vmware.nsx_policy.model_client.UdpPolicyLbMonitorProfile(receive=None, send=None, links=None, schema=None, self_=None, revision=None, create_time=None, create_user=None, last_modified_time=None, last_modified_user=None, protection=None, system_owned=None, description=None, display_name=None, id=None, resource_type='UdpPolicyLbMonitorProfile', tags=None, parent_path=None, path=None, relative_path=None, children=None, marked_for_delete=None, fall_count=None, interval=None, monitor_port=None, rise_count=None, timeout=None)¶

Bases: vmware.vapi.bindings.struct.VapiStruct

Active healthchecks are disabled by default and can be enabled for a server pool by binding a health monitor to the Group through the PolicyLbRule object. This represents active health monitoring over UDP. Active healthchecks are initiated periodically, at a configurable interval, to each member of the Group. Only if a healthcheck fails consecutively for a specified number of times (fall_count) to a member will the member status be marked DOWN. Once a member is DOWN, a specified number of consecutive successful healthchecks (rise_count) will bring the member back to UP state. After a healthcheck is initiated, if it does not complete within a certain period, then also the healthcheck is considered to be unsuccessful. Completing a healthcheck within timeout means establishing a connection (TCP or SSL), if applicable, sending the request and receiving the response, all within the configured timeout.

Tip

The arguments are used to initialize data attributes with the same names.

Parameters

receive (str) – Expected data, can be anywhere in the response and it has to be a string, regular expressions are not supported. UDP healthcheck is considered failed if there is no server response within the timeout period.
send (str) – The data to be sent to the monitored server.
links (list of ResourceLink or None) – The server will populate this field when returing the resource. Ignored on PUT and POST. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
schema (str or None) – Schema for this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
self (SelfResourceLink or None) – Link to this resource
revision (long or None) – The _revision property describes the current revision of the resource. To prevent clients from overwriting each other’s changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected. format: int32
create_time (long or None) – Timestamp of resource creation format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
create_user (str or None) – ID of the user who created this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
last_modified_time (long or None) – Timestamp of last modification format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
last_modified_user (str or None) – ID of the user who last modified this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
protection (str or None) – Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super user and can modify it, but only when providing the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this entity. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
system_owned (bool or None) – Indicates system owned resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
description (str or None) – Description of this resource
display_name (str or None) – Defaults to ID if not set
id (str or None) – Unique identifier of this resource
resource_type (str) –
Possible values are:
- PolicyLbMonitorProfile.RESOURCE_TYPE_TCPPOLICYLBMONITORPROFILE
- PolicyLbMonitorProfile.RESOURCE_TYPE_UDPPOLICYLBMONITORPROFILE
- PolicyLbMonitorProfile.RESOURCE_TYPE_ICMPPOLICYLBMONITORPROFILE
- PolicyLbMonitorProfile.RESOURCE_TYPE_HTTPPOLICYLBMONITORPROFILE
- PolicyLbMonitorProfile.RESOURCE_TYPE_HTTPSPOLICYLBMONITORPROFILE
tags (list of Tag or None) – Opaque identifiers meaningful to the API user
parent_path (str or None) – Path of its parent This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
path (str or None) – Absolute path of this object This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
relative_path (str or None) – Path relative from its parent This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
children (list of vmware.vapi.struct.VapiStruct or None) – subtree for this type within policy tree containing nested elements. When clients pass a value of this class as a parameter, the attribute must contain all the attributes defined in ChildPolicyConfigResource. When methods return a value of this class as a return value, the attribute will contain all the attributes defined in ChildPolicyConfigResource.
marked_for_delete (bool or None) – Intent objects are not directly deleted from the system when a delete is invoked on them. They are marked for deletion and only when all the realized entities for that intent object gets deleted, the intent object is deleted. Objects that are marked for deletion are not returned in GET call. One can use the search API to get these objects. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
fall_count (long or None) – Only if a healthcheck fails consecutively for a specified number of times, given with fall_count, to a member will the member status be marked DOWN. format: int64
interval (long or None) – Active healthchecks are initiated periodically, at a configurable interval (in seconds), to each member of the Group. format: int64
monitor_port (long or None) – Typically, monitors perform healthchecks to Group members using the member IP address and pool_port. However, in some cases, customers prefer to run healthchecks against a different port than the pool member port which handles actual application traffic. In such cases, the port to run healthchecks against can be specified in the monitor_port value. format: int32
rise_count (long or None) – Once a member is DOWN, a specified number of consecutive successful healthchecks specified by rise_count will bring the member back to UP state. format: int64
timeout (long or None) – Timeout specified in seconds. After a healthcheck is initiated, if it does not complete within a certain period, then also the healthcheck is considered to be unsuccessful. Completing a healthcheck within timeout means establishing a connection (TCP or SSL), if applicable, sending the request and receiving the response, all within the configured timeout. format: int64

property resource_type¶: Return the discriminator value

class com.vmware.nsx_policy.model_client.UdpPolicyLbVirtualServer(links=None, schema=None, self_=None, revision=None, create_time=None, create_user=None, last_modified_time=None, last_modified_user=None, protection=None, system_owned=None, description=None, display_name=None, id=None, resource_type='UdpPolicyLbVirtualServer', tags=None, parent_path=None, path=None, relative_path=None, children=None, marked_for_delete=None, access_log_enabled=None, ip_address=None, lb_persistence_profile=None, ports=None, router_path=None, traffic_source=None)¶

Bases: vmware.vapi.bindings.struct.VapiStruct

Virtual server acts as a facade to an application, receives all client connections over UDP and distributes them among the backend servers.

Tip

The arguments are used to initialize data attributes with the same names.

Parameters

links (list of ResourceLink or None) – The server will populate this field when returing the resource. Ignored on PUT and POST. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
schema (str or None) – Schema for this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
self (SelfResourceLink or None) – Link to this resource
revision (long or None) – The _revision property describes the current revision of the resource. To prevent clients from overwriting each other’s changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected. format: int32
create_time (long or None) – Timestamp of resource creation format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
create_user (str or None) – ID of the user who created this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
last_modified_time (long or None) – Timestamp of last modification format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
last_modified_user (str or None) – ID of the user who last modified this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
protection (str or None) – Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super user and can modify it, but only when providing the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this entity. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
system_owned (bool or None) – Indicates system owned resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
description (str or None) – Description of this resource
display_name (str or None) – Defaults to ID if not set
id (str or None) – Unique identifier of this resource
resource_type (str) –
Possible values are:
- PolicyLbVirtualServer.RESOURCE_TYPE_TCPPOLICYLBVIRTUALSERVER
- PolicyLbVirtualServer.RESOURCE_TYPE_UDPPOLICYLBVIRTUALSERVER
- PolicyLbVirtualServer.RESOURCE_TYPE_HTTPPOLICYLBVIRTUALSERVER
- PolicyLbVirtualServer.RESOURCE_TYPE_HTTPSPOLICYLBVIRTUALSERVER
- PolicyLbVirtualServer.RESOURCE_TYPE_CUSTOMPOLICYLBVIRTUALSERVER
tags (list of Tag or None) – Opaque identifiers meaningful to the API user
parent_path (str or None) – Path of its parent This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
path (str or None) – Absolute path of this object This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
relative_path (str or None) – Path relative from its parent This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
children (list of vmware.vapi.struct.VapiStruct or None) – subtree for this type within policy tree containing nested elements. When clients pass a value of this class as a parameter, the attribute must contain all the attributes defined in ChildPolicyConfigResource. When methods return a value of this class as a return value, the attribute will contain all the attributes defined in ChildPolicyConfigResource.
marked_for_delete (bool or None) – Intent objects are not directly deleted from the system when a delete is invoked on them. They are marked for deletion and only when all the realized entities for that intent object gets deleted, the intent object is deleted. Objects that are marked for deletion are not returned in GET call. One can use the search API to get these objects. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
access_log_enabled (bool or None) – If access log is enabled, all HTTP requests sent to an L7 virtual server are logged to the access log file. Both successful requests (backend server returns 2xx) and unsuccessful requests (backend server returns 4xx or 5xx) are logged to access log, if enabled.
ip_address (str) – Configures the IP address of the PolicyLbVirtualServer where it receives all client connections and distributes them among the backend servers. format: ip
lb_persistence_profile (str or None) – Path to optional object that enables persistence on a virtual server allowing related client connections to be sent to the same backend server. Persistence is disabled by default.
ports (list of str) – Ports contains a list of at least one port or port range such as “80”, “1234-1236”. Each port element in the list should be a single port or a single port range. format: port-or-range
router_path (str) – Path to router type object that PolicyLbVirtualServer connects to. The only supported router object is Network.
traffic_source (str or None) –

property resource_type¶: Return the discriminator value

class com.vmware.nsx_policy.model_client.UnaryOperation(operand=None, operator=None)¶

Bases: vmware.vapi.bindings.struct.VapiStruct

Unary Operation.

Tip

The arguments are used to initialize data attributes with the same names.

Parameters

operand (ResourceFieldPointer) – Represents an argument of the operation pointing to a specific field value.
operator (str) –
Possible values are:
- UnaryOperation.OPERATOR_APPEND
- UnaryOperation.OPERATOR_SUBTRACT
Logical Operator describing the operation to apply to the operand.

OPERATOR_APPEND = 'APPEND'¶

OPERATOR_SUBTRACT = 'SUBTRACT'¶

class com.vmware.nsx_policy.model_client.UnaryOperationBasedInjectionValue(initial_value=None, operation=None, resource_type='UnaryOperationBasedInjectionValue')¶

Bases: vmware.vapi.bindings.struct.VapiStruct

Operation based Injection Value.

Tip

The arguments are used to initialize data attributes with the same names.

Parameters

initial_value (ResourceFieldPointer) – Resource field pointer representing the initial value for the injection value. If an operation is supplied, the value is handed to the operation function to produce a final result.
operation (UnaryOperation or None) – Represents an optional operation to be done on the initial value.
resource_type (str) –
Possible values are:
- InjectionValue.RESOURCE_TYPE_UNARYOPERATIONBASEDINJECTIONVALUE
  
  Injection Value resource type.

property resource_type¶: Return the discriminator value

class com.vmware.nsx_policy.model_client.UrlAlias(alias=None, query=None, url=None)¶

Bases: vmware.vapi.bindings.struct.VapiStruct

Short name or alias of a url. It is used to represent the url.

Tip

The arguments are used to initialize data attributes with the same names.

Parameters

alias (str or None) –
query (str or None) – Search query to be applied, if any. If query string is not provided, it will be ignored.
url (str) – Url to fetch data from.

class com.vmware.nsx_policy.model_client.ValueConstraintExpression(operator=None, values=None, links=None, schema=None, self_=None, revision=None, create_time=None, create_user=None, last_modified_time=None, last_modified_user=None, protection=None, system_owned=None, description=None, display_name=None, id=None, resource_type='ValueConstraintExpression', tags=None)¶

Bases: vmware.vapi.bindings.struct.VapiStruct

Represents the leaf level value constraint to constrain specified attribute value to the set of values to be allowed/not-allowed. Example - sourceGroups allowed to have only with list of groups. { “operator”:”INCLUDES”, “values”:[“/infra/services/HTTP”, “/infra/services/HTTPS”] }

Tip

The arguments are used to initialize data attributes with the same names.

Parameters

operator (str) –
Possible values are:
Operation to check for value list for resource attribute of constraint.
values (list of str) – List of values.
links (list of ResourceLink or None) – The server will populate this field when returing the resource. Ignored on PUT and POST. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
schema (str or None) – Schema for this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
self (SelfResourceLink or None) – Link to this resource
revision (long or None) – The _revision property describes the current revision of the resource. To prevent clients from overwriting each other’s changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected. format: int32
create_time (long or None) – Timestamp of resource creation format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
create_user (str or None) – ID of the user who created this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
last_modified_time (long or None) – Timestamp of last modification format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
last_modified_user (str or None) – ID of the user who last modified this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
protection (str or None) – Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super user and can modify it, but only when providing the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this entity. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
system_owned (bool or None) – Indicates system owned resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
description (str or None) – Description of this resource
display_name (str or None) – Defaults to ID if not set
id (str or None) – Unique identifier of this resource
resource_type (str) –
Possible values are:
tags (list of Tag or None) – Opaque identifiers meaningful to the API user

OPERATOR_EQUALS = 'EQUALS'¶

OPERATOR_EXCLUDES = 'EXCLUDES'¶

OPERATOR_INCLUDES = 'INCLUDES'¶

property resource_type¶: Return the discriminator value

class com.vmware.nsx_policy.model_client.View(links=None, schema=None, self_=None, revision=None, create_time=None, create_user=None, last_modified_time=None, last_modified_user=None, protection=None, system_owned=None, description=None, display_name=None, id=None, resource_type=None, tags=None, exclude_roles=None, include_roles=None, shared=None, weight=None, widgets=None)¶

Bases: vmware.vapi.bindings.struct.VapiStruct

Describes the configuration of a view to be displayed on the dashboard.

Tip

The arguments are used to initialize data attributes with the same names.

Parameters

links (list of ResourceLink or None) – The server will populate this field when returing the resource. Ignored on PUT and POST. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
schema (str or None) – Schema for this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
self (SelfResourceLink or None) – Link to this resource
revision (long or None) – The _revision property describes the current revision of the resource. To prevent clients from overwriting each other’s changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected. format: int32
create_time (long or None) – Timestamp of resource creation format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
create_user (str or None) – ID of the user who created this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
last_modified_time (long or None) – Timestamp of last modification format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
last_modified_user (str or None) – ID of the user who last modified this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
protection (str or None) – Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super user and can modify it, but only when providing the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this entity. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
system_owned (bool or None) – Indicates system owned resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
description (str or None) – Description of this resource
display_name (str) – Title of the widget.
id (str or None) – Unique identifier of this resource
resource_type (str or None) – The type of this resource.
tags (list of Tag or None) – Opaque identifiers meaningful to the API user
exclude_roles (str or None) – Comma separated list of roles to which the shared view is not visible. Allows user to prevent the visibility of a shared view to the specified roles. User defined roles can also be specified in the list. The roles can be obtained via GET /api/v1/aaa/roles. Please visit API documentation for details about roles. If include_roles is specified then exclude_roles cannot be specified.
include_roles (str or None) – Comma separated list of roles to which the shared view is visible. Allows user to specify the visibility of a shared view to the specified roles. User defined roles can also be specified in the list. The roles can be obtained via GET /api/v1/aaa/roles. Please visit API documentation for details about roles.
shared (bool or None) – Defaults to false. Set to true to publish the view to other users. The widgets of a shared view are visible to other users.
weight (long or None) – Determines placement of view relative to other views. The lower the weight, the higher it is in the placement order. format: int32
widgets (list of WidgetItem) – Array of widgets that are part of the view.

class com.vmware.nsx_policy.model_client.ViewList(views=None)¶

Bases: vmware.vapi.bindings.struct.VapiStruct

Represents a list of views.

Tip

The arguments are used to initialize data attributes with the same names.

Parameters: views (list of View or None) – Array of views This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.

class com.vmware.nsx_policy.model_client.VirtualEndpoint(service_names=None, links=None, schema=None, self_=None, revision=None, create_time=None, create_user=None, last_modified_time=None, last_modified_user=None, protection=None, system_owned=None, description=None, display_name=None, id=None, resource_type='VirtualEndpoint', tags=None, parent_path=None, path=None, relative_path=None, children=None, marked_for_delete=None, target_ips=None)¶

Bases: vmware.vapi.bindings.struct.VapiStruct

A VirtualEndpoint represents an IP (or nexthop) which is outside SDDC. It represents a redirection target for RedirectionPolicy.

Tip

The arguments are used to initialize data attributes with the same names.

Parameters

service_names (list of str) – One VirtualEndpoint will be created per service name.
links (list of ResourceLink or None) – The server will populate this field when returing the resource. Ignored on PUT and POST. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
schema (str or None) – Schema for this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
self (SelfResourceLink or None) – Link to this resource
revision (long or None) – The _revision property describes the current revision of the resource. To prevent clients from overwriting each other’s changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected. format: int32
create_time (long or None) – Timestamp of resource creation format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
create_user (str or None) – ID of the user who created this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
last_modified_time (long or None) – Timestamp of last modification format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
last_modified_user (str or None) – ID of the user who last modified this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
protection (str or None) – Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super user and can modify it, but only when providing the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this entity. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
system_owned (bool or None) – Indicates system owned resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
description (str or None) – Description of this resource
display_name (str or None) – Defaults to ID if not set
id (str or None) – Unique identifier of this resource
resource_type (str) –
Possible values are:
- BaseEndpoint.RESOURCE_TYPE_VIRTUALENDPOINT
- BaseEndpoint.RESOURCE_TYPE_SERVICEINSTANCEENDPOINT
tags (list of Tag or None) – Opaque identifiers meaningful to the API user
parent_path (str or None) – Path of its parent This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
path (str or None) – Absolute path of this object This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
relative_path (str or None) – Path relative from its parent This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
children (list of vmware.vapi.struct.VapiStruct or None) – subtree for this type within policy tree containing nested elements. When clients pass a value of this class as a parameter, the attribute must contain all the attributes defined in ChildPolicyConfigResource. When methods return a value of this class as a return value, the attribute will contain all the attributes defined in ChildPolicyConfigResource.
marked_for_delete (bool or None) – Intent objects are not directly deleted from the system when a delete is invoked on them. They are marked for deletion and only when all the realized entities for that intent object gets deleted, the intent object is deleted. Objects that are marked for deletion are not returned in GET call. One can use the search API to get these objects. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
target_ips (list of IPInfo) – IPs where either inbound or outbound traffic is to be redirected.

property resource_type¶: Return the discriminator value

class com.vmware.nsx_policy.model_client.VirtualEndpointListResult(links=None, schema=None, self_=None, cursor=None, result_count=None, sort_ascending=None, sort_by=None, results=None)¶

Bases: vmware.vapi.bindings.struct.VapiStruct

Collection of vitual endpoints under a Tier0

Tip

The arguments are used to initialize data attributes with the same names.

Parameters

links (list of ResourceLink or None) – The server will populate this field when returing the resource. Ignored on PUT and POST. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
schema (str or None) – Schema for this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
self (SelfResourceLink or None) – Link to this resource
cursor (str or None) – Opaque cursor to be used for getting next page of records (supplied by current result page) This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
result_count (long or None) – Count of results found (across all pages), set only on first page format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
sort_ascending (bool or None) – If true, results are sorted in ascending order This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
sort_by (str or None) – Field by which records are sorted This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
results (list of VirtualEndpoint) – All virtual endpoints under a Tier0

class com.vmware.nsx_policy.model_client.VirtualMachine(compute_ids=None, external_id=None, guest_info=None, host_id=None, local_id_on_host=None, power_state=None, source=None, type=None, links=None, schema=None, self_=None, last_sync_time=None, description=None, display_name=None, resource_type='VirtualMachine', tags=None)¶

Bases: vmware.vapi.bindings.struct.VapiStruct

Tip

The arguments are used to initialize data attributes with the same names.

Parameters

compute_ids (list of str) – List of external compute ids of the virtual machine in the format ‘id-type-key:value’ , list of external compute ids [‘uuid:xxxx-xxxx-xxxx-xxxx’, ‘moIdOnHost:moref-11’, ‘instanceUuid:xxxx-xxxx-xxxx-xxxx’]
external_id (str) – Current external id of this virtual machine in the system.
guest_info (GuestInfo or None) – Guest virtual machine details include OS name, computer name of guest VM. Currently this is supported for guests on ESXi that have VMware Tools installed.
host_id (str or None) – Id of the host in which this virtual machine exists.
local_id_on_host (str) – Id of the vm unique within the host.
power_state (str) –
Possible values are:
Current power state of this virtual machine in the system.
source (ResourceReference or None) – Reference of the Host or Public Cloud Gateway that reported the VM
type (str or None) –
Possible values are:
Virtual Machine type; Edge, Service VM or other.

This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
links (list of ResourceLink or None) – The server will populate this field when returing the resource. Ignored on PUT and POST. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
schema (str or None) – Schema for this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
self (SelfResourceLink or None) – Link to this resource
last_sync_time (long or None) – Timestamp of last modification format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
description (str or None) – Description of this resource
display_name (str or None) – Defaults to ID if not set
resource_type (str) – The type of this resource.
tags (list of Tag or None) – Opaque identifiers meaningful to the API user

POWER_STATE_UNKNOWN = 'UNKNOWN'¶

POWER_STATE_VM_RUNNING = 'VM_RUNNING'¶

POWER_STATE_VM_STOPPED = 'VM_STOPPED'¶

POWER_STATE_VM_SUSPENDED = 'VM_SUSPENDED'¶

TYPE_EDGE = 'EDGE'¶

TYPE_REGULAR = 'REGULAR'¶

TYPE_SERVICE = 'SERVICE'¶

property resource_type¶: Return the discriminator value

class com.vmware.nsx_policy.model_client.VirtualMachineListResult(links=None, schema=None, self_=None, cursor=None, result_count=None, sort_ascending=None, sort_by=None, results=None)¶

Bases: vmware.vapi.bindings.struct.VapiStruct

Tip

The arguments are used to initialize data attributes with the same names.

Parameters

links (list of ResourceLink or None) – The server will populate this field when returing the resource. Ignored on PUT and POST. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
schema (str or None) – Schema for this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
self (SelfResourceLink or None) – Link to this resource
cursor (str or None) – Opaque cursor to be used for getting next page of records (supplied by current result page) This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
result_count (long or None) – Count of results found (across all pages), set only on first page format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
sort_ascending (bool or None) – If true, results are sorted in ascending order This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
sort_by (str or None) – Field by which records are sorted This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
results (list of VirtualMachine) – VirtualMachine list results

class com.vmware.nsx_policy.model_client.VirtualMachineTagsUpdate(tags=None, virtual_machine_id=None)¶

Bases: vmware.vapi.bindings.struct.VapiStruct

List of tags applied to the virtual machine. Based on the enforcement point, the virtual_machine_id will be different. It could be an external id for NSX T or a moid for NSX V

Tip

The arguments are used to initialize data attributes with the same names.

Parameters

tags (list of Tag) – List of tags to be applied on the virtual machine
virtual_machine_id (str) – The identifier that is used in the enforcement point that uniquely identifies the virtual machine. In case of NSXT it would be the value of the external_id of the virtual machine.

class com.vmware.nsx_policy.model_client.VirtualNetworkInterface(device_key=None, device_name=None, external_id=None, host_id=None, ip_address_info=None, lport_attachment_id=None, mac_address=None, owner_vm_id=None, owner_vm_type=None, vm_local_id_on_host=None, links=None, schema=None, self_=None, last_sync_time=None, description=None, display_name=None, resource_type='VirtualNetworkInterface', tags=None)¶

Bases: vmware.vapi.bindings.struct.VapiStruct

Tip

The arguments are used to initialize data attributes with the same names.

Parameters

device_key (str) – Device key of the virtual network interface.
device_name (str or None) – Device name of the virtual network interface.
external_id (str) – External Id of the virtual network inferface.
host_id (str) – Id of the host on which the vm exists.
ip_address_info (list of IpAddressInfo or None) – IP Addresses of the the virtual network interface, from various sources.
lport_attachment_id (str or None) – LPort Attachment Id of the virtual network interface.
mac_address (str) – MAC address of the virtual network interface.
owner_vm_id (str) – Id of the vm to which this virtual network interface belongs.
owner_vm_type (str or None) –
Possible values are:
Owner virtual machine type; Edge, Service VM or other.

This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
vm_local_id_on_host (str) – Id of the vm unique within the host.
links (list of ResourceLink or None) – The server will populate this field when returing the resource. Ignored on PUT and POST. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
schema (str or None) – Schema for this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
self (SelfResourceLink or None) – Link to this resource
last_sync_time (long or None) – Timestamp of last modification format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
description (str or None) – Description of this resource
display_name (str or None) – Defaults to ID if not set
resource_type (str) – The type of this resource.
tags (list of Tag or None) – Opaque identifiers meaningful to the API user

OWNER_VM_TYPE_EDGE = 'EDGE'¶

OWNER_VM_TYPE_REGULAR = 'REGULAR'¶

OWNER_VM_TYPE_SERVICE = 'SERVICE'¶

property resource_type¶: Return the discriminator value

class com.vmware.nsx_policy.model_client.VirtualNetworkInterfaceListResult(links=None, schema=None, self_=None, cursor=None, result_count=None, sort_ascending=None, sort_by=None, results=None)¶

Bases: vmware.vapi.bindings.struct.VapiStruct

Tip

The arguments are used to initialize data attributes with the same names.

Parameters

links (list of ResourceLink or None) – The server will populate this field when returing the resource. Ignored on PUT and POST. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
schema (str or None) – Schema for this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
self (SelfResourceLink or None) – Link to this resource
cursor (str or None) – Opaque cursor to be used for getting next page of records (supplied by current result page) This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
result_count (long or None) – Count of results found (across all pages), set only on first page format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
sort_ascending (bool or None) – If true, results are sorted in ascending order This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
sort_by (str or None) – Field by which records are sorted This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
results (list of VirtualNetworkInterface) – VirtualNetworkInterface list results

class com.vmware.nsx_policy.model_client.VmToolsInfo(external_id=None, file_agent_version=None, host_local_id=None, network_agent_version=None, source=None, tools_version=None, vm_type=None, links=None, schema=None, self_=None, last_sync_time=None, description=None, display_name=None, resource_type='VmToolsInfo', tags=None)¶

Bases: vmware.vapi.bindings.struct.VapiStruct

Tip

The arguments are used to initialize data attributes with the same names.

Parameters

external_id (str or None) – Current external id of this virtual machine in the system. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
file_agent_version (str or None) – Version of file agent on the VM of a third party partner solution. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
host_local_id (str or None) – Id of the VM which is assigned locally by the host. It is the VM-moref on ESXi hosts, in other environments it is VM UUID. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
network_agent_version (str or None) – Version of network agent on the VM of a third party partner solution. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
source (ResourceReference or None) – Reference of the Host or Public Cloud Gateway that reported the VM.
tools_version (str or None) – Version of VMTools installed on the VM. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
vm_type (str or None) –
Possible values are:
Type of VM - Edge, Service or other.

This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
links (list of ResourceLink or None) – The server will populate this field when returing the resource. Ignored on PUT and POST. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
schema (str or None) – Schema for this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
self (SelfResourceLink or None) – Link to this resource
last_sync_time (long or None) – Timestamp of last modification format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
description (str or None) – Description of this resource
display_name (str or None) – Defaults to ID if not set
resource_type (str) – The type of this resource.
tags (list of Tag or None) – Opaque identifiers meaningful to the API user

VM_TYPE_EDGE = 'EDGE'¶

VM_TYPE_REGULAR = 'REGULAR'¶

VM_TYPE_SERVICE = 'SERVICE'¶

property resource_type¶: Return the discriminator value

class com.vmware.nsx_policy.model_client.WidgetConfiguration(links=None, schema=None, self_=None, revision=None, create_time=None, create_user=None, last_modified_time=None, last_modified_user=None, protection=None, system_owned=None, description=None, display_name=None, id=None, resource_type='WidgetConfiguration', tags=None, datasources=None, drilldown_id=None, footer=None, icons=None, is_drilldown=None, legend=None, shared=None, weight=None)¶

Bases: vmware.vapi.bindings.struct.VapiStruct

Describes the configuration of a widget to be displayed on the dashboard. WidgetConfiguration is a base type that provides attributes of a widget in-general.

Tip

The arguments are used to initialize data attributes with the same names.

Parameters

links (list of ResourceLink or None) – The server will populate this field when returing the resource. Ignored on PUT and POST. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
schema (str or None) – Schema for this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
self (SelfResourceLink or None) – Link to this resource
revision (long or None) – The _revision property describes the current revision of the resource. To prevent clients from overwriting each other’s changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected. format: int32
create_time (long or None) – Timestamp of resource creation format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
create_user (str or None) – ID of the user who created this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
last_modified_time (long or None) – Timestamp of last modification format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
last_modified_user (str or None) – ID of the user who last modified this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
protection (str or None) – Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super user and can modify it, but only when providing the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this entity. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
system_owned (bool or None) – Indicates system owned resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
description (str or None) – Description of this resource
display_name (str or None) – Title of the widget. If display_name is omitted, the widget will be shown without a title.
id (str or None) – Unique identifier of this resource
resource_type (str) –
Possible values are:
- WidgetConfiguration.RESOURCE_TYPE_LABELVALUECONFIGURATION
- WidgetConfiguration.RESOURCE_TYPE_DONUTCONFIGURATION
- WidgetConfiguration.RESOURCE_TYPE_MULTIWIDGETCONFIGURATION
- WidgetConfiguration.RESOURCE_TYPE_CONTAINERCONFIGURATION
- WidgetConfiguration.RESOURCE_TYPE_STATSCONFIGURATION
- WidgetConfiguration.RESOURCE_TYPE_GRIDCONFIGURATION
- WidgetConfiguration.RESOURCE_TYPE_GRAPHCONFIGURATION
Supported visualization types are LabelValueConfiguration, DonutConfiguration, GridConfiguration, StatsConfiguration, MultiWidgetConfiguration, GraphConfiguration and ContainerConfiguration.
tags (list of Tag or None) – Opaque identifiers meaningful to the API user
datasources (list of Datasource or None) – The ‘datasources’ represent the sources from which data will be fetched. Currently, only NSX-API is supported as a ‘default’ datasource. An example of specifying ‘default’ datasource along with the urls to fetch data from is given at ‘example_request’ section of ‘CreateWidgetConfiguration’ API.
drilldown_id (str or None) – Id of drilldown widget, if any. Id should be a valid id of an existing widget. A widget is considered as drilldown widget when it is associated with any other widget and provides more detailed information about any data item from the parent widget.
footer (Footer or None) –
icons (list of Icon or None) – Icons to be applied at dashboard for widgets and UI elements.
is_drilldown (bool or None) – Set to true if this widget should be used as a drilldown.
legend (Legend or None) – Legend to be displayed. If legend is not needed, do not include it.
shared (bool or None) – Please use the property ‘shared’ of View instead of this. The widgets of a shared view are visible to other users.
weight (long or None) – Specify relavite weight in WidgetItem for placement in a view. Please see WidgetItem for details. format: int32

RESOURCE_TYPE_CONTAINERCONFIGURATION = 'ContainerConfiguration'¶

RESOURCE_TYPE_DONUTCONFIGURATION = 'DonutConfiguration'¶

RESOURCE_TYPE_GRAPHCONFIGURATION = 'GraphConfiguration'¶

RESOURCE_TYPE_GRIDCONFIGURATION = 'GridConfiguration'¶

RESOURCE_TYPE_LABELVALUECONFIGURATION = 'LabelValueConfiguration'¶

RESOURCE_TYPE_MULTIWIDGETCONFIGURATION = 'MultiWidgetConfiguration'¶

RESOURCE_TYPE_STATSCONFIGURATION = 'StatsConfiguration'¶

property resource_type¶: Return the discriminator value

class com.vmware.nsx_policy.model_client.WidgetConfigurationList(widgetconfigurations=None)¶

Bases: vmware.vapi.bindings.struct.VapiStruct

Represents a list of widget configurations.

Tip

The arguments are used to initialize data attributes with the same names.

Parameters: widgetconfigurations (list of vmware.vapi.struct.VapiStruct or None) – Array of widget configurations When clients pass a value of this class as a parameter, the attribute must contain all the attributes defined in WidgetConfiguration. When methods return a value of this class as a return value, the attribute will contain all the attributes defined in WidgetConfiguration. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.

class com.vmware.nsx_policy.model_client.WidgetItem(alignment=None, label=None, separator=None, weight=None, widget_id=None)¶

Bases: vmware.vapi.bindings.struct.VapiStruct

Represents a reference to a widget that is held by a container or a multi-widget or a View.

Tip

The arguments are used to initialize data attributes with the same names.

Parameters

alignment (str or None) –
Possible values are:
- WidgetItem.ALIGNMENT_LEFT
- WidgetItem.ALIGNMENT_RIGHT
Aligns widget either left or right.
label (Label or None) – Applicable for ‘DonutConfiguration’ and ‘StatsConfiguration’ reports only. If label is not specified, then it defaults to the label of the donut or stats report.
separator (bool or None) – If true, separates this widget in a container.
weight (long or None) – Determines placement of widget or container relative to other widgets and containers. The lower the weight, the higher it is in the placement order. format: int32
widget_id (str) – Id of the widget configuration that is held by a multi-widget or a container or a view.

ALIGNMENT_LEFT = 'LEFT'¶

ALIGNMENT_RIGHT = 'RIGHT'¶

class com.vmware.nsx_policy.model_client.X509Certificate(dsa_public_keyg=None, dsa_public_keyp=None, dsa_public_keyq=None, dsa_public_keyy=None, ecdsa_curve_name=None, ecdsa_ec_field=None, ecdsa_ec_field_f2mks=None, ecdsa_ec_field_f2mm=None, ecdsa_ec_field_f2mrp=None, ecdsa_ec_field_f2pp=None, ecdsa_public_keya=None, ecdsa_public_keyb=None, ecdsa_public_key_cofactor=None, ecdsa_public_key_generatorx=None, ecdsa_public_key_generatory=None, ecdsa_public_key_order=None, ecdsa_public_key_seed=None, is_ca=None, is_valid=None, issuer=None, issuer_cn=None, not_after=None, not_before=None, public_key_algo=None, public_key_length=None, rsa_public_key_exponent=None, rsa_public_key_modulus=None, serial_number=None, signature=None, signature_algorithm=None, subject=None, subject_cn=None, version=None)¶

Bases: vmware.vapi.bindings.struct.VapiStruct

Tip

The arguments are used to initialize data attributes with the same names.

Parameters

dsa_public_keyg (str or None) – One of the DSA cryptogaphic algorithm’s strength parameters, base This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
dsa_public_keyp (str or None) – One of the DSA cryptogaphic algorithm’s strength parameters, prime This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
dsa_public_keyq (str or None) – One of the DSA cryptogaphic algorithm’s strength parameters, sub-prime This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
dsa_public_keyy (str or None) – One of the DSA cryptogaphic algorithm’s strength parameters This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
ecdsa_curve_name (str or None) – The Curve name for the ECDSA certificate. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
ecdsa_ec_field (str or None) –
Possible values are:
- X509Certificate.ECDSA_EC_FIELD_F2M
- X509Certificate.ECDSA_EC_FIELD_FP
Represents an elliptic curve (EC) finite field in ECDSA.

This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
ecdsa_ec_field_f2mks (list of long or None) – The order of the middle term(s) of the reduction polynomial in elliptic curve (EC) | characteristic 2 finite field.| Contents of this array are copied to protect against subsequent modification in ECDSA. format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
ecdsa_ec_field_f2mm (long or None) – The first coefficient of this elliptic curve in elliptic curve (EC) | characteristic 2 finite field for ECDSA. format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
ecdsa_ec_field_f2mrp (str or None) – The value whose i-th bit corresponds to the i-th coefficient of the reduction polynomial | in elliptic curve (EC) characteristic 2 finite field for ECDSA. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
ecdsa_ec_field_f2pp (str or None) – The specified prime for the elliptic curve prime finite field in ECDSA. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
ecdsa_public_keya (str or None) – The first coefficient of this elliptic curve in ECDSA. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
ecdsa_public_keyb (str or None) – The second coefficient of this elliptic curve in ECDSA. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
ecdsa_public_key_cofactor (long or None) – The co-factor in ECDSA. format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
ecdsa_public_key_generatorx (str or None) – x co-ordinate of G (the generator which is also known as the base point) in ECDSA. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
ecdsa_public_key_generatory (str or None) – y co-ordinate of G (the generator which is also known as the base point) in ECDSA. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
ecdsa_public_key_order (str or None) – The order of generator G in ECDSA. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
ecdsa_public_key_seed (list of str or None) – The bytes used during curve generation for later validation in ECDSA.| Contents of this array are copied to protect against subsequent modification. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
is_ca (bool or None) – True if this is a CA certificate. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
is_valid (bool or None) – True if this certificate is valid. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
issuer (str or None) – the certificate issuers complete distinguished name This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
issuer_cn (str or None) – the certificate issuer’s common name This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
not_after (long or None) – the time in epoch milliseconds at which the certificate becomes invalid format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
not_before (long or None) – the time in epoch milliseconds at which the certificate becomes valid format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
public_key_algo (str or None) –
Possible values are:
- X509Certificate.PUBLIC_KEY_ALGO_RSA
- X509Certificate.PUBLIC_KEY_ALGO_DSA
- X509Certificate.PUBLIC_KEY_ALGO_ECDSA
Cryptographic algorithm used by the public key for data encryption. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
public_key_length (long or None) – size measured in bits of the public/private keys used in a cryptographic algorithm format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
rsa_public_key_exponent (str or None) – An RSA public key is made up of the modulus and the public exponent. Exponent is a power number This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
rsa_public_key_modulus (str or None) – An RSA public key is made up of the modulus and the public exponent. Modulus is wrap around number This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
serial_number (str or None) – certificate’s serial number This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
signature (str or None) – the signature value(the raw signature bits) used for signing and validate the cert This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
signature_algorithm (str or None) – the algorithm used by the Certificate Authority to sign the certificate This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
subject (str or None) – the certificate owners complete distinguished name This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
subject_cn (str or None) – the certificate owner’s common name This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
version (str or None) – Certificate version (default v1) This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.

ECDSA_EC_FIELD_F2M = 'F2M'¶

ECDSA_EC_FIELD_FP = 'FP'¶

PUBLIC_KEY_ALGO_DSA = 'DSA'¶

PUBLIC_KEY_ALGO_ECDSA = 'ECDSA'¶

PUBLIC_KEY_ALGO_RSA = 'RSA'¶

class com.vmware.nsx_policy.model_client.X509Crl(crl_entries=None, issuer=None, next_update=None, version=None)¶

Bases: vmware.vapi.bindings.struct.VapiStruct

A CRL is a time-stamped list identifying revoked certificates.

Tip

The arguments are used to initialize data attributes with the same names.

Parameters

crl_entries (list of X509CrlEntry or None) – list of X509CrlEntry This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
issuer (str or None) – Issuer’s distinguished name(DN) This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
next_update (str or None) – Next update time for the CRL This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
version (str or None) – CRL’s version number either 1 or 2 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.

class com.vmware.nsx_policy.model_client.X509CrlEntry(revocation_date=None, serial_number=None)¶

Bases: vmware.vapi.bindings.struct.VapiStruct

Each revoked certificate is identified in a CRL by its certificate serial number.

Tip

The arguments are used to initialize data attributes with the same names.

Parameters

revocation_date (str or None) – Revocation date This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
serial_number (str or None) – the revoked certificate’s serial number This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.

com.vmware.nsx_policy.ui_views_client module¶

class com.vmware.nsx_policy.ui_views_client.StubFactory(stub_config)¶

Bases: vmware.vapi.bindings.stub.StubFactoryBase

Initialize StubFactoryBase

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

class com.vmware.nsx_policy.ui_views_client.Widgetconfigurations(config)¶

Bases: vmware.vapi.bindings.stub.VapiInterface

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

create(view_id, widget_configuration)¶

Creates a new Widget Configuration and adds it to the specified view. Supported resource_types are LabelValueConfiguration, DonutConfiguration, GridConfiguration, StatsConfiguration, MultiWidgetConfiguration, GraphConfiguration and ContainerConfiguration. Note: Expressions should be given in a single line. If an expression spans multiple lines, then form the expression in a single line. For label-value pairs, expressions are evaluated as follows: a. First, render configurations are evaluated in their order of appearance in the widget config. The ‘field’ is evaluated at the end. b. Second, when render configuration is provided then the order of evaluation is 1. If expressions provided in ‘condition’ and ‘display value’ are well-formed and free of runtime-errors such as ‘null pointers’ and evaluates to ‘true’; Then remaining render configurations are not evaluated, and the current render configuration’s ‘display value’ is taken as the final value. 2. If expression provided in ‘condition’ of render configuration is false, then next render configuration is evaluated. 3. Finally, ‘field’ is evaluated only when every render configuration evaluates to false and no error occurs during steps 1 and 2 above. If an error occurs during evaluation of render configuration, then an error message is shown. The display value corresponding to that label is not shown and evaluation of the remaining render configurations continues to collect and show all the error messages (marked with the ‘Label’ for identification) as ‘Error_Messages: {}’. If during evaluation of expressions for any label-value pair an error occurs, then it is marked with error. The errors are shown in the report, along with the label value pairs that are error-free. Important: For elements that take expressions, strings should be provided by escaping them with a back-slash. These elements are - condition, field, tooltip text and render_configuration’s display_value.

Parameters

view_id (str) – (required)
widget_configuration (vmware.vapi.struct.VapiStruct) – (required) The parameter must contain all the attributes defined in com.vmware.nsx_policy.model_client.WidgetConfiguration.

Return type

vmware.vapi.struct.VapiStruct

Returns

com.vmware.nsx_policy.model.WidgetConfiguration The return value will contain all the attributes defined in com.vmware.nsx_policy.model_client.WidgetConfiguration.

Raise

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

Raise

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

Raise

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

Raise

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

Raise

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

delete(view_id, widgetconfiguration_id)¶

Detaches widget from a given view. If the widget is no longer part of any view, then it will be purged.

Parameters

view_id (str) – (required)
widgetconfiguration_id (str) – (required)

Raise

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

Raise

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

Raise

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

Raise

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

Raise

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

get(view_id, container=None, widget_ids=None)¶

If no query params are specified then all the Widget Configurations of the specified view are returned.

Parameters

view_id (str) – (required)
container (str or None) – Id of the container (optional)
widget_ids (str or None) – Ids of the WidgetConfigurations (optional)

Return type

com.vmware.nsx_policy.model_client.WidgetConfigurationList

Returns

com.vmware.nsx_policy.model.WidgetConfigurationList

Raise

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

Raise

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

Raise

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

Raise

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

Raise

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

get_0(view_id, widgetconfiguration_id)¶

Returns Information about a specific Widget Configuration.

Parameters

view_id (str) – (required)
widgetconfiguration_id (str) – (required)

Return type

vmware.vapi.struct.VapiStruct

Returns

com.vmware.nsx_policy.model.WidgetConfiguration The return value will contain all the attributes defined in com.vmware.nsx_policy.model_client.WidgetConfiguration.

Raise

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

Raise

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

Raise

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

Raise

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

Raise

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

update(view_id, widgetconfiguration_id, widget_configuration)¶

Updates the widget at the given view. If the widget is referenced by other views, then the widget will be updated in all the views that it is part of.

Parameters

view_id (str) – (required)
widgetconfiguration_id (str) – (required)
widget_configuration (vmware.vapi.struct.VapiStruct) – (required) The parameter must contain all the attributes defined in com.vmware.nsx_policy.model_client.WidgetConfiguration.

Return type

vmware.vapi.struct.VapiStruct

Returns

com.vmware.nsx_policy.model.WidgetConfiguration The return value will contain all the attributes defined in com.vmware.nsx_policy.model_client.WidgetConfiguration.

Raise

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

Raise

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

Raise

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

Raise

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

Raise

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