com.vmware.nsx_policy.infra.tier_0s package¶

Subpackages¶

Submodules¶

com.vmware.nsx_policy.infra.tier_0s.dns_forwarder_client module¶

class com.vmware.nsx_policy.infra.tier_0s.dns_forwarder_client.Nslookup(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, address=None, enforcement_point_path=None)¶

Query the nameserver for an ip-address or a FQDN of the given an address optionally using an specified DNS server. If the address is a fqdn, nslookup will resolve ip-address with it. If the address is an ip-address, do a reverse lookup and answer fqdn(s). If enforcement point is specified, then DNS forwarder nslookup answer will get fetched from specified enforcement point. Otherwise from all enforcement points.

Parameters:	tier0_id (`str`) – (required) address (`str` or `None`) – IP address or FQDN for nslookup (optional) enforcement_point_path (`str` or `None`) – String Path of the enforcement point (optional)
Return type:	`com.vmware.nsx_policy.model_client.AggregatePolicyDnsAnswer`
Returns:	com.vmware.nsx_policy.model.AggregatePolicyDnsAnswer
Raise:	`com.vmware.vapi.std.errors_client.ServiceUnavailable` Service Unavailable
Raise:	`com.vmware.vapi.std.errors_client.InvalidRequest` Bad Request, Precondition Failed
Raise:	`com.vmware.vapi.std.errors_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.dns_forwarder_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, enforcement_point_path=None)¶

Get statistics of tier-0 DNS forwarder. - no enforcement point path specified: Statistics will be evaluated on each enforcement point. - {enforcement_point_path}: Statistics are evaluated only on the given enforcement point.

Parameters:	tier0_id (`str`) – Tier-0 id (required) enforcement_point_path (`str` or `None`) – String Path of the enforcement point (optional)
Return type:	`com.vmware.nsx_policy.model_client.AggregateDNSForwarderStatistics`
Returns:	com.vmware.nsx_policy.model.AggregateDNSForwarderStatistics
Raise:	`com.vmware.vapi.std.errors_client.ServiceUnavailable` Service Unavailable
Raise:	`com.vmware.vapi.std.errors_client.InvalidRequest` Bad Request, Precondition Failed
Raise:	`com.vmware.vapi.std.errors_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.dns_forwarder_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(tier0_id, enforcement_point_path=None)¶

Get current status of tier-0 DNS forwarder. - no enforcement point path specified: Status will be evaluated on each enforcement point. - {enforcement_point_path}: Status will be evaluated only on the given enforcement point.

Parameters:	tier0_id (`str`) – Tier-0 id (required) enforcement_point_path (`str` or `None`) – String Path of the enforcement point (optional)
Return type:	`com.vmware.nsx_policy.model_client.AggregateDNSForwarderStatus`
Returns:	com.vmware.nsx_policy.model.AggregateDNSForwarderStatus
Raise:	`com.vmware.vapi.std.errors_client.ServiceUnavailable` Service Unavailable
Raise:	`com.vmware.vapi.std.errors_client.InvalidRequest` Bad Request, Precondition Failed
Raise:	`com.vmware.vapi.std.errors_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.dns_forwarder_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_client module¶

class com.vmware.nsx_policy.infra.tier_0s.locale_services_client.Bgp(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, override=None)¶

Deletes the specified overridden BgpRoutingConfig. If the BgpRoutingConfig is not overridden, it won’t get deleted.

Parameters:	tier0_id (`str`) – (required) locale_service_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)¶

Read BGP routing config

Parameters:	tier0_id (`str`) – (required) locale_service_id (`str`) – (required)
Return type:	`com.vmware.nsx_policy.model_client.BgpRoutingConfig`
Returns:	com.vmware.nsx_policy.model.BgpRoutingConfig
Raise:	`com.vmware.vapi.std.errors_client.ServiceUnavailable` Service Unavailable
Raise:	`com.vmware.vapi.std.errors_client.InvalidRequest` Bad Request, Precondition Failed
Raise:	`com.vmware.vapi.std.errors_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, bgp_routing_config, override=None)¶

If an BGP routing config not present, create BGP routing config. If it already exists, update the routing config.

Parameters:	tier0_id (`str`) – (required) locale_service_id (`str`) – (required) bgp_routing_config (`com.vmware.nsx_policy.model_client.BgpRoutingConfig`) – (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, bgp_routing_config, override=None)¶

If BGP routing config is not already present, create BGP routing config. If it already exists, replace the BGP routing config with this object.

Parameters:	tier0_id (`str`) – (required) locale_service_id (`str`) – (required) bgp_routing_config (`com.vmware.nsx_policy.model_client.BgpRoutingConfig`) – (required) override (`bool` or `None`) – Locally override the global object (optional, default to false)
Return type:	`com.vmware.nsx_policy.model_client.BgpRoutingConfig`
Returns:	com.vmware.nsx_policy.model.BgpRoutingConfig
Raise:	`com.vmware.vapi.std.errors_client.ServiceUnavailable` Service Unavailable
Raise:	`com.vmware.vapi.std.errors_client.InvalidRequest` Bad Request, Precondition Failed
Raise:	`com.vmware.vapi.std.errors_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_client.ByodServiceInstances(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)¶

Delete BYOD policy service instance

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

Read byod service instance

Parameters:	tier0_id (`str`) – Tier-0 id (required) locale_service_id (`str`) – Locale service id (required) service_instance_id (`str`) – Service instance id (required)
Return type:	`com.vmware.nsx_policy.model_client.ByodPolicyServiceInstance`
Returns:	com.vmware.nsx_policy.model.ByodPolicyServiceInstance
Raise:	`com.vmware.vapi.std.errors_client.ServiceUnavailable` Service Unavailable
Raise:	`com.vmware.vapi.std.errors_client.InvalidRequest` Bad Request, Precondition Failed
Raise:	`com.vmware.vapi.std.errors_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)¶

