com.vmware.nsx_policy.infra.tier_1s package¶

Subpackages¶

Submodules¶

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

class com.vmware.nsx_policy.infra.tier_1s.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(tier1_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:	tier1_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_1s.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(tier1_id, enforcement_point_path=None)¶

Get statistics of tier-1 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:	tier1_id (`str`) – Tier-1 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_1s.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(tier1_id, enforcement_point_path=None)¶

Get current status of tier-1 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:	tier1_id (`str`) – Tier-1 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_1s.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_1s.locale_services_client module¶

class com.vmware.nsx_policy.infra.tier_1s.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(tier1_id, locale_services_id, flood_protection_profile_binding_id)¶

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

Parameters:	tier1_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(tier1_id, locale_services_id, flood_protection_profile_binding_id)¶

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

Parameters:	tier1_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(tier1_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-1 Logical Router LocaleServices.

Parameters:	tier1_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(tier1_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-1 Logical Router LocaleServices.

Parameters:	tier1_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_1s.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(tier1_id, locale_services_id)¶

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

Parameters:	tier1_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_1s.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(tier1_id, locale_services_id, interface_id)¶

Delete Tier-1 interface

Parameters:	tier1_id (`str`) – (required) locale_services_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(tier1_id, locale_services_id, interface_id)¶

Read Tier-1 interface

Parameters:	tier1_id (`str`) – (required) locale_services_id (`str`) – (required) interface_id (`str`) – (required)
Return type:	`com.vmware.nsx_policy.model_client.Tier1Interface`
Returns:	com.vmware.nsx_policy.model.Tier1Interface
Raise:	`com.vmware.vapi.std.errors_client.ServiceUnavailable` Service Unavailable
Raise:	`com.vmware.vapi.std.errors_client.InvalidRequest` Bad Request, Precondition Failed
Raise:	`com.vmware.vapi.std.errors_client.InternalServerError` Internal Server Error
Raise:	`com.vmware.vapi.std.errors_client.Unauthorized` Forbidden
Raise:	`com.vmware.vapi.std.errors_client.NotFound` Not Found

list(tier1_id, locale_services_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-1 interfaces

Parameters:	tier1_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.Tier1InterfaceListResult`
Returns:	com.vmware.nsx_policy.model.Tier1InterfaceListResult
Raise:	`com.vmware.vapi.std.errors_client.ServiceUnavailable` Service Unavailable
Raise:	`com.vmware.vapi.std.errors_client.InvalidRequest` Bad Request, Precondition Failed
Raise:	`com.vmware.vapi.std.errors_client.InternalServerError` Internal Server Error
Raise:	`com.vmware.vapi.std.errors_client.Unauthorized` Forbidden
Raise:	`com.vmware.vapi.std.errors_client.NotFound` Not Found

patch(tier1_id, locale_services_id, interface_id, tier1_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:	tier1_id (`str`) – (required) locale_services_id (`str`) – (required) interface_id (`str`) – (required) tier1_interface (`com.vmware.nsx_policy.model_client.Tier1Interface`) – (required)
Raise:	`com.vmware.vapi.std.errors_client.ServiceUnavailable` Service Unavailable
Raise:	`com.vmware.vapi.std.errors_client.InvalidRequest` Bad Request, Precondition Failed
Raise:	`com.vmware.vapi.std.errors_client.InternalServerError` Internal Server Error
Raise:	`com.vmware.vapi.std.errors_client.Unauthorized` Forbidden
Raise:	`com.vmware.vapi.std.errors_client.NotFound` Not Found

update(tier1_id, locale_services_id, interface_id, tier1_interface)¶

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:	tier1_id (`str`) – (required) locale_services_id (`str`) – (required) interface_id (`str`) – (required) tier1_interface (`com.vmware.nsx_policy.model_client.Tier1Interface`) – (required)
Return type:	`com.vmware.nsx_policy.model_client.Tier1Interface`
Returns:	com.vmware.nsx_policy.model.Tier1Interface
Raise:	`com.vmware.vapi.std.errors_client.ServiceUnavailable` Service Unavailable
Raise:	`com.vmware.vapi.std.errors_client.InvalidRequest` Bad Request, Precondition Failed
Raise:	`com.vmware.vapi.std.errors_client.InternalServerError` Internal Server Error
Raise:	`com.vmware.vapi.std.errors_client.Unauthorized` Forbidden
Raise:	`com.vmware.vapi.std.errors_client.NotFound` Not Found

class com.vmware.nsx_policy.infra.tier_1s.locale_services_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(tier1_id, locale_service_id, service_id)¶

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

Parameters:	tier1_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(tier1_id, locale_service_id, service_id)¶

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

Parameters:	tier1_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(tier1_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 a given locale service under Tier-1.

Parameters:	tier1_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(tier1_id, locale_service_id, service_id, ip_sec_vpn_service)¶

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

Parameters:	tier1_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(tier1_id, locale_service_id, service_id, ip_sec_vpn_service)¶

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

Parameters:	tier1_id (`str`) – (required) locale_service_id (`str`) – (required) service_id (`str`) – (required) 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_1s.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(tier1_id, locale_service_id, service_id)¶

Delete L2VPN service for given Tier-1 locale service.

Parameters:	tier1_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(tier1_id, locale_service_id, service_id)¶

Get L2VPN service for given Tier-1 locale service.

Parameters:	tier1_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(tier1_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-1.

Parameters:	tier1_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(tier1_id, locale_service_id, service_id, l2_vpn_service)¶

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

Parameters:	tier1_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(tier1_id, locale_service_id, service_id, l2_vpn_service)¶

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

Parameters:	tier1_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_1s.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(tier1_id, locale_service_id, service_instance_id)¶

Delete Tier1 policy service instance

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

Read Tier1 service instance

Parameters:	tier1_id (`str`) – Tier-1 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(tier1_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-1

Parameters:	tier1_id (`str`) – Tier-1 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(tier1_id, locale_service_id, service_instance_id, policy_service_instance)¶

Create Tier1 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:	tier1_id (`str`) – Tier-1 id (required) locale_service_id (`str`) – Locale service id (required) service_instance_id (`str`) – Tier1 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

update(tier1_id, locale_service_id, service_instance_id, policy_service_instance)¶

Create Tier1 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:	tier1_id (`str`) – Tier-1 id (required) locale_service_id (`str`) – Locale service id (required) service_instance_id (`str`) – Tier1 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_1s.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(tier1_id, locale_services_id, session_timer_profile_binding_id)¶

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

Parameters:	tier1_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(tier1_id, locale_services_id, session_timer_profile_binding_id)¶

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

Parameters:	tier1_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(tier1_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-1 Logical Router LocaleServices.

Parameters:	tier1_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(tier1_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-1 Logical Router LocaleServices.

Parameters:	tier1_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_1s.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

com.vmware.nsx_policy.infra.tier_1s.nat_client module¶

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

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

Parameters:	tier1_id (`str`) – Tier-1 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(tier1_id, nat_id, nat_rule_id)¶

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

Parameters:	tier1_id (`str`) – Tier-1 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(tier1_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-1 denoted by Tier-1 ID, under NAT section denoted by <nat-id>. Under tier-1 there will be 3 different NATs(sections). (INTERNAL, USER and DEFAULT) For more details related to NAT section please refer to PolicyNAT schema.

Parameters:	tier1_id (`str`) – Tier-1 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(tier1_id, nat_id, nat_rule_id, policy_nat_rule)¶

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

Parameters:	tier1_id (`str`) – Tier-1 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(tier1_id, nat_id, nat_rule_id, policy_nat_rule)¶

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

Parameters:	tier1_id (`str`) – Tier-1 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_1s.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(tier1_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-1 denoted by Tier-1 ID.

Parameters:	tier1_id (`str`) – Tier-1 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_1s.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_1s.segments_client module¶

class com.vmware.nsx_policy.infra.tier_1s.segments_client.ArpTable(config)¶

Bases: vmware.vapi.bindings.stub.VapiInterface

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

list(tier1_id, segment_id, cursor=None, edge_path=None, enforcement_point_path=None, included_fields=None, page_size=None, sort_ascending=None, sort_by=None)¶

Returns ARP table (IPv4) or Neighbor Discovery table (IPv6) for the interface (downlink) attaching segment to tier-1 gateway, on a edge node specified in edge_path parameter. The edge_path parameter is mandatory.

Parameters:	tier1_id (`str`) – (required) segment_id (`str`) – (required) cursor (`str` or `None`) – Opaque cursor to be used for getting next page of records (supplied by current result page) (optional) edge_path (`str` or `None`) – Policy path of edge node (optional) enforcement_point_path (`str` or `None`) – Enforcement point path (optional) included_fields (`str` or `None`) – Comma separated list of fields that should be included in query result (optional) page_size (`long` or `None`) – Maximum number of results to return in this page (server may return fewer) (optional, default to 1000) sort_ascending (`bool` or `None`) – (optional) sort_by (`str` or `None`) – Field by which records are sorted (optional)
Return type:	`com.vmware.nsx_policy.model_client.InterfaceArpTable`
Returns:	com.vmware.nsx_policy.model.InterfaceArpTable
Raise:	`com.vmware.vapi.std.errors_client.ServiceUnavailable` Service Unavailable
Raise:	`com.vmware.vapi.std.errors_client.InvalidRequest` Bad Request, Precondition Failed
Raise:	`com.vmware.vapi.std.errors_client.InternalServerError` Internal Server Error
Raise:	`com.vmware.vapi.std.errors_client.Unauthorized` Forbidden
Raise:	`com.vmware.vapi.std.errors_client.NotFound` Not Found

class com.vmware.nsx_policy.infra.tier_1s.segments_client.DhcpStaticBindingConfigs(config)¶

Bases: vmware.vapi.bindings.stub.VapiInterface

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

delete(tier1_id, segment_id, binding_id)¶

Delete DHCP static binding

Parameters:	tier1_id (`str`) – (required) segment_id (`str`) – (required) 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(tier1_id, segment_id, binding_id)¶

Read DHCP static binding

Parameters:	tier1_id (`str`) – (required) segment_id (`str`) – (required) binding_id (`str`) – (required)
Return type:	`vmware.vapi.struct.VapiStruct`
Returns:	com.vmware.nsx_policy.model.DhcpStaticBindingConfig The return value will contain all the attributes defined in `com.vmware.nsx_policy.model_client.DhcpStaticBindingConfig`.
Raise:	`com.vmware.vapi.std.errors_client.ServiceUnavailable` Service Unavailable
Raise:	`com.vmware.vapi.std.errors_client.InvalidRequest` Bad Request, Precondition Failed
Raise:	`com.vmware.vapi.std.errors_client.InternalServerError` Internal Server Error
Raise:	`com.vmware.vapi.std.errors_client.Unauthorized` Forbidden
Raise:	`com.vmware.vapi.std.errors_client.NotFound` Not Found

list(tier1_id, segment_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 DHCP static binding instances

Parameters:	tier1_id (`str`) – (required) segment_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.DhcpStaticBindingConfigListResult`
Returns:	com.vmware.nsx_policy.model.DhcpStaticBindingConfigListResult
Raise:	`com.vmware.vapi.std.errors_client.ServiceUnavailable` Service Unavailable
Raise:	`com.vmware.vapi.std.errors_client.InvalidRequest` Bad Request, Precondition Failed
Raise:	`com.vmware.vapi.std.errors_client.InternalServerError` Internal Server Error
Raise:	`com.vmware.vapi.std.errors_client.Unauthorized` Forbidden
Raise:	`com.vmware.vapi.std.errors_client.NotFound` Not Found

patch(tier1_id, segment_id, binding_id, dhcp_static_binding_config)¶

If binding with the binding-id is not already present, create a new DHCP static binding instance. If it already exists, replace the existing DHCP static binding instance with specified attributes.

Parameters:	tier1_id (`str`) – (required) segment_id (`str`) – (required) binding_id (`str`) – (required) dhcp_static_binding_config (`vmware.vapi.struct.VapiStruct`) – (required) The parameter must contain all the attributes defined in `com.vmware.nsx_policy.model_client.DhcpStaticBindingConfig`.
Raise:	`com.vmware.vapi.std.errors_client.ServiceUnavailable` Service Unavailable
Raise:	`com.vmware.vapi.std.errors_client.InvalidRequest` Bad Request, Precondition Failed
Raise:	`com.vmware.vapi.std.errors_client.InternalServerError` Internal Server Error
Raise:	`com.vmware.vapi.std.errors_client.Unauthorized` Forbidden
Raise:	`com.vmware.vapi.std.errors_client.NotFound` Not Found

update(tier1_id, segment_id, binding_id, dhcp_static_binding_config)¶

If binding with the binding-id is not already present, create a new DHCP static binding instance. If it already exists, replace the existing DHCP static binding instance with this object.

Parameters:	tier1_id (`str`) – (required) segment_id (`str`) – (required) binding_id (`str`) – (required) dhcp_static_binding_config (`vmware.vapi.struct.VapiStruct`) – (required) The parameter must contain all the attributes defined in `com.vmware.nsx_policy.model_client.DhcpStaticBindingConfig`.
Return type:	`vmware.vapi.struct.VapiStruct`
Returns:	com.vmware.nsx_policy.model.DhcpStaticBindingConfig The return value will contain all the attributes defined in `com.vmware.nsx_policy.model_client.DhcpStaticBindingConfig`.
Raise:	`com.vmware.vapi.std.errors_client.ServiceUnavailable` Service Unavailable
Raise:	`com.vmware.vapi.std.errors_client.InvalidRequest` Bad Request, Precondition Failed
Raise:	`com.vmware.vapi.std.errors_client.InternalServerError` Internal Server Error
Raise:	`com.vmware.vapi.std.errors_client.Unauthorized` Forbidden
Raise:	`com.vmware.vapi.std.errors_client.NotFound` Not Found

class com.vmware.nsx_policy.infra.tier_1s.segments_client.Ports(config)¶

Bases: vmware.vapi.bindings.stub.VapiInterface

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

delete(tier1_id, segment_id, port_id)¶

Delete a Tier-1 segment port by giving ID.

Parameters:	tier1_id (`str`) – (required) segment_id (`str`) – (required) port_id (`str`) – (required)
Raise:	`com.vmware.vapi.std.errors_client.ServiceUnavailable` Service Unavailable
Raise:	`com.vmware.vapi.std.errors_client.InvalidRequest` Bad Request, Precondition Failed
Raise:	`com.vmware.vapi.std.errors_client.InternalServerError` Internal Server Error
Raise:	`com.vmware.vapi.std.errors_client.Unauthorized` Forbidden
Raise:	`com.vmware.vapi.std.errors_client.NotFound` Not Found

get(tier1_id, segment_id, port_id)¶

Get detail information on a Tier-1 segment port by giving ID.

Parameters:	tier1_id (`str`) – (required) segment_id (`str`) – (required) port_id (`str`) – (required)
Return type:	`com.vmware.nsx_policy.model_client.SegmentPort`
Returns:	com.vmware.nsx_policy.model.SegmentPort
Raise:	`com.vmware.vapi.std.errors_client.ServiceUnavailable` Service Unavailable
Raise:	`com.vmware.vapi.std.errors_client.InvalidRequest` Bad Request, Precondition Failed
Raise:	`com.vmware.vapi.std.errors_client.InternalServerError` Internal Server Error
Raise:	`com.vmware.vapi.std.errors_client.Unauthorized` Forbidden
Raise:	`com.vmware.vapi.std.errors_client.NotFound` Not Found

list(tier1_id, segment_id, cursor=None, include_mark_for_delete_objects=None, included_fields=None, page_size=None, sort_ascending=None, sort_by=None)¶

List all the ports for a Tier-1 segment.

Parameters:	tier1_id (`str`) – (required) segment_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.SegmentPortListResult`
Returns:	com.vmware.nsx_policy.model.SegmentPortListResult
Raise:	`com.vmware.vapi.std.errors_client.ServiceUnavailable` Service Unavailable
Raise:	`com.vmware.vapi.std.errors_client.InvalidRequest` Bad Request, Precondition Failed
Raise:	`com.vmware.vapi.std.errors_client.InternalServerError` Internal Server Error
Raise:	`com.vmware.vapi.std.errors_client.Unauthorized` Forbidden
Raise:	`com.vmware.vapi.std.errors_client.NotFound` Not Found

patch(tier1_id, segment_id, port_id, segment_port)¶

Create a Tier-1 segment port if it does not exist based on the IDs, or update existing port information by replacing the port object fields which presents in the request body.

Parameters:	tier1_id (`str`) – (required) segment_id (`str`) – (required) port_id (`str`) – (required) segment_port (`com.vmware.nsx_policy.model_client.SegmentPort`) – (required)
Raise:	`com.vmware.vapi.std.errors_client.ServiceUnavailable` Service Unavailable
Raise:	`com.vmware.vapi.std.errors_client.InvalidRequest` Bad Request, Precondition Failed
Raise:	`com.vmware.vapi.std.errors_client.InternalServerError` Internal Server Error
Raise:	`com.vmware.vapi.std.errors_client.Unauthorized` Forbidden
Raise:	`com.vmware.vapi.std.errors_client.NotFound` Not Found

update(tier1_id, segment_id, port_id, segment_port)¶

Create a Tier-1 segment port if it does not exist based on the IDs, or update existing port information by replacing the port object already exists.

Parameters:	tier1_id (`str`) – (required) segment_id (`str`) – (required) port_id (`str`) – (required) segment_port (`com.vmware.nsx_policy.model_client.SegmentPort`) – (required)
Return type:	`com.vmware.nsx_policy.model_client.SegmentPort`
Returns:	com.vmware.nsx_policy.model.SegmentPort
Raise:	`com.vmware.vapi.std.errors_client.ServiceUnavailable` Service Unavailable
Raise:	`com.vmware.vapi.std.errors_client.InvalidRequest` Bad Request, Precondition Failed
Raise:	`com.vmware.vapi.std.errors_client.InternalServerError` Internal Server Error
Raise:	`com.vmware.vapi.std.errors_client.Unauthorized` Forbidden
Raise:	`com.vmware.vapi.std.errors_client.NotFound` Not Found

class com.vmware.nsx_policy.infra.tier_1s.segments_client.SegmentDiscoveryProfileBindingMaps(config)¶

Bases: vmware.vapi.bindings.stub.VapiInterface

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

delete(tier1_id, segment_id, segment_discovery_profile_binding_map_id)¶

API will delete Segment Discovery Profile Binding Profile

Parameters:	tier1_id (`str`) – Tier-1 ID (required) segment_id (`str`) – Segment ID (required) segment_discovery_profile_binding_map_id (`str`) – Segment Discovery Profile Binding Map 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(tier1_id, segment_id, segment_discovery_profile_binding_map_id)¶

API will get Segment Discovery Profile Binding Map

Parameters:	tier1_id (`str`) – Tier-1 ID (required) segment_id (`str`) – Segment ID (required) segment_discovery_profile_binding_map_id (`str`) – Segment Discovery Profile Binding Map ID (required)
Return type:	`com.vmware.nsx_policy.model_client.SegmentDiscoveryProfileBindingMap`
Returns:	com.vmware.nsx_policy.model.SegmentDiscoveryProfileBindingMap
Raise:	`com.vmware.vapi.std.errors_client.ServiceUnavailable` Service Unavailable
Raise:	`com.vmware.vapi.std.errors_client.InvalidRequest` Bad Request, Precondition Failed
Raise:	`com.vmware.vapi.std.errors_client.InternalServerError` Internal Server Error
Raise:	`com.vmware.vapi.std.errors_client.Unauthorized` Forbidden
Raise:	`com.vmware.vapi.std.errors_client.NotFound` Not Found

list(tier1_id, segment_id, cursor=None, include_mark_for_delete_objects=None, included_fields=None, page_size=None, sort_ascending=None, sort_by=None)¶

API will list all Segment Discovery Profile Binding Maps in current segment id.

Parameters:	tier1_id (`str`) – (required) segment_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.SegmentDiscoveryProfileBindingMapListResult`
Returns:	com.vmware.nsx_policy.model.SegmentDiscoveryProfileBindingMapListResult
Raise:	`com.vmware.vapi.std.errors_client.ServiceUnavailable` Service Unavailable
Raise:	`com.vmware.vapi.std.errors_client.InvalidRequest` Bad Request, Precondition Failed
Raise:	`com.vmware.vapi.std.errors_client.InternalServerError` Internal Server Error
Raise:	`com.vmware.vapi.std.errors_client.Unauthorized` Forbidden
Raise:	`com.vmware.vapi.std.errors_client.NotFound` Not Found

patch(tier1_id, segment_id, segment_discovery_profile_binding_map_id, segment_discovery_profile_binding_map)¶

API will create Segment Discovery Profile Binding Map. For objects with no binding maps, default profile is applied.

Parameters:	tier1_id (`str`) – Tier-1 ID (required) segment_id (`str`) – Segment ID (required) segment_discovery_profile_binding_map_id (`str`) – Segment Discovery Profile Binding Map ID (required) segment_discovery_profile_binding_map (`com.vmware.nsx_policy.model_client.SegmentDiscoveryProfileBindingMap`) – (required)
Raise:	`com.vmware.vapi.std.errors_client.ServiceUnavailable` Service Unavailable
Raise:	`com.vmware.vapi.std.errors_client.InvalidRequest` Bad Request, Precondition Failed
Raise:	`com.vmware.vapi.std.errors_client.InternalServerError` Internal Server Error
Raise:	`com.vmware.vapi.std.errors_client.Unauthorized` Forbidden
Raise:	`com.vmware.vapi.std.errors_client.NotFound` Not Found

update(tier1_id, segment_id, segment_discovery_profile_binding_map_id, segment_discovery_profile_binding_map)¶

API will update Segment Discovery Profile Binding Map. For objects with no binding maps, default profile is applied.

Parameters:	tier1_id (`str`) – Tier-1 ID (required) segment_id (`str`) – Segment ID (required) segment_discovery_profile_binding_map_id (`str`) – Segment Discovery Profile Binding Map ID (required) segment_discovery_profile_binding_map (`com.vmware.nsx_policy.model_client.SegmentDiscoveryProfileBindingMap`) – (required)
Return type:	`com.vmware.nsx_policy.model_client.SegmentDiscoveryProfileBindingMap`
Returns:	com.vmware.nsx_policy.model.SegmentDiscoveryProfileBindingMap
Raise:	`com.vmware.vapi.std.errors_client.ServiceUnavailable` Service Unavailable
Raise:	`com.vmware.vapi.std.errors_client.InvalidRequest` Bad Request, Precondition Failed
Raise:	`com.vmware.vapi.std.errors_client.InternalServerError` Internal Server Error
Raise:	`com.vmware.vapi.std.errors_client.Unauthorized` Forbidden
Raise:	`com.vmware.vapi.std.errors_client.NotFound` Not Found

class com.vmware.nsx_policy.infra.tier_1s.segments_client.SegmentMonitoringProfileBindingMaps(config)¶

Bases: vmware.vapi.bindings.stub.VapiInterface

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

delete(tier1_id, segment_id, segment_monitoring_profile_binding_map_id)¶

API will delete Segment Monitoring Profile Binding Profile.

Parameters:	tier1_id (`str`) – Tier-1 ID (required) segment_id (`str`) – Segment ID (required) segment_monitoring_profile_binding_map_id (`str`) – Segment Monitoring Profile Binding Map 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(tier1_id, segment_id, segment_monitoring_profile_binding_map_id)¶

API will get Segment Monitoring Profile Binding Map.

Parameters:	tier1_id (`str`) – Tier-1 ID (required) segment_id (`str`) – Segment ID (required) segment_monitoring_profile_binding_map_id (`str`) – Segment Monitoring Profile Binding Map ID (required)
Return type:	`com.vmware.nsx_policy.model_client.SegmentMonitoringProfileBindingMap`
Returns:	com.vmware.nsx_policy.model.SegmentMonitoringProfileBindingMap
Raise:	`com.vmware.vapi.std.errors_client.ServiceUnavailable` Service Unavailable
Raise:	`com.vmware.vapi.std.errors_client.InvalidRequest` Bad Request, Precondition Failed
Raise:	`com.vmware.vapi.std.errors_client.InternalServerError` Internal Server Error
Raise:	`com.vmware.vapi.std.errors_client.Unauthorized` Forbidden
Raise:	`com.vmware.vapi.std.errors_client.NotFound` Not Found

list(tier1_id, segment_id, cursor=None, include_mark_for_delete_objects=None, included_fields=None, page_size=None, sort_ascending=None, sort_by=None)¶

API will list all Segment Monitoring Profile Binding Maps in current segment id.

Parameters:	tier1_id (`str`) – (required) segment_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.SegmentMonitoringProfileBindingMapListResult`
Returns:	com.vmware.nsx_policy.model.SegmentMonitoringProfileBindingMapListResult
Raise:	`com.vmware.vapi.std.errors_client.ServiceUnavailable` Service Unavailable
Raise:	`com.vmware.vapi.std.errors_client.InvalidRequest` Bad Request, Precondition Failed
Raise:	`com.vmware.vapi.std.errors_client.InternalServerError` Internal Server Error
Raise:	`com.vmware.vapi.std.errors_client.Unauthorized` Forbidden
Raise:	`com.vmware.vapi.std.errors_client.NotFound` Not Found

patch(tier1_id, segment_id, segment_monitoring_profile_binding_map_id, segment_monitoring_profile_binding_map)¶

API will create segment monitoring profile binding map.

Parameters:	tier1_id (`str`) – Tier-1 ID (required) segment_id (`str`) – Segment ID (required) segment_monitoring_profile_binding_map_id (`str`) – Segment Monitoring Profile Binding Map ID (required) segment_monitoring_profile_binding_map (`com.vmware.nsx_policy.model_client.SegmentMonitoringProfileBindingMap`) – (required)
Raise:	`com.vmware.vapi.std.errors_client.ServiceUnavailable` Service Unavailable
Raise:	`com.vmware.vapi.std.errors_client.InvalidRequest` Bad Request, Precondition Failed
Raise:	`com.vmware.vapi.std.errors_client.InternalServerError` Internal Server Error
Raise:	`com.vmware.vapi.std.errors_client.Unauthorized` Forbidden
Raise:	`com.vmware.vapi.std.errors_client.NotFound` Not Found

update(tier1_id, segment_id, segment_monitoring_profile_binding_map_id, segment_monitoring_profile_binding_map)¶

API will update Segment Monitoring Profile Binding Map.

Parameters:	tier1_id (`str`) – Tier-1 ID (required) segment_id (`str`) – Segment ID (required) segment_monitoring_profile_binding_map_id (`str`) – Segment Monitoring Profile Binding Map ID (required) segment_monitoring_profile_binding_map (`com.vmware.nsx_policy.model_client.SegmentMonitoringProfileBindingMap`) – (required)
Return type:	`com.vmware.nsx_policy.model_client.SegmentMonitoringProfileBindingMap`
Returns:	com.vmware.nsx_policy.model.SegmentMonitoringProfileBindingMap
Raise:	`com.vmware.vapi.std.errors_client.ServiceUnavailable` Service Unavailable
Raise:	`com.vmware.vapi.std.errors_client.InvalidRequest` Bad Request, Precondition Failed
Raise:	`com.vmware.vapi.std.errors_client.InternalServerError` Internal Server Error
Raise:	`com.vmware.vapi.std.errors_client.Unauthorized` Forbidden
Raise:	`com.vmware.vapi.std.errors_client.NotFound` Not Found

class com.vmware.nsx_policy.infra.tier_1s.segments_client.SegmentQosProfileBindingMaps(config)¶

Bases: vmware.vapi.bindings.stub.VapiInterface

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

delete(tier1_id, segment_id, segment_qos_profile_binding_map_id)¶

API will delete Segment QoS Profile Binding Profile.

Parameters:	tier1_id (`str`) – Tier-1 ID (required) segment_id (`str`) – Segment ID (required) segment_qos_profile_binding_map_id (`str`) – Segment QoS Profile Binding Map 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(tier1_id, segment_id, segment_qos_profile_binding_map_id)¶

API will get Segment QoS Profile Binding Map.

Parameters:	tier1_id (`str`) – Tier-1 ID (required) segment_id (`str`) – Segment ID (required) segment_qos_profile_binding_map_id (`str`) – Segment QoS Profile Binding Map ID (required)
Return type:	`com.vmware.nsx_policy.model_client.SegmentQosProfileBindingMap`
Returns:	com.vmware.nsx_policy.model.SegmentQoSProfileBindingMap
Raise:	`com.vmware.vapi.std.errors_client.ServiceUnavailable` Service Unavailable
Raise:	`com.vmware.vapi.std.errors_client.InvalidRequest` Bad Request, Precondition Failed
Raise:	`com.vmware.vapi.std.errors_client.InternalServerError` Internal Server Error
Raise:	`com.vmware.vapi.std.errors_client.Unauthorized` Forbidden
Raise:	`com.vmware.vapi.std.errors_client.NotFound` Not Found

list(tier1_id, segment_id, cursor=None, included_fields=None, page_size=None, sort_ascending=None, sort_by=None)¶

API will list all Segment QoS Profile Binding Maps in current segment id.

Parameters:	tier1_id (`str`) – (required) segment_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.SegmentQosProfileBindingMapListResult`
Returns:	com.vmware.nsx_policy.model.SegmentQoSProfileBindingMapListResult
Raise:	`com.vmware.vapi.std.errors_client.ServiceUnavailable` Service Unavailable
Raise:	`com.vmware.vapi.std.errors_client.InvalidRequest` Bad Request, Precondition Failed
Raise:	`com.vmware.vapi.std.errors_client.InternalServerError` Internal Server Error
Raise:	`com.vmware.vapi.std.errors_client.Unauthorized` Forbidden
Raise:	`com.vmware.vapi.std.errors_client.NotFound` Not Found

patch(tier1_id, segment_id, segment_qos_profile_binding_map_id, segment_qos_profile_binding_map)¶

API will create segment QoS profile binding map. For objects with no binding maps, default profile is applied.

Parameters:	tier1_id (`str`) – Tier-1 ID (required) segment_id (`str`) – Segment ID (required) segment_qos_profile_binding_map_id (`str`) – Segment QoS Profile Binding Map ID (required) segment_qos_profile_binding_map (`com.vmware.nsx_policy.model_client.SegmentQosProfileBindingMap`) – (required)
Raise:	`com.vmware.vapi.std.errors_client.ServiceUnavailable` Service Unavailable
Raise:	`com.vmware.vapi.std.errors_client.InvalidRequest` Bad Request, Precondition Failed
Raise:	`com.vmware.vapi.std.errors_client.InternalServerError` Internal Server Error
Raise:	`com.vmware.vapi.std.errors_client.Unauthorized` Forbidden
Raise:	`com.vmware.vapi.std.errors_client.NotFound` Not Found

update(tier1_id, segment_id, segment_qos_profile_binding_map_id, segment_qos_profile_binding_map)¶

API will update Segment QoS Profile Binding Map. For objects with no binding maps, default profile is applied.

Parameters:	tier1_id (`str`) – Tier-1 ID (required) segment_id (`str`) – Segment ID (required) segment_qos_profile_binding_map_id (`str`) – Segment QoS Profile Binding Map ID (required) segment_qos_profile_binding_map (`com.vmware.nsx_policy.model_client.SegmentQosProfileBindingMap`) – (required)
Return type:	`com.vmware.nsx_policy.model_client.SegmentQosProfileBindingMap`
Returns:	com.vmware.nsx_policy.model.SegmentQoSProfileBindingMap
Raise:	`com.vmware.vapi.std.errors_client.ServiceUnavailable` Service Unavailable
Raise:	`com.vmware.vapi.std.errors_client.InvalidRequest` Bad Request, Precondition Failed
Raise:	`com.vmware.vapi.std.errors_client.InternalServerError` Internal Server Error
Raise:	`com.vmware.vapi.std.errors_client.Unauthorized` Forbidden
Raise:	`com.vmware.vapi.std.errors_client.NotFound` Not Found

class com.vmware.nsx_policy.infra.tier_1s.segments_client.SegmentSecurityProfileBindingMaps(config)¶

Bases: vmware.vapi.bindings.stub.VapiInterface

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

delete(tier1_id, segment_id, segment_security_profile_binding_map_id)¶

API will delete segment security profile binding map.

Parameters:	tier1_id (`str`) – tier-1 gateway id (required) segment_id (`str`) – segment id (required) segment_security_profile_binding_map_id (`str`) – segment security profile binding map 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(tier1_id, segment_id, segment_security_profile_binding_map_id)¶

API will return details of the segment security profile binding map. If the binding map does not exist, it will return 404.

Parameters:	tier1_id (`str`) – tier-1 gateway id (required) segment_id (`str`) – segment id (required) segment_security_profile_binding_map_id (`str`) – segment security profile binding map id (required)
Return type:	`com.vmware.nsx_policy.model_client.SegmentSecurityProfileBindingMap`
Returns:	com.vmware.nsx_policy.model.SegmentSecurityProfileBindingMap
Raise:	`com.vmware.vapi.std.errors_client.ServiceUnavailable` Service Unavailable
Raise:	`com.vmware.vapi.std.errors_client.InvalidRequest` Bad Request, Precondition Failed
Raise:	`com.vmware.vapi.std.errors_client.InternalServerError` Internal Server Error
Raise:	`com.vmware.vapi.std.errors_client.Unauthorized` Forbidden
Raise:	`com.vmware.vapi.std.errors_client.NotFound` Not Found

list(tier1_id, segment_id, cursor=None, included_fields=None, page_size=None, sort_ascending=None, sort_by=None)¶

API will list all segment security profile binding maps.

Parameters:	tier1_id (`str`) – tier-1 gateway id (required) segment_id (`str`) – segment 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.SegmentSecurityProfileBindingMapListResult`
Returns:	com.vmware.nsx_policy.model.SegmentSecurityProfileBindingMapListResult
Raise:	`com.vmware.vapi.std.errors_client.ServiceUnavailable` Service Unavailable
Raise:	`com.vmware.vapi.std.errors_client.InvalidRequest` Bad Request, Precondition Failed
Raise:	`com.vmware.vapi.std.errors_client.InternalServerError` Internal Server Error
Raise:	`com.vmware.vapi.std.errors_client.Unauthorized` Forbidden
Raise:	`com.vmware.vapi.std.errors_client.NotFound` Not Found

patch(tier1_id, segment_id, segment_security_profile_binding_map_id, segment_security_profile_binding_map)¶

Create a new segment security profile binding map if the given security profile binding map does not exist. Otherwise, patch the existing segment security profile binding map. For objects with no binding maps, default profile is applied.

Parameters:	tier1_id (`str`) – tier-1 gateway id (required) segment_id (`str`) – segment id (required) segment_security_profile_binding_map_id (`str`) – segment security profile binding map id (required) segment_security_profile_binding_map (`com.vmware.nsx_policy.model_client.SegmentSecurityProfileBindingMap`) – (required)
Raise:	`com.vmware.vapi.std.errors_client.ServiceUnavailable` Service Unavailable
Raise:	`com.vmware.vapi.std.errors_client.InvalidRequest` Bad Request, Precondition Failed
Raise:	`com.vmware.vapi.std.errors_client.InternalServerError` Internal Server Error
Raise:	`com.vmware.vapi.std.errors_client.Unauthorized` Forbidden
Raise:	`com.vmware.vapi.std.errors_client.NotFound` Not Found

update(tier1_id, segment_id, segment_security_profile_binding_map_id, segment_security_profile_binding_map)¶

API will create or replace segment security profile binding map. For objects with no binding maps, default profile is applied.

Parameters:	tier1_id (`str`) – tier-1 gateway id (required) segment_id (`str`) – segment id (required) segment_security_profile_binding_map_id (`str`) – segment security profile binding map id (required) segment_security_profile_binding_map (`com.vmware.nsx_policy.model_client.SegmentSecurityProfileBindingMap`) – (required)
Return type:	`com.vmware.nsx_policy.model_client.SegmentSecurityProfileBindingMap`
Returns:	com.vmware.nsx_policy.model.SegmentSecurityProfileBindingMap
Raise:	`com.vmware.vapi.std.errors_client.ServiceUnavailable` Service Unavailable
Raise:	`com.vmware.vapi.std.errors_client.InvalidRequest` Bad Request, Precondition Failed
Raise:	`com.vmware.vapi.std.errors_client.InternalServerError` Internal Server Error
Raise:	`com.vmware.vapi.std.errors_client.Unauthorized` Forbidden
Raise:	`com.vmware.vapi.std.errors_client.NotFound` Not Found

class com.vmware.nsx_policy.infra.tier_1s.segments_client.State(config)¶

Bases: vmware.vapi.bindings.stub.VapiInterface

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

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

Get tier1 segment state information.

Parameters:	tier1_id (`str`) – (required) segments_id (`str`) – (required) cursor (`str` or `None`) – Opaque cursor to be used for getting next page of records (supplied by current result page) (optional) edge_path (`str` or `None`) – Policy path of edge node (optional) enforcement_point_path (`str` or `None`) – String Path of the enforcement point (optional) include_mark_for_delete_objects (`bool` or `None`) – Include objects that are marked for deletion in results (optional, default to false) included_fields (`str` or `None`) – Comma separated list of fields that should be included in query result (optional) page_size (`long` or `None`) – Maximum number of results to return in this page (server may return fewer) (optional, default to 1000) sort_ascending (`bool` or `None`) – (optional) sort_by (`str` or `None`) – Field by which records are sorted (optional)
Return type:	`com.vmware.nsx_policy.model_client.SegmentConfigurationState`
Returns:	com.vmware.nsx_policy.model.SegmentConfigurationState
Raise:	`com.vmware.vapi.std.errors_client.ServiceUnavailable` Service Unavailable
Raise:	`com.vmware.vapi.std.errors_client.InvalidRequest` Bad Request, Precondition Failed
Raise:	`com.vmware.vapi.std.errors_client.InternalServerError` Internal Server Error
Raise:	`com.vmware.vapi.std.errors_client.Unauthorized` Forbidden
Raise:	`com.vmware.vapi.std.errors_client.NotFound` Not Found

class com.vmware.nsx_policy.infra.tier_1s.segments_client.StaticArp(config)¶

Bases: vmware.vapi.bindings.stub.VapiInterface

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

delete(tier1_id, segment_id)¶

Delete static ARP config

Parameters:	tier1_id (`str`) – (required) segment_id (`str`) – (required)
Raise:	`com.vmware.vapi.std.errors_client.ServiceUnavailable` Service Unavailable
Raise:	`com.vmware.vapi.std.errors_client.InvalidRequest` Bad Request, Precondition Failed
Raise:	`com.vmware.vapi.std.errors_client.InternalServerError` Internal Server Error
Raise:	`com.vmware.vapi.std.errors_client.Unauthorized` Forbidden
Raise:	`com.vmware.vapi.std.errors_client.NotFound` Not Found

get(tier1_id, segment_id)¶

Read static ARP config

Parameters:	tier1_id (`str`) – (required) segment_id (`str`) – (required)
Return type:	`com.vmware.nsx_policy.model_client.StaticARPConfig`
Returns:	com.vmware.nsx_policy.model.StaticARPConfig
Raise:	`com.vmware.vapi.std.errors_client.ServiceUnavailable` Service Unavailable
Raise:	`com.vmware.vapi.std.errors_client.InvalidRequest` Bad Request, Precondition Failed
Raise:	`com.vmware.vapi.std.errors_client.InternalServerError` Internal Server Error
Raise:	`com.vmware.vapi.std.errors_client.Unauthorized` Forbidden
Raise:	`com.vmware.vapi.std.errors_client.NotFound` Not Found

patch(tier1_id, segment_id, static_arp_config)¶

Create static ARP config with Tier-1 and segment IDs provided if it doesn’t exist, update with provided config if it’s already created.

Parameters:	tier1_id (`str`) – (required) segment_id (`str`) – (required) static_arp_config (`com.vmware.nsx_policy.model_client.StaticARPConfig`) – (required)
Raise:	`com.vmware.vapi.std.errors_client.ServiceUnavailable` Service Unavailable
Raise:	`com.vmware.vapi.std.errors_client.InvalidRequest` Bad Request, Precondition Failed
Raise:	`com.vmware.vapi.std.errors_client.InternalServerError` Internal Server Error
Raise:	`com.vmware.vapi.std.errors_client.Unauthorized` Forbidden
Raise:	`com.vmware.vapi.std.errors_client.NotFound` Not Found

update(tier1_id, segment_id, static_arp_config)¶

Create static ARP config with Tier-1 and segment IDs provided if it doesn’t exist, update with provided config if it’s already created.

Parameters:	tier1_id (`str`) – (required) segment_id (`str`) – (required) static_arp_config (`com.vmware.nsx_policy.model_client.StaticARPConfig`) – (required)
Return type:	`com.vmware.nsx_policy.model_client.StaticARPConfig`
Returns:	com.vmware.nsx_policy.model.StaticARPConfig
Raise:	`com.vmware.vapi.std.errors_client.ServiceUnavailable` Service Unavailable
Raise:	`com.vmware.vapi.std.errors_client.InvalidRequest` Bad Request, Precondition Failed
Raise:	`com.vmware.vapi.std.errors_client.InternalServerError` Internal Server Error
Raise:	`com.vmware.vapi.std.errors_client.Unauthorized` Forbidden
Raise:	`com.vmware.vapi.std.errors_client.NotFound` Not Found

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

Bases: vmware.vapi.bindings.stub.VapiInterface

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

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

Get tier1 segment statistics information.

Parameters:	tier1_id (`str`) – (required) segments_id (`str`) – (required) cursor (`str` or `None`) – Opaque cursor to be used for getting next page of records (supplied by current result page) (optional) edge_path (`str` or `None`) – Policy path of edge node (optional) enforcement_point_path (`str` or `None`) – String Path of the enforcement point (optional) include_mark_for_delete_objects (`bool` or `None`) – Include objects that are marked for deletion in results (optional, default to false) included_fields (`str` or `None`) – Comma separated list of fields that should be included in query result (optional) page_size (`long` or `None`) – Maximum number of results to return in this page (server may return fewer) (optional, default to 1000) sort_ascending (`bool` or `None`) – (optional) sort_by (`str` or `None`) – Field by which records are sorted (optional)
Return type:	`com.vmware.nsx_policy.model_client.SegmentStatistics`
Returns:	com.vmware.nsx_policy.model.SegmentStatistics
Raise:	`com.vmware.vapi.std.errors_client.ServiceUnavailable` Service Unavailable
Raise:	`com.vmware.vapi.std.errors_client.InvalidRequest` Bad Request, Precondition Failed
Raise:	`com.vmware.vapi.std.errors_client.InternalServerError` Internal Server Error
Raise:	`com.vmware.vapi.std.errors_client.Unauthorized` Forbidden
Raise:	`com.vmware.vapi.std.errors_client.NotFound` Not Found

class com.vmware.nsx_policy.infra.tier_1s.segments_client.StubFactory(stub_config)¶

Bases: vmware.vapi.bindings.stub.StubFactoryBase

Initialize StubFactoryBase

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