com.vmware.nsx_policy.infra.providers package¶

Subpackages¶

com.vmware.nsx_policy.infra.providers.l2vpn_context package
- Submodules
- com.vmware.nsx_policy.infra.providers.l2vpn_context.l2vpns_client module

Submodules¶

com.vmware.nsx_policy.infra.providers.bgp_client module¶

class com.vmware.nsx_policy.infra.providers.bgp_client.Neighbors(config)¶

Bases: vmware.vapi.bindings.stub.VapiInterface

delete(provider_id, neighbor_id)¶

Delete BGP neighbor config

Parameters:	provider_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(provider_id, neighbor_id)¶

Read BGP neighbor config

Parameters:	provider_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(provider_id, cursor=None, included_fields=None, page_size=None, sort_ascending=None, sort_by=None)¶

Paginated list of all BGP neighbor configurations

Parameters:	provider_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(provider_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:	provider_id (`str`) – (required) neighbor_id (`str`) – (required) bgp_neighbor_config (`com.vmware.nsx_policy.model_client.BgpNeighborConfig`) – (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

update(provider_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:	provider_id (`str`) – (required) neighbor_id (`str`) – (required) bgp_neighbor_config (`com.vmware.nsx_policy.model_client.BgpNeighborConfig`) – (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

class com.vmware.nsx_policy.infra.providers.bgp_client.StubFactory(stub_config)¶: Bases: vmware.vapi.bindings.stub.StubFactoryBase

com.vmware.nsx_policy.infra.providers.l2vpn_context_client module¶

class com.vmware.nsx_policy.infra.providers.l2vpn_context_client.L2vpns(config)¶

Bases: vmware.vapi.bindings.stub.VapiInterface

delete(provider_id, l2vpn_id)¶

Delete the L2Vpn with the given id.

Parameters:	provider_id (`str`) – Provider id (required) l2vpn_id (`str`) – L2Vpn 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(provider_id, l2vpn_id)¶

Read the L2Vpn with the given id.

Parameters:	provider_id (`str`) – Provider id (required) l2vpn_id (`str`) – L2Vpn id (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(provider_id, cursor=None, included_fields=None, page_size=None, sort_ascending=None, sort_by=None)¶

Paginated list of L2Vpns.

Parameters:	provider_id (`str`) – Provider 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.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(provider_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:	provider_id (`str`) – Provider id (required) l2vpn_id (`str`) – L2Vpn id (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(provider_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:	provider_id (`str`) – Provider id (required) l2vpn_id (`str`) – L2Vpn id (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.providers.l2vpn_context_client.StubFactory(stub_config)¶: Bases: vmware.vapi.bindings.stub.StubFactoryBase

com.vmware.nsx_policy.infra.providers.l3vpns_client module¶

class com.vmware.nsx_policy.infra.providers.l3vpns_client.Statistics(config)¶

Bases: vmware.vapi.bindings.stub.VapiInterface

get(provider_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:	provider_id (`str`) – Provider id (required) l3vpn_id (`str`) – L3Vpn id (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.providers.l3vpns_client.StubFactory(stub_config)¶: Bases: vmware.vapi.bindings.stub.StubFactoryBase

com.vmware.nsx_policy.infra.providers.service_instances_client module¶

class com.vmware.nsx_policy.infra.providers.service_instances_client.ServiceInstanceEndpoints(config)¶

Bases: vmware.vapi.bindings.stub.VapiInterface

delete(provider_id, service_instance_id, service_instance_endpoint_id)¶

Delete policy service instance endpoint

Parameters:	provider_id (`str`) – Provider 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(provider_id, service_instance_id, service_instance_endpoint_id)¶

Read service instance endpoint

Parameters:	provider_id (`str`) – Provider 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

patch(provider_id, service_instance_id, service_instance_endpoint_id, service_instance_endpoint)¶

Create Service instance endpoint.

Parameters:	provider_id (`str`) – Provider 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(provider_id, service_instance_id, service_instance_endpoint_id, service_instance_endpoint)¶

Create service instance endpoint.

Parameters:	provider_id (`str`) – Provider 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.providers.service_instances_client.StubFactory(stub_config)¶: Bases: vmware.vapi.bindings.stub.StubFactoryBase