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

Subpackages¶

Submodules¶

com.vmware.nsx_policy.infra.tier_0s.locale_services.bgp_client module¶

class com.vmware.nsx_policy.infra.tier_0s.locale_services.bgp_client.Neighbors(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, locale_service_id, neighbor_id, override=None)¶

Delete BGP neighbor config

Parameters:	tier0_id (`str`) – (required) locale_service_id (`str`) – (required) neighbor_id (`str`) – (required) override (`bool` or `None`) – Locally override the global object (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(tier0_id, locale_service_id, neighbor_id)¶

Read BGP neighbor config

Parameters:	tier0_id (`str`) – (required) locale_service_id (`str`) – (required) neighbor_id (`str`) – (required)
Return type:	`com.vmware.nsx_policy.model_client.BgpNeighborConfig`
Returns:	com.vmware.nsx_policy.model.BgpNeighborConfig
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(tier0_id, locale_service_id, cursor=None, include_mark_for_delete_objects=None, included_fields=None, page_size=None, sort_ascending=None, sort_by=None)¶

Paginated list of all BGP neighbor configurations

Parameters:	tier0_id (`str`) – (required) locale_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.BgpNeighborConfigListResult`
Returns:	com.vmware.nsx_policy.model.BgpNeighborConfigListResult
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, locale_service_id, neighbor_id, bgp_neighbor_config, override=None)¶

If BGP neighbor config with the neighbor-id is not already present, create a new neighbor config. If it already exists, replace the BGP neighbor config with this object.

Parameters:	tier0_id (`str`) – (required) locale_service_id (`str`) – (required) neighbor_id (`str`) – (required) bgp_neighbor_config (`com.vmware.nsx_policy.model_client.BgpNeighborConfig`) – (required) override (`bool` or `None`) – Locally override the global object (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

update(tier0_id, locale_service_id, neighbor_id, bgp_neighbor_config, override=None)¶

If BGP neighbor config with the neighbor-id is not already present, create a new neighbor config. If it already exists, replace the BGP neighbor config with this object.

Parameters:	tier0_id (`str`) – (required) locale_service_id (`str`) – (required) neighbor_id (`str`) – (required) bgp_neighbor_config (`com.vmware.nsx_policy.model_client.BgpNeighborConfig`) – (required) override (`bool` or `None`) – Locally override the global object (optional, default to false)
Return type:	`com.vmware.nsx_policy.model_client.BgpNeighborConfig`
Returns:	com.vmware.nsx_policy.model.BgpNeighborConfig
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_0s.locale_services.bgp_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_0s.locale_services.interfaces_client module¶

class com.vmware.nsx_policy.infra.tier_0s.locale_services.interfaces_client.ArpTable(config)¶

Bases: vmware.vapi.bindings.stub.VapiInterface

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

list(tier0_id, locale_service_id, interface_id, cursor=None, edge_path=None, enforcement_point_path=None, included_fields=None, page_size=None, sort_ascending=None, sort_by=None)¶

Parameters:	tier0_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`) – Enforcement point path (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.InterfaceArpTable`
Returns:	com.vmware.nsx_policy.model.InterfaceArpTable
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_0s.locale_services.interfaces_client.DadState(config)¶

Bases: vmware.vapi.bindings.stub.VapiInterface

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

get(tier0_id, locale_service_id, interface_id, enforcement_point_path=None)¶

Get tier-0 interface DAD state information.

Parameters:	tier0_id (`str`) – (required) locale_service_id (`str`) – (required) interface_id (`str`) – (required) enforcement_point_path (`str` or `None`) – String Path of the enforcement point (optional)
Return type:	`com.vmware.nsx_policy.model_client.InterfaceDADState`
Returns:	com.vmware.nsx_policy.model.InterfaceDADState
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_0s.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_0s.locale_services.ipsec_vpn_services_client module¶

class com.vmware.nsx_policy.infra.tier_0s.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(tier0_id, locale_service_id, service_id, local_endpoint_id)¶

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

Parameters:	tier0_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(tier0_id, locale_service_id, service_id, local_endpoint_id)¶

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

Parameters:	tier0_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(tier0_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-0.

Parameters:	tier0_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(tier0_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-0.

Parameters:	tier0_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(tier0_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-0. Revision is optional for creation and required for update.

Parameters:	tier0_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_0s.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(tier0_id, locale_service_id, service_id, session_id)¶

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

Parameters:	tier0_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(tier0_id, locale_service_id, service_id, session_id)¶

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

Parameters:	tier0_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(tier0_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-0.

Parameters:	tier0_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(tier0_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-0.

Parameters:	tier0_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(tier0_id, locale_service_id, service_id, session_id)¶

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

Parameters:	tier0_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(tier0_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-0. Revision is optional for creation and required for update.

Parameters:	tier0_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_0s.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_0s.locale_services.l2vpn_context_client module¶

class com.vmware.nsx_policy.infra.tier_0s.locale_services.l2vpn_context_client.L2vpns(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, locale_service_id, l2vpn_id)¶

Parameters:	tier0_id (`str`) – (required) locale_service_id (`str`) – (required) l2vpn_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, locale_service_id, l2vpn_id)¶

Parameters:	tier0_id (`str`) – (required) locale_service_id (`str`) – (required) l2vpn_id (`str`) – (required)
Return type:	`com.vmware.nsx_policy.model_client.L2Vpn`
Returns:	com.vmware.nsx_policy.model.L2Vpn
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(tier0_id, locale_service_id, cursor=None, include_mark_for_delete_objects=None, included_fields=None, page_size=None, sort_ascending=None, sort_by=None)¶

Parameters:	tier0_id (`str`) – (required) locale_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.L2VpnListResult`
Returns:	com.vmware.nsx_policy.model.L2VpnListResult
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, locale_service_id, l2vpn_id, l2_vpn)¶