Read all BYOD service instance objects under a tier-0

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) 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.ByodPolicyServiceInstanceListResult`
Returns:	com.vmware.nsx_policy.model.ByodPolicyServiceInstanceListResult
Raise:	`com.vmware.vapi.std.errors_client.ServiceUnavailable` Service Unavailable
Raise:	`com.vmware.vapi.std.errors_client.InvalidRequest` Bad Request, Precondition Failed
Raise:	`com.vmware.vapi.std.errors_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, byod_policy_service_instance)¶

Create BYOD Service Instance which represent instance of service definition created on manager.

Parameters:	tier0_id (`str`) – Tier-0 id (required) locale_service_id (`str`) – Locale service id (required) service_instance_id (`str`) – Service instance id (required) byod_policy_service_instance (`com.vmware.nsx_policy.model_client.ByodPolicyServiceInstance`) – (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, byod_policy_service_instance)¶

Create BYOD Service Instance which represent instance of service definition created on manager.

Parameters:	tier0_id (`str`) – Tier-0 id (required) locale_service_id (`str`) – Locale service id (required) service_instance_id (`str`) – Byod service instance id (required) byod_policy_service_instance (`com.vmware.nsx_policy.model_client.ByodPolicyServiceInstance`) – (required)
Return type:	`com.vmware.nsx_policy.model_client.ByodPolicyServiceInstance`
Returns:	com.vmware.nsx_policy.model.ByodPolicyServiceInstance
Raise:	`com.vmware.vapi.std.errors_client.ServiceUnavailable` Service Unavailable
Raise:	`com.vmware.vapi.std.errors_client.InvalidRequest` Bad Request, Precondition Failed
Raise:	`com.vmware.vapi.std.errors_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_client.EvpnTunnelEndpoints(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_services_id, tunnel_endpoint_id)¶

Delete evpn tunnel endpoint configuration.

Parameters:	tier0_id (`str`) – tier0 id (required) locale_services_id (`str`) – locale services id (required) tunnel_endpoint_id (`str`) – tunnel 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_services_id, tunnel_endpoint_id)¶

Read evpn tunnel endpoint configuration.

Parameters:	tier0_id (`str`) – tier0 id (required) locale_services_id (`str`) – locale services id (required) tunnel_endpoint_id (`str`) – tunnel endpoint id (required)
Return type:	`com.vmware.nsx_policy.model_client.EvpnTunnelEndpointConfig`
Returns:	com.vmware.nsx_policy.model.EvpnTunnelEndpointConfig
Raise:	`com.vmware.vapi.std.errors_client.ServiceUnavailable` Service Unavailable
Raise:	`com.vmware.vapi.std.errors_client.InvalidRequest` Bad Request, Precondition Failed
Raise:	`com.vmware.vapi.std.errors_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_services_id, cursor=None, include_mark_for_delete_objects=None, included_fields=None, page_size=None, sort_ascending=None, sort_by=None)¶

List all evpn tunnel endpoint configuration.

Parameters:	tier0_id (`str`) – (required) locale_services_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.EvpnTunnelEndpointConfigListResult`
Returns:	com.vmware.nsx_policy.model.EvpnTunnelEndpointConfigListResult
Raise:	`com.vmware.vapi.std.errors_client.ServiceUnavailable` Service Unavailable
Raise:	`com.vmware.vapi.std.errors_client.InvalidRequest` Bad Request, Precondition Failed
Raise:	`com.vmware.vapi.std.errors_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_services_id, tunnel_endpoint_id, evpn_tunnel_endpoint_config)¶

Create a evpn tunnel endpoint config if the tunnel-endpoint-id is not already present, otherwise update the tunnel endpoint configuration.

Parameters:	tier0_id (`str`) – tier0 id (required) locale_services_id (`str`) – locale services id (required) tunnel_endpoint_id (`str`) – tunnel endpoint id (required) evpn_tunnel_endpoint_config (`com.vmware.nsx_policy.model_client.EvpnTunnelEndpointConfig`) – (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_services_id, tunnel_endpoint_id, evpn_tunnel_endpoint_config)¶

Create or update evpn tunnel endpoint configuration.

Parameters:	tier0_id (`str`) – tier0 id (required) locale_services_id (`str`) – locale services id (required) tunnel_endpoint_id (`str`) – tunnel endpoint id (required) evpn_tunnel_endpoint_config (`com.vmware.nsx_policy.model_client.EvpnTunnelEndpointConfig`) – (required)
Return type:	`com.vmware.nsx_policy.model_client.EvpnTunnelEndpointConfig`
Returns:	com.vmware.nsx_policy.model.EvpnTunnelEndpointConfig
Raise:	`com.vmware.vapi.std.errors_client.ServiceUnavailable` Service Unavailable
Raise:	`com.vmware.vapi.std.errors_client.InvalidRequest` Bad Request, Precondition Failed
Raise:	`com.vmware.vapi.std.errors_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_client.FloodProtectionProfileBindings(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_services_id, flood_protection_profile_binding_id)¶

API will delete Flood Protection Profile Binding for Tier-0 Logical Router LocaleServices.

Parameters:	tier0_id (`str`) – (required) locale_services_id (`str`) – (required) flood_protection_profile_binding_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_services_id, flood_protection_profile_binding_id)¶

API will get Flood Protection Profile Binding Map for Tier-0 Logical Router LocaleServices.

Parameters:	tier0_id (`str`) – (required) locale_services_id (`str`) – (required) flood_protection_profile_binding_id (`str`) – (required)
Return type:	`com.vmware.nsx_policy.model_client.FloodProtectionProfileBindingMap`
Returns:	com.vmware.nsx_policy.model.FloodProtectionProfileBindingMap
Raise:	`com.vmware.vapi.std.errors_client.ServiceUnavailable` Service Unavailable
Raise:	`com.vmware.vapi.std.errors_client.InvalidRequest` Bad Request, Precondition Failed
Raise:	`com.vmware.vapi.std.errors_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_services_id, flood_protection_profile_binding_id, flood_protection_profile_binding_map)¶

