com.vmware.nsx_policy.infra.tier_1s.locale_services package¶

Subpackages¶

com.vmware.nsx_policy.infra.tier_1s.locale_services.ipsec_vpn_services package
- Submodules
- com.vmware.nsx_policy.infra.tier_1s.locale_services.ipsec_vpn_services.sessions_client module

Submodules¶

com.vmware.nsx_policy.infra.tier_1s.locale_services.interfaces_client module¶

class com.vmware.nsx_policy.infra.tier_1s.locale_services.interfaces_client.Statistics(config)¶

Bases: vmware.vapi.bindings.stub.VapiInterface

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

get(tier1_id, locale_service_id, interface_id, cursor=None, edge_path=None, enforcement_point_path=None, include_mark_for_delete_objects=None, included_fields=None, page_size=None, sort_ascending=None, sort_by=None)¶

Get tier1 interface statistics information.

Parameters

tier1_id (str) – (required)
locale_service_id (str) – (required)
interface_id (str) – (required)
cursor (str or None) – Opaque cursor to be used for getting next page of records (supplied by current result page) (optional)
edge_path (str or None) – Policy path of edge node (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.PolicyInterfaceStatistics

Returns

com.vmware.nsx_policy.model.PolicyInterfaceStatistics

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.tier_1s.locale_services.interfaces_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.tier_1s.locale_services.ipsec_vpn_services_client module¶

class com.vmware.nsx_policy.infra.tier_1s.locale_services.ipsec_vpn_services_client.LocalEndpoints(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, locale_service_id, service_id, local_endpoint_id)¶

Delete IPSec VPN local endpoint for a given locale service under Tier-1.

Parameters

tier1_id (str) – (required)
locale_service_id (str) – (required)
service_id (str) – (required)
local_endpoint_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, locale_service_id, service_id, local_endpoint_id)¶

Get IPSec VPN local endpoint for a given locale service under Tier-1.

Parameters

tier1_id (str) – (required)
locale_service_id (str) – (required)
service_id (str) – (required)
local_endpoint_id (str) – (required)

Return type

com.vmware.nsx_policy.model_client.IPSecVpnLocalEndpoint

Returns

com.vmware.nsx_policy.model.IPSecVpnLocalEndpoint

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(tier1_id, locale_service_id, service_id, 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 VPN local endpoints for a given locale service under Tier-1.

Parameters

tier1_id (str) – (required)
locale_service_id (str) – (required)
service_id (str) – (required)
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.IPSecVpnLocalEndpointListResult

Returns

com.vmware.nsx_policy.model.IPSecVpnLocalEndpointListResult

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, locale_service_id, service_id, local_endpoint_id, ip_sec_vpn_local_endpoint)¶

Create or patch a custom IPSec VPN local endpoint for a given locale service under Tier-1.

Parameters

tier1_id (str) – (required)
locale_service_id (str) – (required)
service_id (str) – (required)
local_endpoint_id (str) – (required)
ip_sec_vpn_local_endpoint (com.vmware.nsx_policy.model_client.IPSecVpnLocalEndpoint) – (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, locale_service_id, service_id, local_endpoint_id, ip_sec_vpn_local_endpoint)¶

Create or fully replace IPSec VPN local endpoint for a given locale service under Tier-1. Revision is optional for creation and required for update.

Parameters

tier1_id (str) – (required)
locale_service_id (str) – (required)
service_id (str) – (required)
local_endpoint_id (str) – (required)
ip_sec_vpn_local_endpoint (com.vmware.nsx_policy.model_client.IPSecVpnLocalEndpoint) – (required)

Return type

com.vmware.nsx_policy.model_client.IPSecVpnLocalEndpoint

Returns

com.vmware.nsx_policy.model.IPSecVpnLocalEndpoint

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.tier_1s.locale_services.ipsec_vpn_services_client.Sessions(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, locale_service_id, service_id, session_id)¶

Delete IPSec VPN session for a given locale service under Tier-1.

Parameters

tier1_id (str) – (required)
locale_service_id (str) – (required)
service_id (str) – (required)
session_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, locale_service_id, service_id, session_id)¶

Get IPSec VPN session without sensitive data for a given locale service under Tier-1.

Parameters

tier1_id (str) – (required)
locale_service_id (str) – (required)
service_id (str) – (required)
session_id (str) – (required)

Return type

vmware.vapi.struct.VapiStruct

Returns

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

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(tier1_id, locale_service_id, service_id, 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 VPN sessions for a given locale service under Tier-1.

Parameters

tier1_id (str) – (required)
locale_service_id (str) – (required)
service_id (str) – (required)
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.IPSecVpnSessionListResult

Returns

com.vmware.nsx_policy.model.IPSecVpnSessionListResult

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, locale_service_id, service_id, session_id, ip_sec_vpn_session)¶

Create or patch an IPSec VPN session for a given locale service under Tier-1.

Parameters

tier1_id (str) – (required)
locale_service_id (str) – (required)
service_id (str) – (required)
session_id (str) – (required)
ip_sec_vpn_session (vmware.vapi.struct.VapiStruct) – (required) The parameter must contain all the attributes defined in com.vmware.nsx_policy.model_client.IPSecVpnSession.

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

showsensitivedata(tier1_id, locale_service_id, service_id, session_id)¶

Get IPSec VPN session with senstive data for a given locale service under Tier-1.

Parameters

tier1_id (str) – (required)
locale_service_id (str) – (required)
service_id (str) – (required)
session_id (str) – (required)

Return type

vmware.vapi.struct.VapiStruct

Returns

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

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, locale_service_id, service_id, session_id, ip_sec_vpn_session)¶

Create or fully replace IPSec VPN session for a given locale service under Tier-1. Revision is optional for creation and required for update.

Parameters

tier1_id (str) – (required)
locale_service_id (str) – (required)
service_id (str) – (required)
session_id (str) – (required)
ip_sec_vpn_session (vmware.vapi.struct.VapiStruct) – (required) The parameter must contain all the attributes defined in com.vmware.nsx_policy.model_client.IPSecVpnSession.

Return type

vmware.vapi.struct.VapiStruct

Returns

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

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.tier_1s.locale_services.ipsec_vpn_services_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.tier_1s.locale_services.service_instances_client module¶

class com.vmware.nsx_policy.infra.tier_1s.locale_services.service_instances_client.Statistics(config)¶

Bases: vmware.vapi.bindings.stub.VapiInterface

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

get(tier1_id, locale_service_id, service_instance_id, enforcement_point_path=None)¶

Get statistics for all data NICs on all runtimes associated with this Tier1 PolicyServiceInstance.

Parameters

tier1_id (str) – Tier-1 id (required)
locale_service_id (str) – Locale service id (required)
service_instance_id (str) – Tier1 Service instance id (required)
enforcement_point_path (str or None) – String Path of the enforcement point (optional)

Return type

com.vmware.nsx_policy.model_client.PolicyServiceInstanceStatistics

Returns

com.vmware.nsx_policy.model.PolicyServiceInstanceStatistics

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.tier_1s.locale_services.service_instances_client.StubFactory(stub_config)¶

Bases: vmware.vapi.bindings.stub.StubFactoryBase

Initialize StubFactoryBase

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