Parameters:	tier0_id (`str`) – (required) locale_service_id (`str`) – (required) l2vpn_id (`str`) – (required) l2_vpn (`com.vmware.nsx_policy.model_client.L2Vpn`) – (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, locale_service_id, l2vpn_id, l2_vpn)¶

Parameters:	tier0_id (`str`) – (required) locale_service_id (`str`) – (required) l2vpn_id (`str`) – (required) l2_vpn (`com.vmware.nsx_policy.model_client.L2Vpn`) – (required)
Return type:	`com.vmware.nsx_policy.model_client.L2Vpn`
Returns:	com.vmware.nsx_policy.model.L2Vpn
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_0s.locale_services.l2vpn_context_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_0s.locale_services.l2vpn_services_client module¶

class com.vmware.nsx_policy.infra.tier_0s.locale_services.l2vpn_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.

createwithpeercode(tier0_id, locale_service_id, service_id, session_id, l2_vpn_session_data)¶

Create or patch an L2VPN session under Tier-0 from Peer Codes. In addition to the L2VPN Session, the IPSec VPN Session, along with the IKE, Tunnel, and DPD Profiles are created and owned by the system. IPSec VPN Service and Local Endpoint are created only when required, i.e., an IPSec VPN Service does not already exist, or an IPSec VPN Local Endpoint with same local address does not already exist. Updating the L2VPN Session can be performed only through this API by specifying new peer codes. Use of specific APIs to update the L2VPN Session and the different resources associated with it is not allowed, except for IPSec VPN Service and Local Endpoint, resources that are not system owned. API supported only when L2VPN Service is in Client Mode.

Parameters:	tier0_id (`str`) – (required) locale_service_id (`str`) – (required) service_id (`str`) – (required) session_id (`str`) – (required) l2_vpn_session_data (`com.vmware.nsx_policy.model_client.L2VPNSessionData`) – (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(tier0_id, locale_service_id, service_id, session_id)¶

Delete L2VPN session under Tier-0. When L2VPN Service is in CLIENT Mode, the L2VPN Session is deleted along with its transpot tunnels and related resources.

Parameters:	tier0_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(tier0_id, locale_service_id, service_id, session_id)¶

Get L2VPN session under Tier-0.

Parameters:	tier0_id (`str`) – (required) locale_service_id (`str`) – (required) service_id (`str`) – (required) session_id (`str`) – (required)
Return type:	`com.vmware.nsx_policy.model_client.L2VPNSession`
Returns:	com.vmware.nsx_policy.model.L2VPNSession
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(tier0_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 L2VPN sessions under Tier-0.

Parameters:	tier0_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.L2VPNSessionListResult`
Returns:	com.vmware.nsx_policy.model.L2VPNSessionListResult
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, locale_service_id, service_id, session_id, l2_vpn_session)¶

Create or patch an L2VPN session under Tier-0. API supported only when L2VPN Service is in Server Mode.

Parameters:	tier0_id (`str`) – (required) locale_service_id (`str`) – (required) service_id (`str`) – (required) session_id (`str`) – (required) l2_vpn_session (`com.vmware.nsx_policy.model_client.L2VPNSession`) – (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, locale_service_id, service_id, session_id, l2_vpn_session)¶

Create or fully replace L2VPN session under Tier-0. API supported only when L2VPN Service is in Server Mode. Revision is optional for creation and required for update.

Parameters:	tier0_id (`str`) – (required) locale_service_id (`str`) – (required) service_id (`str`) – (required) session_id (`str`) – (required) l2_vpn_session (`com.vmware.nsx_policy.model_client.L2VPNSession`) – (required)
Return type:	`com.vmware.nsx_policy.model_client.L2VPNSession`
Returns:	com.vmware.nsx_policy.model.L2VPNSession
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_0s.locale_services.l2vpn_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_0s.locale_services.l3vpns_client module¶

class com.vmware.nsx_policy.infra.tier_0s.locale_services.l3vpns_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(tier0_id, locale_service_id, l3vpn_id, enforcement_point_path=None)¶

Parameters:	tier0_id (`str`) – (required) locale_service_id (`str`) – (required) l3vpn_id (`str`) – (required) enforcement_point_path (`str` or `None`) – String Path of the enforcement point (optional)
Return type:	`com.vmware.nsx_policy.model_client.AggregateL3VpnStatistics`
Returns:	com.vmware.nsx_policy.model.AggregateL3VpnStatistics
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_0s.locale_services.l3vpns_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_0s.locale_services.service_instances_client module¶

class com.vmware.nsx_policy.infra.tier_0s.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(tier0_id, locale_service_id, service_instance_id, enforcement_point_path=None)¶

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

Parameters:	tier0_id (`str`) – Tier-0 id (required) locale_service_id (`str`) – Locale service id (required) service_instance_id (`str`) – 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_0s.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