API will create or update Flood Protection profile binding map for Tier-0 Logical Router LocaleServices.

Parameters:	tier0_id (`str`) – (required) locale_services_id (`str`) – (required) flood_protection_profile_binding_id (`str`) – (required) flood_protection_profile_binding_map (`com.vmware.nsx_policy.model_client.FloodProtectionProfileBindingMap`) – (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_services_id, flood_protection_profile_binding_id, flood_protection_profile_binding_map)¶

API will create or update Flood Protection profile binding map for Tier-0 Logical Router LocaleServices.

Parameters:	tier0_id (`str`) – (required) locale_services_id (`str`) – (required) flood_protection_profile_binding_id (`str`) – (required) flood_protection_profile_binding_map (`com.vmware.nsx_policy.model_client.FloodProtectionProfileBindingMap`) – (required)
Return type:	`com.vmware.nsx_policy.model_client.FloodProtectionProfileBindingMap`
Returns:	com.vmware.nsx_policy.model.FloodProtectionProfileBindingMap
Raise:	`com.vmware.vapi.std.errors_client.ServiceUnavailable` Service Unavailable
Raise:	`com.vmware.vapi.std.errors_client.InvalidRequest` Bad Request, Precondition Failed
Raise:	`com.vmware.vapi.std.errors_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_client.GatewayFirewall(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_services_id)¶

Get filtered view of Gateway Firewall rules associated with the Tier-0 Locale Services. The gateway policies are returned in the order of category and sequence number.

Parameters:	tier0_id (`str`) – (required) locale_services_id (`str`) – (required)
Return type:	`com.vmware.nsx_policy.model_client.GatewayPolicyListResult`
Returns:	com.vmware.nsx_policy.model.GatewayPolicyListResult
Raise:	`com.vmware.vapi.std.errors_client.ServiceUnavailable` Service Unavailable
Raise:	`com.vmware.vapi.std.errors_client.InvalidRequest` Bad Request, Precondition Failed
Raise:	`com.vmware.vapi.std.errors_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_client.Interfaces(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, interface_id, override=None)¶

Delete Tier-0 interface

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

Read Tier-0 interface

Parameters:	tier0_id (`str`) – (required) locale_service_id (`str`) – (required) interface_id (`str`) – (required)
Return type:	`com.vmware.nsx_policy.model_client.Tier0Interface`
Returns:	com.vmware.nsx_policy.model.Tier0Interface
Raise:	`com.vmware.vapi.std.errors_client.ServiceUnavailable` Service Unavailable
Raise:	`com.vmware.vapi.std.errors_client.InvalidRequest` Bad Request, Precondition Failed
Raise:	`com.vmware.vapi.std.errors_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 Tier-0 Interfaces

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.Tier0InterfaceListResult`
Returns:	com.vmware.nsx_policy.model.Tier0InterfaceListResult
Raise:	`com.vmware.vapi.std.errors_client.ServiceUnavailable` Service Unavailable
Raise:	`com.vmware.vapi.std.errors_client.InvalidRequest` Bad Request, Precondition Failed
Raise:	`com.vmware.vapi.std.errors_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, interface_id, tier0_interface, override=None)¶

If an interface with the interface-id is not already present, create a new interface. If it already exists, update the interface for specified attributes.

Parameters:	tier0_id (`str`) – (required) locale_service_id (`str`) – (required) interface_id (`str`) – (required) tier0_interface (`com.vmware.nsx_policy.model_client.Tier0Interface`) – (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, interface_id, tier0_interface, override=None)¶

If an interface with the interface-id is not already present, create a new interface. If it already exists, replace the interface with this object.

Parameters:	tier0_id (`str`) – (required) locale_service_id (`str`) – (required) interface_id (`str`) – (required) tier0_interface (`com.vmware.nsx_policy.model_client.Tier0Interface`) – (required) override (`bool` or `None`) – Locally override the global object (optional, default to false)
Return type:	`com.vmware.nsx_policy.model_client.Tier0Interface`
Returns:	com.vmware.nsx_policy.model.Tier0Interface
Raise:	`com.vmware.vapi.std.errors_client.ServiceUnavailable` Service Unavailable
Raise:	`com.vmware.vapi.std.errors_client.InvalidRequest` Bad Request, Precondition Failed
Raise:	`com.vmware.vapi.std.errors_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_client.IpsecVpnServices(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)¶

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

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

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

