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

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)

Delete BGP neighbor config

Parameters:
  • tier0_id (str) – (required)
  • locale_service_id (str) – (required)
  • neighbor_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, 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, 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)
  • 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)

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:
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)

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:
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.byod_service_instances_client module

class com.vmware.nsx_policy.infra.tier_0s.locale_services.byod_service_instances_client.ServiceInstanceEndpoints(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_instance_id, service_instance_endpoint_id)

Delete policy service instance endpoint

Parameters:
  • tier0_id (str) – Tier-0 id (required)
  • locale_service_id (str) – Locale service id (required)
  • service_instance_id (str) – Service instance id (required)
  • service_instance_endpoint_id (str) – Service instance endpoint 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(tier0_id, locale_service_id, service_instance_id, service_instance_endpoint_id)

Read service instance endpoint

Parameters:
  • tier0_id (str) – Tier-0 id (required)
  • locale_service_id (str) – Locale service id (required)
  • service_instance_id (str) – Service instance id (required)
  • service_instance_endpoint_id (str) – Service instance endpoint id (required)
Return type:

com.vmware.nsx_policy.model_client.ServiceInstanceEndpoint

Returns:

com.vmware.nsx_policy.model.ServiceInstanceEndpoint

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_instance_id, cursor=None, included_fields=None, page_size=None, sort_ascending=None, sort_by=None)

List all service instance endpoint

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

Returns:

com.vmware.nsx_policy.model.ServiceInstanceEndpointListResult

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_instance_id, service_instance_endpoint_id, service_instance_endpoint)

Create Service instance endpoint.

Parameters:
  • tier0_id (str) – Tier-0 id (required)
  • locale_service_id (str) – Locale service id (required)
  • service_instance_id (str) – Service instance id (required)
  • service_instance_endpoint_id (str) – Service instance endpoint id (required)
  • service_instance_endpoint (com.vmware.nsx_policy.model_client.ServiceInstanceEndpoint) – (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_instance_id, service_instance_endpoint_id, service_instance_endpoint)

Create service instance endpoint with given request if not exist. Modification of service instance endpoint is not allowed.

Parameters:
  • tier0_id (str) – Tier-0 id (required)
  • locale_service_id (str) – Locale service id (required)
  • service_instance_id (str) – Service instance id (required)
  • service_instance_endpoint_id (str) – Service instance endpoint id (required)
  • service_instance_endpoint (com.vmware.nsx_policy.model_client.ServiceInstanceEndpoint) – (required)
Return type:

com.vmware.nsx_policy.model_client.ServiceInstanceEndpoint

Returns:

com.vmware.nsx_policy.model.ServiceInstanceEndpoint

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.byod_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

com.vmware.nsx_policy.infra.tier_0s.locale_services.endpoints_client module

class com.vmware.nsx_policy.infra.tier_0s.locale_services.endpoints_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.tier_0s.locale_services.endpoints_client.VirtualEndpoints(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, virtual_endpoint_id)

Delete virtual endpoint

Parameters:
  • tier0_id (str) – Tier-0 id (required)
  • locale_service_id (str) – Locale service id (required)
  • virtual_endpoint_id (str) – Virtual endpoint 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(tier0_id, locale_service_id, virtual_endpoint_id)

Read virtual endpoint with given id under given tier-0.

Parameters:
  • tier0_id (str) – Tier-0 id (required)
  • locale_service_id (str) – Locale service id (required)
  • virtual_endpoint_id (str) – Virtual endpoint id (required)
Return type:

com.vmware.nsx_policy.model_client.VirtualEndpoint

Returns:

com.vmware.nsx_policy.model.VirtualEndpoint

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, included_fields=None, page_size=None, sort_ascending=None, sort_by=None)

List all virtual endpoints

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

Returns:

com.vmware.nsx_policy.model.VirtualEndpointListResult

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, virtual_endpoint_id, virtual_endpoint)

Create or update virtual endpoint.

Parameters:
Raise:

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

Raise:

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

Raise:

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

Raise:

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

Raise:

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

update(tier0_id, locale_service_id, virtual_endpoint_id, virtual_endpoint)

Create or update virtual endpoint.

Parameters:
Return type:

com.vmware.nsx_policy.model_client.VirtualEndpoint

Returns:

com.vmware.nsx_policy.model.VirtualEndpoint

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.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)

Delete the L2Vpn with the given 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)

Read the L2Vpn with the given 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, included_fields=None, page_size=None, sort_ascending=None, sort_by=None)

Paginated list of L2Vpns.

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)
  • 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)

Create a new L2Vpn if the L2Vpn with given id does not already exist. If the L2Vpn with the given id already exists, merge with the existing L2Vpn. This is a patch.

Parameters:
Raise:

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

Raise:

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

Raise:

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

Raise:

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

Raise:

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

update(tier0_id, locale_service_id, l2vpn_id, l2_vpn)

Create a new L2Vpn if the L2Vpn with given id does not already exist. If the L2Vpn with the given id already exists, update the existing L2Vpn. This is a full replace.

Parameters:
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.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)

Get statistics of an L3Vpn. - no enforcement point path specified: Stats will be evaluated on each enforcement point. - {enforcement_point_path}: Stats are evaluated only on the given enforcement point.

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