Parameters:	tier0_id (`str`) – (required) locale_service_id (`str`) – (required) service_id (`str`) – (required)
Return type:	`com.vmware.nsx_policy.model_client.IPSecVpnService`
Returns:	com.vmware.nsx_policy.model.IPSecVpnService
Raise:	`com.vmware.vapi.std.errors_client.ServiceUnavailable` Service Unavailable
Raise:	`com.vmware.vapi.std.errors_client.InvalidRequest` Bad Request, Precondition Failed
Raise:	`com.vmware.vapi.std.errors_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)¶

Get paginated list of all IPSec VPN services for given locale service under Tier-0.

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.IPSecVpnServiceListResult`
Returns:	com.vmware.nsx_policy.model.IPSecVpnServiceListResult
Raise:	`com.vmware.vapi.std.errors_client.ServiceUnavailable` Service Unavailable
Raise:	`com.vmware.vapi.std.errors_client.InvalidRequest` Bad Request, Precondition Failed
Raise:	`com.vmware.vapi.std.errors_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, ip_sec_vpn_service)¶

Create or patch IPSec VPN service for given locale service under Tier-0.

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

Create or fully replace IPSec VPN service for 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) ip_sec_vpn_service (`com.vmware.nsx_policy.model_client.IPSecVpnService`) – (required)
Return type:	`com.vmware.nsx_policy.model_client.IPSecVpnService`
Returns:	com.vmware.nsx_policy.model.IPSecVpnService
Raise:	`com.vmware.vapi.std.errors_client.ServiceUnavailable` Service Unavailable
Raise:	`com.vmware.vapi.std.errors_client.InvalidRequest` Bad Request, Precondition Failed
Raise:	`com.vmware.vapi.std.errors_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_client.L2vpnContext(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)¶

Parameters:	tier0_id (`str`) – (required) locale_service_id (`str`) – (required)
Return type:	`com.vmware.nsx_policy.model_client.L2VpnContext`
Returns:	com.vmware.nsx_policy.model.L2VpnContext
Raise:	`com.vmware.vapi.std.errors_client.ServiceUnavailable` Service Unavailable
Raise:	`com.vmware.vapi.std.errors_client.InvalidRequest` Bad Request, Precondition Failed
Raise:	`com.vmware.vapi.std.errors_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_client.L2vpnServices(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)¶

Delete L2VPN service for given Tier-0 locale service.

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

Get L2VPN service for given Tier-0 locale service.

Parameters:	tier0_id (`str`) – (required) locale_service_id (`str`) – (required) service_id (`str`) – (required)
Return type:	`com.vmware.nsx_policy.model_client.L2VPNService`
Returns:	com.vmware.nsx_policy.model.L2VPNService
Raise:	`com.vmware.vapi.std.errors_client.ServiceUnavailable` Service Unavailable
Raise:	`com.vmware.vapi.std.errors_client.InvalidRequest` Bad Request, Precondition Failed
Raise:	`com.vmware.vapi.std.errors_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)¶

Get paginated list of all L2VPN services under Tier-0.

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.L2VPNServiceListResult`
Returns:	com.vmware.nsx_policy.model.L2VPNServiceListResult
Raise:	`com.vmware.vapi.std.errors_client.ServiceUnavailable` Service Unavailable
Raise:	`com.vmware.vapi.std.errors_client.InvalidRequest` Bad Request, Precondition Failed
Raise:	`com.vmware.vapi.std.errors_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, l2_vpn_service)¶

Create or patch L2VPN service for given Tier-0 locale service.

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

Create or fully replace L2VPN service for given Tier-0 locale service. Revision is optional for creation and required for update.

Parameters:	tier0_id (`str`) – (required) locale_service_id (`str`) – (required) service_id (`str`) – (required) l2_vpn_service (`com.vmware.nsx_policy.model_client.L2VPNService`) – (required)
Return type:	`com.vmware.nsx_policy.model_client.L2VPNService`
Returns:	com.vmware.nsx_policy.model.L2VPNService
Raise:	`com.vmware.vapi.std.errors_client.ServiceUnavailable` Service Unavailable
Raise:	`com.vmware.vapi.std.errors_client.InvalidRequest` Bad Request, Precondition Failed
Raise:	`com.vmware.vapi.std.errors_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_client.L3vpnContext(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)¶

Parameters:	tier0_id (`str`) – (required) locale_service_id (`str`) – (required)
Return type:	`com.vmware.nsx_policy.model_client.L3VpnContext`
Returns:	com.vmware.nsx_policy.model.L3VpnContext
Raise:	`com.vmware.vapi.std.errors_client.ServiceUnavailable` Service Unavailable
Raise:	`com.vmware.vapi.std.errors_client.InvalidRequest` Bad Request, Precondition Failed
Raise:	`com.vmware.vapi.std.errors_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_client.L3vpns(config)¶

Bases: vmware.vapi.bindings.stub.VapiInterface

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

LIST_L3VPN_SESSION_POLICYBASEDL3VPNSESSION = 'PolicyBasedL3VpnSession'¶: Possible value for l3vpnSession of method L3vpns.list().

LIST_L3VPN_SESSION_ROUTEBASEDL3VPNSESSION = 'RouteBasedL3VpnSession'¶: Possible value for l3vpnSession of method L3vpns.list().

delete(tier0_id, locale_service_id, l3vpn_id)¶

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

Parameters:	tier0_id (`str`) – (required) locale_service_id (`str`) – (required) l3vpn_id (`str`) – (required)
Return type:	`com.vmware.nsx_policy.model_client.L3Vpn`
Returns:	com.vmware.nsx_policy.model.L3Vpn
Raise:	`com.vmware.vapi.std.errors_client.ServiceUnavailable` Service Unavailable
Raise:	`com.vmware.vapi.std.errors_client.InvalidRequest` Bad Request, Precondition Failed
Raise:	`com.vmware.vapi.std.errors_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, l3vpn_session=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) l3vpn_session (`str` or `None`) – Resource type of L3Vpn Session (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.L3VpnListResult`
Returns:	com.vmware.nsx_policy.model.L3VpnListResult
Raise:	`com.vmware.vapi.std.errors_client.ServiceUnavailable` Service Unavailable
Raise:	`com.vmware.vapi.std.errors_client.InvalidRequest` Bad Request, Precondition Failed
Raise:	`com.vmware.vapi.std.errors_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, l3vpn_id, l3_vpn)¶

Parameters:	tier0_id (`str`) – (required) locale_service_id (`str`) – (required) l3vpn_id (`str`) – (required) l3_vpn (`com.vmware.nsx_policy.model_client.L3Vpn`) – (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

showsensitivedata(tier0_id, locale_service_id, l3vpn_id)¶

Parameters:	tier0_id (`str`) – (required) locale_service_id (`str`) – (required) l3vpn_id (`str`) – (required)
Return type:	`com.vmware.nsx_policy.model_client.L3Vpn`
Returns:	com.vmware.nsx_policy.model.L3Vpn
Raise:	`com.vmware.vapi.std.errors_client.ServiceUnavailable` Service Unavailable
Raise:	`com.vmware.vapi.std.errors_client.InvalidRequest` Bad Request, Precondition Failed
Raise:	`com.vmware.vapi.std.errors_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, l3vpn_id, l3_vpn)¶

Parameters:	tier0_id (`str`) – (required) locale_service_id (`str`) – (required) l3vpn_id (`str`) – (required) l3_vpn (`com.vmware.nsx_policy.model_client.L3Vpn`) – (required)
Return type:	`com.vmware.nsx_policy.model_client.L3Vpn`
Returns:	com.vmware.nsx_policy.model.L3Vpn
Raise:	`com.vmware.vapi.std.errors_client.ServiceUnavailable` Service Unavailable
Raise:	`com.vmware.vapi.std.errors_client.InvalidRequest` Bad Request, Precondition Failed
Raise:	`com.vmware.vapi.std.errors_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_client.Multicast(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_services_id)¶

Read Multicast Configuration.

Parameters:	tier0_id (`str`) – tier0 id (required) locale_services_id (`str`) – locale services id (required)
Return type:	`com.vmware.nsx_policy.model_client.PolicyMulticastConfig`
Returns:	com.vmware.nsx_policy.model.PolicyMulticastConfig
Raise:	`com.vmware.vapi.std.errors_client.ServiceUnavailable` Service Unavailable
Raise:	`com.vmware.vapi.std.errors_client.InvalidRequest` Bad Request, Precondition Failed
Raise:	`com.vmware.vapi.std.errors_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_services_id, policy_multicast_config)¶

Create or update a Tier-0 multicast configuration defining the multicast replication range, the IGMP or a PIM profile. It will update the configuration if there is already one in place.

Parameters:	tier0_id (`str`) – tier0 id (required) locale_services_id (`str`) – locale services id (required) policy_multicast_config (`com.vmware.nsx_policy.model_client.PolicyMulticastConfig`) – (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_services_id, policy_multicast_config)¶

Create or update a Tier-0 multicast configuration defining the multicast replication range, the IGMP or a PIM profile. It will update the configuration if there is already one in place.

Parameters:	tier0_id (`str`) – tier0 id (required) locale_services_id (`str`) – locale services id (required) policy_multicast_config (`com.vmware.nsx_policy.model_client.PolicyMulticastConfig`) – (required)
Return type:	`com.vmware.nsx_policy.model_client.PolicyMulticastConfig`
Returns:	com.vmware.nsx_policy.model.PolicyMulticastConfig
Raise:	`com.vmware.vapi.std.errors_client.ServiceUnavailable` Service Unavailable
Raise:	`com.vmware.vapi.std.errors_client.InvalidRequest` Bad Request, Precondition Failed
Raise:	`com.vmware.vapi.std.errors_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_client.ServiceInstances(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)¶

Delete policy service instance

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

Read service instance

Parameters:	tier0_id (`str`) – Tier-0 id (required) locale_service_id (`str`) – Locale service id (required) service_instance_id (`str`) – Service instance id (required)
Return type:	`com.vmware.nsx_policy.model_client.PolicyServiceInstance`
Returns:	com.vmware.nsx_policy.model.PolicyServiceInstance
Raise:	`com.vmware.vapi.std.errors_client.ServiceUnavailable` Service Unavailable
Raise:	`com.vmware.vapi.std.errors_client.InvalidRequest` Bad Request, Precondition Failed
Raise:	`com.vmware.vapi.std.errors_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)¶

Read all service instance objects under a tier-0

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) 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.PolicyServiceInstanceListResult`
Returns:	com.vmware.nsx_policy.model.PolicyServiceInstanceListResult
Raise:	`com.vmware.vapi.std.errors_client.ServiceUnavailable` Service Unavailable
Raise:	`com.vmware.vapi.std.errors_client.InvalidRequest` Bad Request, Precondition Failed
Raise:	`com.vmware.vapi.std.errors_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, policy_service_instance)¶

Create Service Instance. Please note that, only display_name, description and deployment_spec_name are allowed to be modified in an exisiting entity. If the deployment spec name is changed, it will trigger the upgrade operation for the SVMs.

Parameters:	tier0_id (`str`) – Tier-0 id (required) locale_service_id (`str`) – Locale service id (required) service_instance_id (`str`) – Service instance id (required) policy_service_instance (`com.vmware.nsx_policy.model_client.PolicyServiceInstance`) – (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

reauth(tier0_id, locale_service_id, service_instance_id)¶

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

update(tier0_id, locale_service_id, service_instance_id, policy_service_instance)¶

Create service instance. Please note that, only display_name, description and deployment_spec_name are allowed to be modified in an exisiting entity. If the deployment spec name is changed, it will trigger the upgrade operation for the SVMs.

Parameters:	tier0_id (`str`) – Tier-0 id (required) locale_service_id (`str`) – Locale service id (required) service_instance_id (`str`) – Service instance id (required) policy_service_instance (`com.vmware.nsx_policy.model_client.PolicyServiceInstance`) – (required)
Return type:	`com.vmware.nsx_policy.model_client.PolicyServiceInstance`
Returns:	com.vmware.nsx_policy.model.PolicyServiceInstance
Raise:	`com.vmware.vapi.std.errors_client.ServiceUnavailable` Service Unavailable
Raise:	`com.vmware.vapi.std.errors_client.InvalidRequest` Bad Request, Precondition Failed
Raise:	`com.vmware.vapi.std.errors_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_client.ServiceInterfaces(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, interface_id)¶

Delete service interface

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

Read service interface

Parameters:	tier0_id (`str`) – (required) locale_service_id (`str`) – (required) interface_id (`str`) – (required)
Return type:	`com.vmware.nsx_policy.model_client.ServiceInterface`
Returns:	com.vmware.nsx_policy.model.ServiceInterface
Raise:	`com.vmware.vapi.std.errors_client.ServiceUnavailable` Service Unavailable
Raise:	`com.vmware.vapi.std.errors_client.InvalidRequest` Bad Request, Precondition Failed
Raise:	`com.vmware.vapi.std.errors_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 Service Interfaces

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.ServiceInterfaceListResult`
Returns:	com.vmware.nsx_policy.model.ServiceInterfaceListResult
Raise:	`com.vmware.vapi.std.errors_client.ServiceUnavailable` Service Unavailable
Raise:	`com.vmware.vapi.std.errors_client.InvalidRequest` Bad Request, Precondition Failed
Raise:	`com.vmware.vapi.std.errors_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, interface_id, service_interface)¶

If an interface with the interface-id is not already present, create a new interface. If it already exists, update the interface for specified attributes.

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

If an interface with the interface-id is not already present, create a new interface. Modification of service interface is not allowed.

Parameters:	tier0_id (`str`) – (required) locale_service_id (`str`) – (required) interface_id (`str`) – (required) service_interface (`com.vmware.nsx_policy.model_client.ServiceInterface`) – (required)
Return type:	`com.vmware.nsx_policy.model_client.ServiceInterface`
Returns:	com.vmware.nsx_policy.model.ServiceInterface
Raise:	`com.vmware.vapi.std.errors_client.ServiceUnavailable` Service Unavailable
Raise:	`com.vmware.vapi.std.errors_client.InvalidRequest` Bad Request, Precondition Failed
Raise:	`com.vmware.vapi.std.errors_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_client.SessionTimerProfileBindings(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_services_id, session_timer_profile_binding_id)¶

API will delete Session Timer Profile Binding for Tier-0 Logical Router LocaleServices.

Parameters:	tier0_id (`str`) – (required) locale_services_id (`str`) – (required) session_timer_profile_binding_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_services_id, session_timer_profile_binding_id)¶

API will get Session Timer Profile Binding Map for Tier-0 Logical Router LocaleServices.

Parameters:	tier0_id (`str`) – (required) locale_services_id (`str`) – (required) session_timer_profile_binding_id (`str`) – (required)
Return type:	`com.vmware.nsx_policy.model_client.SessionTimerProfileBindingMap`
Returns:	com.vmware.nsx_policy.model.SessionTimerProfileBindingMap
Raise:	`com.vmware.vapi.std.errors_client.ServiceUnavailable` Service Unavailable
Raise:	`com.vmware.vapi.std.errors_client.InvalidRequest` Bad Request, Precondition Failed
Raise:	`com.vmware.vapi.std.errors_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_services_id, session_timer_profile_binding_id, session_timer_profile_binding_map)¶

API will create or update Session Timer profile binding map for Tier-0 Logical Router LocaleServices.

Parameters:	tier0_id (`str`) – (required) locale_services_id (`str`) – (required) session_timer_profile_binding_id (`str`) – (required) session_timer_profile_binding_map (`com.vmware.nsx_policy.model_client.SessionTimerProfileBindingMap`) – (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_services_id, session_timer_profile_binding_id, session_timer_profile_binding_map)¶

API will create or update Session Timer profile binding map for Tier-0 Logical Router LocaleServices.

Parameters:	tier0_id (`str`) – (required) locale_services_id (`str`) – (required) session_timer_profile_binding_id (`str`) – (required) session_timer_profile_binding_map (`com.vmware.nsx_policy.model_client.SessionTimerProfileBindingMap`) – (required)
Return type:	`com.vmware.nsx_policy.model_client.SessionTimerProfileBindingMap`
Returns:	com.vmware.nsx_policy.model.SessionTimerProfileBindingMap
Raise:	`com.vmware.vapi.std.errors_client.ServiceUnavailable` Service Unavailable
Raise:	`com.vmware.vapi.std.errors_client.InvalidRequest` Bad Request, Precondition Failed
Raise:	`com.vmware.vapi.std.errors_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_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_client.Tier0DeploymentMaps(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, tier0_deployment_map_id)¶

Delete Tier-0 Deployment Map

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

Read a Tier-0 Deployment Map

Parameters:	tier0_id (`str`) – (required) locale_service_id (`str`) – (required) tier0_deployment_map_id (`str`) – (required)
Return type:	`com.vmware.nsx_policy.model_client.Tier0DeploymentMap`
Returns:	com.vmware.nsx_policy.model.Tier0DeploymentMap
Raise:	`com.vmware.vapi.std.errors_client.ServiceUnavailable` Service Unavailable
Raise:	`com.vmware.vapi.std.errors_client.InvalidRequest` Bad Request, Precondition Failed
Raise:	`com.vmware.vapi.std.errors_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 Tier-0 Deployment Entries.

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.Tier0DeploymentMapListResult`
Returns:	com.vmware.nsx_policy.model.Tier0DeploymentMapListResult
Raise:	`com.vmware.vapi.std.errors_client.ServiceUnavailable` Service Unavailable
Raise:	`com.vmware.vapi.std.errors_client.InvalidRequest` Bad Request, Precondition Failed
Raise:	`com.vmware.vapi.std.errors_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, tier0_deployment_map_id, tier0_deployment_map)¶

If the passed Tier-0 Deployment Map does not already exist, create a new Tier-0 Deployment Map. If it already exists, patch it.

Parameters:	tier0_id (`str`) – (required) locale_service_id (`str`) – (required) tier0_deployment_map_id (`str`) – (required) tier0_deployment_map (`com.vmware.nsx_policy.model_client.Tier0DeploymentMap`) – (required)
Return type:	`com.vmware.nsx_policy.model_client.Tier0DeploymentMap`
Returns:	com.vmware.nsx_policy.model.Tier0DeploymentMap
Raise:	`com.vmware.vapi.std.errors_client.ServiceUnavailable` Service Unavailable
Raise:	`com.vmware.vapi.std.errors_client.InvalidRequest` Bad Request, Precondition Failed
Raise:	`com.vmware.vapi.std.errors_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, tier0_deployment_map_id, tier0_deployment_map)¶

If the passed Tier-0 Deployment Map does not already exist, create a new Tier-0 Deployment Map. If it already exists, replace it.

Parameters:	tier0_id (`str`) – (required) locale_service_id (`str`) – (required) tier0_deployment_map_id (`str`) – (required) tier0_deployment_map (`com.vmware.nsx_policy.model_client.Tier0DeploymentMap`) – (required)
Return type:	`com.vmware.nsx_policy.model_client.Tier0DeploymentMap`
Returns:	com.vmware.nsx_policy.model.Tier0DeploymentMap
Raise:	`com.vmware.vapi.std.errors_client.ServiceUnavailable` Service Unavailable
Raise:	`com.vmware.vapi.std.errors_client.InvalidRequest` Bad Request, Precondition Failed
Raise:	`com.vmware.vapi.std.errors_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.nat_client module¶

class com.vmware.nsx_policy.infra.tier_0s.nat_client.NatRules(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, nat_id, nat_rule_id)¶

Delete NAT Rule from Tier-0 denoted by Tier-0 ID, under NAT section denoted by <nat-id>. Under tier-0 there will be 3 different NATs(sections). (INTERNAL, USER and DEFAULT) For more details related to NAT section please refer to PolicyNAT schema.

Parameters:	tier0_id (`str`) – Tier-0 ID (required) nat_id (`str`) – NAT id (required) nat_rule_id (`str`) – Rule 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, nat_id, nat_rule_id)¶

Get NAT Rule from Tier-0 denoted by Tier-0 ID, under NAT section denoted by <nat-id>. Under tier-0 there will be 3 different NATs(sections). (INTERNAL, USER and DEFAULT) For more details related to NAT section please refer to PolicyNAT schema.

Parameters:	tier0_id (`str`) – Tier-0 ID (required) nat_id (`str`) – NAT id (required) nat_rule_id (`str`) – Rule ID (required)
Return type:	`com.vmware.nsx_policy.model_client.PolicyNatRule`
Returns:	com.vmware.nsx_policy.model.PolicyNatRule
Raise:	`com.vmware.vapi.std.errors_client.ServiceUnavailable` Service Unavailable
Raise:	`com.vmware.vapi.std.errors_client.InvalidRequest` Bad Request, Precondition Failed
Raise:	`com.vmware.vapi.std.errors_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, nat_id, cursor=None, include_mark_for_delete_objects=None, included_fields=None, page_size=None, sort_ascending=None, sort_by=None)¶

List NAT Rules from Tier-0 denoted by Tier-0 ID, under NAT section denoted by <nat-id>. Under tier-0 there will be 3 different NATs(sections). (INTERNAL, USER and DEFAULT) For more details related to NAT section please refer to PolicyNAT schema.

Parameters:	tier0_id (`str`) – Tier-0 ID (required) nat_id (`str`) – NAT id (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.PolicyNatRuleListResult`
Returns:	com.vmware.nsx_policy.model.PolicyNatRuleListResult
Raise:	`com.vmware.vapi.std.errors_client.ServiceUnavailable` Service Unavailable
Raise:	`com.vmware.vapi.std.errors_client.InvalidRequest` Bad Request, Precondition Failed
Raise:	`com.vmware.vapi.std.errors_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, nat_id, nat_rule_id, policy_nat_rule)¶

If a NAT Rule is not already present on Tier-0 denoted by Tier-0 ID, under NAT section denoted by <nat-id>, create a new NAT Rule. If it already exists, update the NAT Rule. Under tier-0 there will be 3 different NATs(sections). (INTERNAL, USER and DEFAULT) For more details related to NAT section please refer to PolicyNAT schema.

Parameters:	tier0_id (`str`) – Tier-0 ID (required) nat_id (`str`) – NAT id (required) nat_rule_id (`str`) – Rule ID (required) policy_nat_rule (`com.vmware.nsx_policy.model_client.PolicyNatRule`) – (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, nat_id, nat_rule_id, policy_nat_rule)¶

Update NAT Rule on Tier-0 denoted by Tier-0 ID, under NAT section denoted by <nat-id>. Under tier-0 there will be 3 different NATs(sections). (INTERNAL, USER and DEFAULT) For more details related to NAT section please refer to PolicyNAT schema.

Parameters:	tier0_id (`str`) – Tier-0 ID (required) nat_id (`str`) – NAT id (required) nat_rule_id (`str`) – Rule ID (required) policy_nat_rule (`com.vmware.nsx_policy.model_client.PolicyNatRule`) – (required)
Return type:	`com.vmware.nsx_policy.model_client.PolicyNatRule`
Returns:	com.vmware.nsx_policy.model.PolicyNatRule
Raise:	`com.vmware.vapi.std.errors_client.ServiceUnavailable` Service Unavailable
Raise:	`com.vmware.vapi.std.errors_client.InvalidRequest` Bad Request, Precondition Failed
Raise:	`com.vmware.vapi.std.errors_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.nat_client.Statistics(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, cursor=None, enforcement_point_path=None, include_mark_for_delete_objects=None, included_fields=None, page_size=None, sort_ascending=None, sort_by=None)¶

List NAT Rules Statistics from Tier-0 denoted by Tier-0 ID.

Parameters:	tier0_id (`str`) – Tier-0 ID (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.PolicyNatRuleStatisticsPerLogicalRouterListResult`
Returns:	com.vmware.nsx_policy.model.PolicyNatRuleStatisticsPerLogicalRouterListResult
Raise:	`com.vmware.vapi.std.errors_client.ServiceUnavailable` Service Unavailable
Raise:	`com.vmware.vapi.std.errors_client.InvalidRequest` Bad Request, Precondition Failed
Raise:	`com.vmware.vapi.std.errors_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.nat_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.static_routes_client module¶

class com.vmware.nsx_policy.infra.tier_0s.static_routes_client.BfdPeers(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, bfd_peer_id)¶

Delete this StaticRouteBfdPeer and all the entities contained by it.

Parameters:	tier0_id (`str`) – Tier-0 ID (required) bfd_peer_id (`str`) – BFD peer 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, bfd_peer_id)¶

Read a StaticRouteBfdPeer with the bfd-peer-id.

Parameters:	tier0_id (`str`) – Tier-0 ID (required) bfd_peer_id (`str`) – BFD peer ID (required)
Return type:	`com.vmware.nsx_policy.model_client.StaticRouteBfdPeer`
Returns:	com.vmware.nsx_policy.model.StaticRouteBfdPeer
Raise:	`com.vmware.vapi.std.errors_client.ServiceUnavailable` Service Unavailable
Raise:	`com.vmware.vapi.std.errors_client.InvalidRequest` Bad Request, Precondition Failed
Raise:	`com.vmware.vapi.std.errors_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, cursor=None, include_mark_for_delete_objects=None, included_fields=None, page_size=None, sort_ascending=None, sort_by=None)¶

Paginated list of all StaticRouteBfdPeers.

Parameters:	tier0_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.StaticRouteBfdPeerListResult`
Returns:	com.vmware.nsx_policy.model.StaticRouteBfdPeerListResult
Raise:	`com.vmware.vapi.std.errors_client.ServiceUnavailable` Service Unavailable
Raise:	`com.vmware.vapi.std.errors_client.InvalidRequest` Bad Request, Precondition Failed
Raise:	`com.vmware.vapi.std.errors_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, bfd_peer_id, static_route_bfd_peer)¶

If a StaticRouteBfdPeer with the bfd-peer-id is not already present, create a new StaticRouteBfdPeer. If it already exists, update the StaticRouteBfdPeer. This is a full replace.

Parameters:	tier0_id (`str`) – Tier-0 ID (required) bfd_peer_id (`str`) – BFD peer ID (required) static_route_bfd_peer (`com.vmware.nsx_policy.model_client.StaticRouteBfdPeer`) – (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, bfd_peer_id, static_route_bfd_peer)¶

If a StaticRouteBfdPeer with the bfd-peer-id is not already present, create a new StaticRouteBfdPeer. If it already exists, update the StaticRouteBfdPeer. This operation will fully replace the object.

Parameters:	tier0_id (`str`) – Tier-0 ID (required) bfd_peer_id (`str`) – BFD peer ID (required) static_route_bfd_peer (`com.vmware.nsx_policy.model_client.StaticRouteBfdPeer`) – (required)
Return type:	`com.vmware.nsx_policy.model_client.StaticRouteBfdPeer`
Returns:	com.vmware.nsx_policy.model.StaticRouteBfdPeer
Raise:	`com.vmware.vapi.std.errors_client.ServiceUnavailable` Service Unavailable
Raise:	`com.vmware.vapi.std.errors_client.InvalidRequest` Bad Request, Precondition Failed
Raise:	`com.vmware.vapi.std.errors_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.static_routes_client.StubFactory(stub_config)¶

Bases: vmware.vapi.bindings.stub.StubFactoryBase

Initialize StubFactoryBase

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