API Description |
API Path |
List BfdProfiles
Paginated list of all BfdProfiles.
|
GET /policy/api/v1/infra/bfd-profiles
GET /policy/api/v1/global-infra/bfd-profiles
|
Delete BFD Config and all the entities contained by this BfdProfile
Delete BFD Config and all the entities contained by this BfdProfile.
|
DELETE /policy/api/v1/infra/bfd-profiles/{bfd-profile-id}
DELETE /policy/api/v1/global-infra/bfd-profiles/{bfd-profile-id}
|
Read a BfdProfile
Read a BfdProfile.
|
GET /policy/api/v1/infra/bfd-profiles/{bfd-profile-id}
GET /policy/api/v1/global-infra/bfd-profiles/{bfd-profile-id}
|
Create or update a BfdProfile
If a BfdProfile with the bfd-profile-id is not already present,
create a new BfdProfile. If it already exists, update the
BfdProfile. This operation will fully replace the object.
|
PATCH /policy/api/v1/infra/bfd-profiles/{bfd-profile-id}
PATCH /policy/api/v1/global-infra/bfd-profiles/{bfd-profile-id}
|
Create or update a BfdProfile
If a BfdProfile with the bfd-profile-id is not already present,
create a new BfdProfile. If it already exists, update the
BfdProfile. This operation will fully replace the object.
|
PUT /policy/api/v1/infra/bfd-profiles/{bfd-profile-id}
PUT /policy/api/v1/global-infra/bfd-profiles/{bfd-profile-id}
|
Read the connectivity global configuration
Read the connectivity global configuration
|
GET /policy/api/v1/infra/connectivity-global-config
GET /policy/api/v1/orgs/{org-id}/projects/{project-id}/infra/connectivity-global-config
|
Update the connectivity global configuration
Update the connectivity global configuration
|
PATCH /policy/api/v1/infra/connectivity-global-config
PATCH /policy/api/v1/orgs/{org-id}/projects/{project-id}/infra/connectivity-global-config
|
Update the connectivity global configuration
Update the connectivity global configuration
|
PUT /policy/api/v1/infra/connectivity-global-config
PUT /policy/api/v1/orgs/{org-id}/projects/{project-id}/infra/connectivity-global-config
|
Read the constraint global configuration
Read the constraint global configuration
|
GET /policy/api/v1/infra/constraint-global-config
GET /policy/api/v1/global-infra/constraint-global-config
GET /policy/api/v1/orgs/{org-id}/projects/{project-id}/infra/constraint-global-config
|
Update the constraint global configuration
Update the constraint global configuration
|
PATCH /policy/api/v1/infra/constraint-global-config
PATCH /policy/api/v1/global-infra/constraint-global-config
PATCH /policy/api/v1/orgs/{org-id}/projects/{project-id}/infra/constraint-global-config
|
Update the constraint global configuration
Update the constraint global configuration
|
PUT /policy/api/v1/infra/constraint-global-config
PUT /policy/api/v1/global-infra/constraint-global-config
PUT /policy/api/v1/orgs/{org-id}/projects/{project-id}/infra/constraint-global-config
|
List DHCP relay config instances
Paginated list of all DHCP relay config instances
|
GET /policy/api/v1/infra/dhcp-relay-configs
GET /policy/api/v1/global-infra/dhcp-relay-configs
GET /policy/api/v1/orgs/{org-id}/projects/{project-id}/infra/dhcp-relay-configs
|
Delete DHCP relay configuration
Delete DHCP relay configuration
|
DELETE /policy/api/v1/infra/dhcp-relay-configs/{dhcp-relay-config-id}
DELETE /policy/api/v1/orgs/{org-id}/projects/{project-id}/infra/dhcp-relay-configs/{dhcp-relay-config-id}
|
Read DHCP relay configuration
Read DHCP relay configuration
|
GET /policy/api/v1/infra/dhcp-relay-configs/{dhcp-relay-config-id}
GET /policy/api/v1/global-infra/dhcp-relay-configs/{dhcp-relay-config-id}
GET /policy/api/v1/orgs/{org-id}/projects/{project-id}/infra/dhcp-relay-configs/{dhcp-relay-config-id}
|
Create or update DHCP relay configuration
If DHCP relay config with the dhcp-relay-config-id is not already present, create a new DHCP relay config instance.
If it already exists, update the DHCP relay config instance with specified attributes.
|
PATCH /policy/api/v1/infra/dhcp-relay-configs/{dhcp-relay-config-id}
PATCH /policy/api/v1/orgs/{org-id}/projects/{project-id}/infra/dhcp-relay-configs/{dhcp-relay-config-id}
|
Create or update DHCP relay configuration
If DHCP relay config with the dhcp-relay-config-id is not already present,
create a new DHCP relay config instance. If it already exists, replace
the DHCP relay config instance with this object.
|
PUT /policy/api/v1/infra/dhcp-relay-configs/{dhcp-relay-config-id}
PUT /policy/api/v1/orgs/{org-id}/projects/{project-id}/infra/dhcp-relay-configs/{dhcp-relay-config-id}
|
List DHCP server config instances
Paginated list of all DHCP server config instances
|
GET /policy/api/v1/infra/dhcp-server-configs
GET /policy/api/v1/global-infra/dhcp-server-configs
GET /policy/api/v1/orgs/{org-id}/projects/{project-id}/infra/dhcp-server-configs
|
Read DHCP server leases
Read DHCP server leases
|
GET /policy/api/v1/infra/dhcp-server-configs/{config-id}/leases
GET /policy/api/v1/global-infra/dhcp-server-configs/{config-id}/leases
GET /policy/api/v1/orgs/{org-id}/projects/{project-id}/infra/dhcp-server-configs/{config-id}/leases
|
Read DHCP server state
Read DHCP server state
|
GET /policy/api/v1/infra/dhcp-server-configs/{config-id}/state
GET /policy/api/v1/global-infra/dhcp-server-configs/{config-id}/state
GET /policy/api/v1/orgs/{org-id}/projects/{project-id}/infra/dhcp-server-configs/{config-id}/state
|
Read DHCP server statistics
Read DHCP server statistics
|
GET /policy/api/v1/infra/dhcp-server-configs/{config-id}/stats
GET /policy/api/v1/global-infra/dhcp-server-configs/{config-id}/stats
GET /policy/api/v1/orgs/{org-id}/projects/{project-id}/infra/dhcp-server-configs/{config-id}/stats
|
Reset DHCP server statistics counters
Reset DHCP statistics counters of a DHCP server represented by the
connectivity_path and the enforecement_point_path where the
dhcp-server-config was applied to. The connectivity_path can be the Tier0
path, Tier1 path or a segment path. If the given Tier0/1 or Segment has
DHCP server applied, the resetting will succeed and the DHCP statistics
counters will be reset to 0. But if it has no DHCP server applied, the
reseting will fail with proper error message.
|
POST /policy/api/v1/infra/dhcp-server-configs/{config-id}/stats?action=reset
POST /policy/api/v1/global-infra/dhcp-server-configs/{config-id}/stats?action=reset
POST /policy/api/v1/orgs/{org-id}/projects/{project-id}/infra/dhcp-server-configs/{config-id}/stats?action=reset
|
Read DHCP server status
Read DHCP server status
|
GET /policy/api/v1/infra/dhcp-server-configs/{config-id}/status
GET /policy/api/v1/global-infra/dhcp-server-configs/{config-id}/status
GET /policy/api/v1/orgs/{org-id}/projects/{project-id}/infra/dhcp-server-configs/{config-id}/status
|
Delete DHCP server configuration
Delete DHCP server configuration
|
DELETE /policy/api/v1/infra/dhcp-server-configs/{dhcp-server-config-id}
DELETE /policy/api/v1/orgs/{org-id}/projects/{project-id}/infra/dhcp-server-configs/{dhcp-server-config-id}
|
Read DHCP server configuration
Read DHCP server configuration
|
GET /policy/api/v1/infra/dhcp-server-configs/{dhcp-server-config-id}
GET /policy/api/v1/global-infra/dhcp-server-configs/{dhcp-server-config-id}
GET /policy/api/v1/orgs/{org-id}/projects/{project-id}/infra/dhcp-server-configs/{dhcp-server-config-id}
|
Create or update DHCP server configuration
If DHCP server config with the dhcp-server-config-id is not already
present, create a new DHCP server config instance. If it already exists,
update the DHCP server config instance with specified attributes.
Realized entities of this API can be found using the path of Tier-0, Tier1,
or Segment where this config is applied on.
Modification of edge_cluster_path in DhcpServerConfig will lose all
existing DHCP leases.
If both the preferred_edge_paths in the DhcpServerConfig are changed
in a same PATCH API, e.g. change from [a,b] to [x,y], the current DHCP
server leases will be lost, which could cause network connectivity
issues. It is recommended to change only one member index in an update
call, e.g. from [a, b] to [a,y].
Clearing preferred_edge_paths will not reassign edge nodes from the
edge cluster. Instead, the previously-allocated edge nodes will be
retained to avoid loss of leases.
|
PATCH /policy/api/v1/infra/dhcp-server-configs/{dhcp-server-config-id}
PATCH /policy/api/v1/orgs/{org-id}/projects/{project-id}/infra/dhcp-server-configs/{dhcp-server-config-id}
|
Create or update DHCP server configuration
If DHCP server config with the dhcp-server-config-id is not already
present, create a new DHCP server config instance. If it already exists,
replace the DHCP server config instance with this object.
Realized entities of this API can be found using the path of Tier-0, Tier1,
or Segment where this config is applied on.
Modification of edge_cluster_path in DhcpServerConfig will lose all
existing DHCP leases.
If both the preferred_edge_paths in the DhcpServerConfig are changed
in a same PUT API, e.g. change from [a,b] to [x,y], the current DHCP
server leases will be lost, which could cause network connectivity
issues. It is recommended to change only one member index in an update
call, e.g. from [a, b] to [a,y].
Clearing preferred_edge_paths will not reassign edge nodes from the
edge cluster. Instead, the previously-allocated edge nodes will be
retained to avoid loss of leases.
|
PUT /policy/api/v1/infra/dhcp-server-configs/{dhcp-server-config-id}
PUT /policy/api/v1/orgs/{org-id}/projects/{project-id}/infra/dhcp-server-configs/{dhcp-server-config-id}
|
List Dns Forwarder Zones
Paginated list of all Dns Forwarder Zones
|
GET /policy/api/v1/infra/dns-forwarder-zones
GET /policy/api/v1/global-infra/dns-forwarder-zones
GET /policy/api/v1/orgs/{org-id}/projects/{project-id}/infra/dns-forwarder-zones
|
Delete the DNS Forwarder Zone
Delete the DNS Forwarder Zone
|
DELETE /policy/api/v1/infra/dns-forwarder-zones/{dns-forwarder-zone-id}
DELETE /policy/api/v1/orgs/{org-id}/projects/{project-id}/infra/dns-forwarder-zones/{dns-forwarder-zone-id}
|
Read the DNS Forwarder Zone
Read the DNS Forwarder Zone
|
GET /policy/api/v1/infra/dns-forwarder-zones/{dns-forwarder-zone-id}
GET /policy/api/v1/global-infra/dns-forwarder-zones/{dns-forwarder-zone-id}
GET /policy/api/v1/orgs/{org-id}/projects/{project-id}/infra/dns-forwarder-zones/{dns-forwarder-zone-id}
|
Create or update the DNS Forwarder Zone
Create or update the DNS Forwarder Zone
|
PATCH /policy/api/v1/infra/dns-forwarder-zones/{dns-forwarder-zone-id}
PATCH /policy/api/v1/orgs/{org-id}/projects/{project-id}/infra/dns-forwarder-zones/{dns-forwarder-zone-id}
|
Create or update the DNS Forwarder Zone
Create or update the DNS Forwarder Zone
|
PUT /policy/api/v1/infra/dns-forwarder-zones/{dns-forwarder-zone-id}
PUT /policy/api/v1/orgs/{org-id}/projects/{project-id}/infra/dns-forwarder-zones/{dns-forwarder-zone-id}
|
List forwarding policies for the given domain
List all forwarding policies for the given domain ordered by precedence.
|
GET /policy/api/v1/infra/domains/{domain-id}/forwarding-policies
GET /policy/api/v1/global-infra/domains/{domain-id}/forwarding-policies
|
Delete forwarding policy
Delete forwarding policy.
|
DELETE /policy/api/v1/infra/domains/{domain-id}/forwarding-policies/{forwarding-policy-id}
|
Read forwarding policy
Read forwarding policy.
|
GET /policy/api/v1/infra/domains/{domain-id}/forwarding-policies/{forwarding-policy-id}
GET /policy/api/v1/global-infra/domains/{domain-id}/forwarding-policies/{forwarding-policy-id}
|
Create or update forwarding policy
Create or update the forwarding policy.
Performance Note: If you want to edit several rules in a forwarding policy
use this API. It will perform better than several individual rule APIs.
Just pass all the rules which you wish to edit as embedded rules to it.
|
PATCH /policy/api/v1/infra/domains/{domain-id}/forwarding-policies/{forwarding-policy-id}
|
Create or update forwarding policy
Create or update the forwarding policy.
Performance Note: If you want to edit several rules in a forwarding policy
use this API. It will perform better than several individual rule APIs.
Just pass all the rules which you wish to edit as embedded rules to it.
|
PUT /policy/api/v1/infra/domains/{domain-id}/forwarding-policies/{forwarding-policy-id}
|
List rules
List rules
|
GET /policy/api/v1/infra/domains/{domain-id}/forwarding-policies/{forwarding-policy-id}/rules
GET /policy/api/v1/global-infra/domains/{domain-id}/forwarding-policies/{forwarding-policy-id}/rules
|
Get forwarding rule statistics.
Get aggregated statistics of Forwarding Policy Rule.
Stats include total number of packets and total number of bytes for the rule.
- no enforcement point path specified: Stats will be evaluated on each enforcement
point.
- {enforcement_point_path}: Stats are evaluated only on the given enforcement point
|
GET /policy/api/v1/infra/domains/{domain-id}/forwarding-policies/{forwarding-policy-id}/rules/{forwarding-rule-id}/statistics
|
Delete ForwardingRule
Delete ForwardingRule
|
DELETE /policy/api/v1/infra/domains/{domain-id}/forwarding-policies/{forwarding-policy-id}/rules/{rule-id}
|
Read rule
Read rule
|
GET /policy/api/v1/infra/domains/{domain-id}/forwarding-policies/{forwarding-policy-id}/rules/{rule-id}
GET /policy/api/v1/global-infra/domains/{domain-id}/forwarding-policies/{forwarding-policy-id}/rules/{rule-id}
|
Update forwarding rule
Create a rule with the rule-id is not already present,
otherwise update the rule.
Performance Note: If you want to edit several rules in a forwarding policy,
prefer below mentioned API for optimal performance.
Pass all the rules which you wish to edit as embedded rules to it.
Use this API - PATCH (or PUT)
/infra/domains/<domain-id>/forwarding-policies/<forwarding-policy-id>
|
PATCH /policy/api/v1/infra/domains/{domain-id}/forwarding-policies/{forwarding-policy-id}/rules/{rule-id}
|
Update forwarding rule
Create a rule with the rule-id is not already present,
otherwise update the rule.
Performance Note: If you want to edit several rules in a forwarding policy,
prefer below mentioned API for optimal performance.
Pass all the rules which you wish to edit as embedded rules to it.
Use this API - PATCH (or PUT)
/infra/domains/<domain-id>/forwarding-policies/<forwarding-policy-id>
|
PUT /policy/api/v1/infra/domains/{domain-id}/forwarding-policies/{forwarding-policy-id}/rules/{rule-id}
|
Get forwarding policy statistics.
Get aggregated stattistics of Forwarding Policy.
Stats include total number of packets and total number of bytes for all
Forwarding rules in a given Forwarding Policy.
- no enforcement point path specified: Stats will be evaluated on each enforcement
point.
- {enforcement_point_path}: Stats are evaluated only on the given enforcement point.
|
GET /policy/api/v1/infra/domains/{domain-id}/forwarding-policies/{forwarding-policy-id}/statistics
|
Reset Forwarding rule statistics
Sets Forwarding Policy rule statistics counter to zero.
- no enforcement point path specified: Reset of stats will be executed for
each enforcement point.
- {enforcement_point_path}: Reset of stats will be executed only for the given
enforcement point.
|
POST /policy/api/v1/infra/domains/{domain-id}/forwarding-policies/stats?action=reset
|
Get Group discovery profile binding map
API will get Group discovery profile binding map
|
GET /policy/api/v1/infra/domains/{domain-id}/groups/{group-id}/discovery-profile-binding-maps
GET /policy/api/v1/global-infra/domains/{domain-id}/groups/{group-id}/discovery-profile-binding-maps
GET /policy/api/v1/orgs/{org-id}/projects/{project-id}/infra/domains/{domain-id}/groups/{group-id}/discovery-profile-binding-maps
|
Delete Group discovery profile binding map
API will delete Group discovery profile binding map
|
DELETE /policy/api/v1/infra/domains/{domain-id}/groups/{group-id}/discovery-profile-binding-maps/{discovery-profile-binding-map-id}
DELETE /policy/api/v1/orgs/{org-id}/projects/{project-id}/infra/domains/{domain-id}/groups/{group-id}/discovery-profile-binding-maps/{discovery-profile-binding-map-id}
|
Get Group discovery profile binding map
API will get Group discovery profile binding map
|
GET /policy/api/v1/infra/domains/{domain-id}/groups/{group-id}/discovery-profile-binding-maps/{discovery-profile-binding-map-id}
GET /policy/api/v1/global-infra/domains/{domain-id}/groups/{group-id}/discovery-profile-binding-maps/{discovery-profile-binding-map-id}
GET /policy/api/v1/orgs/{org-id}/projects/{project-id}/infra/domains/{domain-id}/groups/{group-id}/discovery-profile-binding-maps/{discovery-profile-binding-map-id}
|
Create or update Group discovery profile binding map
API will create or update Group discovery profile binding map
|
PATCH /policy/api/v1/infra/domains/{domain-id}/groups/{group-id}/discovery-profile-binding-maps/{discovery-profile-binding-map-id}
PATCH /policy/api/v1/orgs/{org-id}/projects/{project-id}/infra/domains/{domain-id}/groups/{group-id}/discovery-profile-binding-maps/{discovery-profile-binding-map-id}
|
Update Group discovery profile binding map
API will update Group discovery profile binding map
|
PUT /policy/api/v1/infra/domains/{domain-id}/groups/{group-id}/discovery-profile-binding-maps/{discovery-profile-binding-map-id}
PUT /policy/api/v1/orgs/{org-id}/projects/{project-id}/infra/domains/{domain-id}/groups/{group-id}/discovery-profile-binding-maps/{discovery-profile-binding-map-id}
|
Get mirror stack status for Group Monitoring Profile Binding Map.
API will get mirror stack status by Group Monitoring Profile Binding Map
|
GET /policy/api/v1/infra/domains/{domain-id}/groups/{group-id}/group-monitoring-profile-binding-maps/{group-monitoring-profile-binding-map-id}/mirror-stack-status
|
List Evpn Tenant Configuration
List all evpn tunnel endpoint configuration.
|
GET /policy/api/v1/infra/evpn-tenant-configs
|
Delete evpn tunnel endpoint configuration
Delete evpn tunnel endpoint configuration.
|
DELETE /policy/api/v1/infra/evpn-tenant-configs/{config-id}
|
Read Evpn Tenant Configuration
Read Evpn Tenant Configuration.
|
GET /policy/api/v1/infra/evpn-tenant-configs/{config-id}
|
Create or Update Evpn Tenant Configuration
Create a global evpn tenant configuration if it is not already present,
otherwise update the evpn tenant configuration.
|
PATCH /policy/api/v1/infra/evpn-tenant-configs/{config-id}
|
Create or Update Evpn Tenant Configuration
Create or update Evpn Tenant configuration.
|
PUT /policy/api/v1/infra/evpn-tenant-configs/{config-id}
|
List all gateway QoS profiles
Paginated list of all gateway QoS profle instances
|
GET /policy/api/v1/infra/gateway-qos-profiles
GET /policy/api/v1/global-infra/gateway-qos-profiles
GET /policy/api/v1/orgs/{org-id}/projects/{project-id}/infra/gateway-qos-profiles
|
Delete gateway QoS profile
Delete QoS profile
|
DELETE /policy/api/v1/infra/gateway-qos-profiles/{qos-profile-id}
DELETE /policy/api/v1/global-infra/gateway-qos-profiles/{qos-profile-id}
DELETE /policy/api/v1/orgs/{org-id}/projects/{project-id}/infra/gateway-qos-profiles/{qos-profile-id}
|
Read gateway QoS profile
Read gateway QoS profile
|
GET /policy/api/v1/infra/gateway-qos-profiles/{qos-profile-id}
GET /policy/api/v1/global-infra/gateway-qos-profiles/{qos-profile-id}
GET /policy/api/v1/orgs/{org-id}/projects/{project-id}/infra/gateway-qos-profiles/{qos-profile-id}
|
Create or update Gateway QoS profile
If profile with the qos-profile-id is not already present,
create a new gateway QoS profile instance. If it already exists, update
the gateway QoS profile instance with specified attributes.
|
PATCH /policy/api/v1/infra/gateway-qos-profiles/{qos-profile-id}
PATCH /policy/api/v1/global-infra/gateway-qos-profiles/{qos-profile-id}
PATCH /policy/api/v1/orgs/{org-id}/projects/{project-id}/infra/gateway-qos-profiles/{qos-profile-id}
|
Create or update Gateway QoS profile
If profile with the qos-profile-id is not already present,
create a new gateway QoS profile instance. If it already exists, replace
the gateway QoS profile instance with this object.
|
PUT /policy/api/v1/infra/gateway-qos-profiles/{qos-profile-id}
PUT /policy/api/v1/global-infra/gateway-qos-profiles/{qos-profile-id}
PUT /policy/api/v1/orgs/{org-id}/projects/{project-id}/infra/gateway-qos-profiles/{qos-profile-id}
|
Read global configuration
This rest routine is deprecated. Use /infra/connectivity-global-config for Connectivity global config and
/infra/ops-global-config for Operations global config.
Read global configuration.
|
GET /policy/api/v1/infra/global-config
GET /policy/api/v1/orgs/{org-id}/projects/{project-id}/infra/global-config
|
Update the global configuration
Update the global configuration.
|
PATCH /policy/api/v1/infra/global-config
(Deprecated)
PATCH /policy/api/v1/orgs/{org-id}/projects/{project-id}/infra/global-config
(Deprecated)
|
Update the global configuration
This rest routine is deprecated. Use /infra/connectivity-global-config for Connectivity global config and
/infra/ops-global-config for Operations global config.
Update the global configuration.
|
PUT /policy/api/v1/infra/global-config
PUT /policy/api/v1/orgs/{org-id}/projects/{project-id}/infra/global-config
|
List Igmp Profile
List all igmp profile.
|
GET /policy/api/v1/infra/igmp-profiles
|
Delete Igmp Profile
Delete Igmp Profile.
|
DELETE /policy/api/v1/infra/igmp-profiles/{igmp-profile-id}
|
Read Igmp Profile
Read Igmp Profile.
|
GET /policy/api/v1/infra/igmp-profiles/{igmp-profile-id}
|
Update igmp profile
Create a igmp profile with the igmp-profile-id is not already present,
otherwise update the igmp profile.
|
PATCH /policy/api/v1/infra/igmp-profiles/{igmp-profile-id}
|
Update igmp profile
Create or update igmp profile.
|
PUT /policy/api/v1/infra/igmp-profiles/{igmp-profile-id}
|
List IpAddressBlocks
Paginated list of IpAddressBlocks.
|
GET /policy/api/v1/infra/ip-blocks
GET /policy/api/v1/orgs/{org-id}/projects/{project-id}/infra/ip-blocks
|
Delete an IpAddressBlock
Delete the IpAddressBlock with the given id.
|
DELETE /policy/api/v1/infra/ip-blocks/{ip-block-id}
DELETE /policy/api/v1/orgs/{org-id}/projects/{project-id}/infra/ip-blocks/{ip-block-id}
|
Read a IpAddressBlock
Read IpAddressBlock with given Id.
|
GET /policy/api/v1/infra/ip-blocks/{ip-block-id}
GET /policy/api/v1/orgs/{org-id}/projects/{project-id}/infra/ip-blocks/{ip-block-id}
|
Create a new IPBlock
Creates a new IpAddressBlock with specified ID if not already present.
If IpAddressBlock of given ID is already present, then the instance is
updated with specified attributes.
|
PATCH /policy/api/v1/infra/ip-blocks/{ip-block-id}
PATCH /policy/api/v1/orgs/{org-id}/projects/{project-id}/infra/ip-blocks/{ip-block-id}
|
Create or Replace IpAddressBlock
Create a new IpAddressBlock with given ID if it does not exist.
If IpAddressBlock with given ID already exists, it will update existing instance.
This is a full replace.
|
PUT /policy/api/v1/infra/ip-blocks/{ip-block-id}
PUT /policy/api/v1/orgs/{org-id}/projects/{project-id}/infra/ip-blocks/{ip-block-id}
|
Get an IpAddressBlock usage
Get IpAddressBlock usage with given Id.
|
GET /policy/api/v1/infra/ip-blocks/{ip-block-id}/usage
GET /policy/api/v1/orgs/{org-id}/projects/{project-id}/infra/ip-blocks/{ip-block-id}/usage
|
List IP Discovery Profiles
API will list all IP Discovery Profiles active in current discovery profile id.
|
GET /policy/api/v1/infra/ip-discovery-profiles
GET /policy/api/v1/global-infra/ip-discovery-profiles
GET /policy/api/v1/orgs/{org-id}/projects/{project-id}/infra/ip-discovery-profiles
|
Delete IP Discovery Profile
API will delete IP Discovery profile.
|
DELETE /policy/api/v1/infra/ip-discovery-profiles/{ip-discovery-profile-id}
DELETE /policy/api/v1/global-infra/ip-discovery-profiles/{ip-discovery-profile-id}
DELETE /policy/api/v1/orgs/{org-id}/projects/{project-id}/infra/ip-discovery-profiles/{ip-discovery-profile-id}
|
Get IP Discovery Profile
API will get IP Discovery profile.
|
GET /policy/api/v1/infra/ip-discovery-profiles/{ip-discovery-profile-id}
GET /policy/api/v1/global-infra/ip-discovery-profiles/{ip-discovery-profile-id}
GET /policy/api/v1/orgs/{org-id}/projects/{project-id}/infra/ip-discovery-profiles/{ip-discovery-profile-id}
|
Create IP Discovery Profile
API will create IP Discovery profile.
|
PATCH /policy/api/v1/infra/ip-discovery-profiles/{ip-discovery-profile-id}
PATCH /policy/api/v1/global-infra/ip-discovery-profiles/{ip-discovery-profile-id}
PATCH /policy/api/v1/orgs/{org-id}/projects/{project-id}/infra/ip-discovery-profiles/{ip-discovery-profile-id}
|
Update IP Discovery Profile
API will update IP Discovery profile.
|
PUT /policy/api/v1/infra/ip-discovery-profiles/{ip-discovery-profile-id}
PUT /policy/api/v1/global-infra/ip-discovery-profiles/{ip-discovery-profile-id}
PUT /policy/api/v1/orgs/{org-id}/projects/{project-id}/infra/ip-discovery-profiles/{ip-discovery-profile-id}
|
List IpAddressPools
Paginated list of IpAddressPools.
|
GET /policy/api/v1/infra/ip-pools
GET /policy/api/v1/orgs/{org-id}/projects/{project-id}/infra/ip-pools
|
Delete an IpAddressPool
Delete the IpAddressPool with the given id.
|
DELETE /policy/api/v1/infra/ip-pools/{ip-pool-id}
DELETE /policy/api/v1/orgs/{org-id}/projects/{project-id}/infra/ip-pools/{ip-pool-id}
|
Read an IpAddressPool
Read IpAddressPool with given Id.
|
GET /policy/api/v1/infra/ip-pools/{ip-pool-id}
GET /policy/api/v1/orgs/{org-id}/projects/{project-id}/infra/ip-pools/{ip-pool-id}
|
Create a new IP address pool
Creates a new IpAddressPool with specified ID if not already present.
If IpAddressPool of given ID is already present, then the instance is
updated. This is a full replace.
|
PATCH /policy/api/v1/infra/ip-pools/{ip-pool-id}
PATCH /policy/api/v1/orgs/{org-id}/projects/{project-id}/infra/ip-pools/{ip-pool-id}
|
Create or Replace IpAddressPool
Create a new IpAddressPool with given ID if it does not exist.
If IpAddressPool with given ID already exists, it will update existing instance.
This is a full replace.
|
PUT /policy/api/v1/infra/ip-pools/{ip-pool-id}
PUT /policy/api/v1/orgs/{org-id}/projects/{project-id}/infra/ip-pools/{ip-pool-id}
|
List IpAddressPool Allocations
Returns information about which addresses have been allocated from a
specified IP address pool in policy.
|
GET /policy/api/v1/infra/ip-pools/{ip-pool-id}/ip-allocations
GET /policy/api/v1/orgs/{org-id}/projects/{project-id}/infra/ip-pools/{ip-pool-id}/ip-allocations
|
Records intent to release an IP from an IpPool.
Releases the IP that was allocated for this allocation request
|
DELETE /policy/api/v1/infra/ip-pools/{ip-pool-id}/ip-allocations/{ip-allocation-id}
DELETE /policy/api/v1/orgs/{org-id}/projects/{project-id}/infra/ip-pools/{ip-pool-id}/ip-allocations/{ip-allocation-id}
|
Read policy IpPool allocation
Read a previously created allocation
|
GET /policy/api/v1/infra/ip-pools/{ip-pool-id}/ip-allocations/{ip-allocation-id}
GET /policy/api/v1/orgs/{org-id}/projects/{project-id}/infra/ip-pools/{ip-pool-id}/ip-allocations/{ip-allocation-id}
|
Records intent to allocate an IP Address from an IP Pool
If allocation of the same ID is found, this is a no-op. If no allocation
of the specified ID is found, then a new allocation is created.
An allocation cannot be updated once created.
When an allocation is requested from an IpAddressPool, the IP could be
allocated from any subnet in the pool that has the available capacity.
Request to allocate an IP will fail if no subnet was previously created.
If specific IP was requested, the status of allocation is reflected in the
realized state.
If any IP is requested, the IP finally allocated is obtained by polling on
the realized state until the allocated IP is returned in the extended
attributes.
|
PATCH /policy/api/v1/infra/ip-pools/{ip-pool-id}/ip-allocations/{ip-allocation-id}
PATCH /policy/api/v1/orgs/{org-id}/projects/{project-id}/infra/ip-pools/{ip-pool-id}/ip-allocations/{ip-allocation-id}
|
Records intent to allocate an IP Address from an IP Pool
If allocation of the same ID is found, this is a no-op. If no allocation
of the specified ID is found, then a new allocation is created.
An allocation cannot be updated once created.
When an IP allocation is requested from an IpAddressPool, the IP could be
allocated from any subnet in the pool that has the available capacity.
Request to allocate an IP will fail if no subnet was previously created.
If specific IP was requested, the status of allocation is reflected in the
realized state.
If any IP is requested, the IP finally allocated is obtained by polling on
the realized state until the allocated IP is returned in the extended
attributes.
An allocation cannot be updated once created.
|
PUT /policy/api/v1/infra/ip-pools/{ip-pool-id}/ip-allocations/{ip-allocation-id}
PUT /policy/api/v1/orgs/{org-id}/projects/{project-id}/infra/ip-pools/{ip-pool-id}/ip-allocations/{ip-allocation-id}
|
List IpAddressPoolSubnets
Paginated list of IpAddressPoolSubnets.
|
GET /policy/api/v1/infra/ip-pools/{ip-pool-id}/ip-subnets
GET /policy/api/v1/orgs/{org-id}/projects/{project-id}/infra/ip-pools/{ip-pool-id}/ip-subnets
|
Delete an IpAddressPoolSubnet
Delete the IpAddressPoolSubnet with the given id.
|
DELETE /policy/api/v1/infra/ip-pools/{ip-pool-id}/ip-subnets/{ip-subnet-id}
DELETE /policy/api/v1/orgs/{org-id}/projects/{project-id}/infra/ip-pools/{ip-pool-id}/ip-subnets/{ip-subnet-id}
|
Read an IpAddressPoolSubnet
Read IpAddressPoolSubnet with given Id.
|
GET /policy/api/v1/infra/ip-pools/{ip-pool-id}/ip-subnets/{ip-subnet-id}
GET /policy/api/v1/orgs/{org-id}/projects/{project-id}/infra/ip-pools/{ip-pool-id}/ip-subnets/{ip-subnet-id}
|
Create a new IP Subnet
Creates a new IpAddressPoolSubnet with the specified ID if it does not
already exist. If a IpAddressPoolSubnet of the given ID already exists,
IpAddressPoolSubnet will be updated. This is a full replace.
|
PATCH /policy/api/v1/infra/ip-pools/{ip-pool-id}/ip-subnets/{ip-subnet-id}
PATCH /policy/api/v1/orgs/{org-id}/projects/{project-id}/infra/ip-pools/{ip-pool-id}/ip-subnets/{ip-subnet-id}
|
Create a new IP Subnet
Creates a new IpAddressPoolSubnet with the specified ID if it does not
already exist. If a IpAddressPoolSubnet of the given ID already exists,
IpAddressPoolSubnet will be updated. This is a full replace.
|
PUT /policy/api/v1/infra/ip-pools/{ip-pool-id}/ip-subnets/{ip-subnet-id}
PUT /policy/api/v1/orgs/{org-id}/projects/{project-id}/infra/ip-pools/{ip-pool-id}/ip-subnets/{ip-subnet-id}
|
List DPD profiles
Get paginated list of all DPD Profiles.
|
GET /policy/api/v1/infra/ipsec-vpn-dpd-profiles
|
Delete custom dead peer detection (DPD) profile
Delete custom dead peer detection (DPD) profile. Profile can not be deleted if profile has references to it.
|
DELETE /policy/api/v1/infra/ipsec-vpn-dpd-profiles/{dpd-profile-id}
|
Get dead peer detection (DPD) profile
Get custom dead peer detection (DPD) profile, given the particular id.
|
GET /policy/api/v1/infra/ipsec-vpn-dpd-profiles/{dpd-profile-id}
|
Create or patch a custom DPD Profile
Create or patch dead peer detection (DPD) profile. Any change in profile affects all sessions consuming this profile. System will be provisioned with system owned editable default DPD profile. Any change in profile affects all sessions consuming this profile.
|
PATCH /policy/api/v1/infra/ipsec-vpn-dpd-profiles/{dpd-profile-id}
|
Create or fully replace a custom IPSec tunnel Profile
Create or patch dead peer detection (DPD) profile. Any change in profile affects all sessions consuming this profile. System will be provisioned with system owned editable default DPD profile. Any change in profile affects all sessions consuming this profile. Revision is optional for creation and required for update.
|
PUT /policy/api/v1/infra/ipsec-vpn-dpd-profiles/{dpd-profile-id}
|
List IKE profiles
Get paginated list of all IKE Profiles.
|
GET /policy/api/v1/infra/ipsec-vpn-ike-profiles
|
Delete custom IKE Profile
Delete custom IKE Profile. Profile can not be deleted if profile has references to it.
|
DELETE /policy/api/v1/infra/ipsec-vpn-ike-profiles/{ike-profile-id}
|
Get IKE Profile
Get custom IKE Profile, given the particular id.
|
GET /policy/api/v1/infra/ipsec-vpn-ike-profiles/{ike-profile-id}
|
Create or patch a custom internet key exchange (IKE) Profile
Create or patch custom internet key exchange (IKE) Profile. IKE Profile is a reusable profile that captures IKE and phase one negotiation parameters. System will be pre provisioned with system owned editable default IKE profile and suggested set of profiles that can be used for peering with popular remote peers like AWS VPN. User can create custom profiles as needed. Any change in profile affects all sessions consuming this profile.
|
PATCH /policy/api/v1/infra/ipsec-vpn-ike-profiles/{ike-profile-id}
|
Create or fully replace a custom internet key exchange (IKE) Profile
Create or fully replace custom internet key exchange (IKE) Profile. IKE Profile is a reusable profile that captures IKE and phase one negotiation parameters. System will be pre provisioned with system owned editable default IKE profile and suggested set of profiles that can be used for peering with popular remote peers like AWS VPN. User can create custom profiles as needed. Any change in profile affects all sessions consuming this profile. Revision is optional for creation and required for update.
|
PUT /policy/api/v1/infra/ipsec-vpn-ike-profiles/{ike-profile-id}
|
List IPSec tunnel profiles
Get paginated list of all IPSec tunnel Profiles.
|
GET /policy/api/v1/infra/ipsec-vpn-tunnel-profiles
|
Delete custom IPSec tunnel Profile
Delete custom IPSec tunnel Profile. Profile can not be deleted if profile has references to it.
|
DELETE /policy/api/v1/infra/ipsec-vpn-tunnel-profiles/{tunnel-profile-id}
|
Get IPSec tunnel Profile
Get custom IPSec tunnel Profile, given the particular id.
|
GET /policy/api/v1/infra/ipsec-vpn-tunnel-profiles/{tunnel-profile-id}
|
Create or patch a custom IPSec tunnel Profile
Create or patch custom IPSec tunnel profile. IPSec tunnel profile is a reusable profile that captures phase two negotiation parameters and tunnel properties. System will be provisioned with system owned editable default IPSec tunnel profile. Any change in profile affects all sessions consuming this profile.
|
PATCH /policy/api/v1/infra/ipsec-vpn-tunnel-profiles/{tunnel-profile-id}
|
Create or fully replace a custom IPSec tunnel Profile
Create or fully replace custom IPSec tunnel profile. IPSec tunnel profile is a reusable profile that captures phase two negotiation parameters and tunnel properties. System will be provisioned with system owned editable default IPSec tunnel profile. Any change in profile affects all sessions consuming this profile. Revision is optional for creation and required for update.
|
PUT /policy/api/v1/infra/ipsec-vpn-tunnel-profiles/{tunnel-profile-id}
|
List all IPv6 DAD profiles
Paginated list of all IPv6 DAD profile instances
|
GET /policy/api/v1/infra/ipv6-dad-profiles
GET /policy/api/v1/global-infra/ipv6-dad-profiles
GET /policy/api/v1/orgs/{org-id}/projects/{project-id}/infra/ipv6-dad-profiles
|
Delete IPv6 DAD profile
Delete IPv6 DAD profile
|
DELETE /policy/api/v1/infra/ipv6-dad-profiles/{dad-profile-id}
DELETE /policy/api/v1/global-infra/ipv6-dad-profiles/{dad-profile-id}
DELETE /policy/api/v1/orgs/{org-id}/projects/{project-id}/infra/ipv6-dad-profiles/{dad-profile-id}
|
Read IPv6 DAD profile
Read IPv6 DAD profile
|
GET /policy/api/v1/infra/ipv6-dad-profiles/{dad-profile-id}
GET /policy/api/v1/global-infra/ipv6-dad-profiles/{dad-profile-id}
GET /policy/api/v1/orgs/{org-id}/projects/{project-id}/infra/ipv6-dad-profiles/{dad-profile-id}
|
Create or update IPv6 DAD profile
If profile with the dad-profile-id is not already present,
create a new IPv6 DAD profile instance. If it already exists, update
the IPv6 DAD profile instance with specified attributes.
|
PATCH /policy/api/v1/infra/ipv6-dad-profiles/{dad-profile-id}
PATCH /policy/api/v1/global-infra/ipv6-dad-profiles/{dad-profile-id}
PATCH /policy/api/v1/orgs/{org-id}/projects/{project-id}/infra/ipv6-dad-profiles/{dad-profile-id}
|
Create or update IPv6 DAD profile
If profile with the dad-profile-id is not already present,
create a new IPv6 DAD profile instance. If it already exists, replace
the IPv6 DAD profile instance with this object.
|
PUT /policy/api/v1/infra/ipv6-dad-profiles/{dad-profile-id}
PUT /policy/api/v1/global-infra/ipv6-dad-profiles/{dad-profile-id}
PUT /policy/api/v1/orgs/{org-id}/projects/{project-id}/infra/ipv6-dad-profiles/{dad-profile-id}
|
List all IPv6 NDRA profiles
Paginated list of all IPv6 NDRA profile instances
|
GET /policy/api/v1/infra/ipv6-ndra-profiles
GET /policy/api/v1/global-infra/ipv6-ndra-profiles
GET /policy/api/v1/orgs/{org-id}/projects/{project-id}/infra/ipv6-ndra-profiles
|
Delete IPv6 NDRA profile
Delete IPv6 NDRA profile
|
DELETE /policy/api/v1/infra/ipv6-ndra-profiles/{ndra-profile-id}
DELETE /policy/api/v1/global-infra/ipv6-ndra-profiles/{ndra-profile-id}
DELETE /policy/api/v1/orgs/{org-id}/projects/{project-id}/infra/ipv6-ndra-profiles/{ndra-profile-id}
|
Read IPv6 NDRA profile
Read IPv6 NDRA profile
|
GET /policy/api/v1/infra/ipv6-ndra-profiles/{ndra-profile-id}
GET /policy/api/v1/global-infra/ipv6-ndra-profiles/{ndra-profile-id}
GET /policy/api/v1/orgs/{org-id}/projects/{project-id}/infra/ipv6-ndra-profiles/{ndra-profile-id}
|
Create or update IPv6 NDRA profile
If profile with the ndra-profile-id is not already present,
create a new IPv6 NDRA profile instance. If it already exists, update
the IPv6 NDRA profile instance with specified attributes.
|
PATCH /policy/api/v1/infra/ipv6-ndra-profiles/{ndra-profile-id}
PATCH /policy/api/v1/global-infra/ipv6-ndra-profiles/{ndra-profile-id}
PATCH /policy/api/v1/orgs/{org-id}/projects/{project-id}/infra/ipv6-ndra-profiles/{ndra-profile-id}
|
Create or update IPv6 NDRA profile
If profile with the ndra-profile-id is not already present,
create a new IPv6 NDRA profile instance. If it already exists, replace
the IPv6 NDRA profile instance with this object.
|
PUT /policy/api/v1/infra/ipv6-ndra-profiles/{ndra-profile-id}
PUT /policy/api/v1/global-infra/ipv6-ndra-profiles/{ndra-profile-id}
PUT /policy/api/v1/orgs/{org-id}/projects/{project-id}/infra/ipv6-ndra-profiles/{ndra-profile-id}
|
List LBAppProfiles
Paginated list of all LBAppProfiles.
This API is deprecated for the NSX-T Load Balancer, but not for the NSX-T Distributed Load Balancer.
|
GET /policy/api/v1/infra/lb-app-profiles
|
Delete LBAppProfile and all the entities contained by this LBAppProfile
Delete the LBAppProfile along with all the entities contained
by this LBAppProfile.
This API is deprecated for the NSX-T Load Balancer, but not for the NSX-T Distributed Load Balancer.
|
DELETE /policy/api/v1/infra/lb-app-profiles/{lb-app-profile-id}
|
Read LBAppProfile
Read a LBAppProfile.
This API is deprecated for the NSX-T Load Balancer, but not for the NSX-T Distributed Load Balancer.
|
GET /policy/api/v1/infra/lb-app-profiles/{lb-app-profile-id}
|
Create or update a LBAppProfile
If a LBAppProfile with the lb-app-profile-id is not already present, create
a new LBAppProfile. If it already exists, update the LBAppProfile. This
is a full replace.
This API is deprecated for the NSX-T Load Balancer, but not for the NSX-T Distributed Load Balancer.
|
PATCH /policy/api/v1/infra/lb-app-profiles/{lb-app-profile-id}
|
Create or update a LBAppProfile
If a LBAppProfile with the lb-app-profile-id is not already present, create
a new LBAppProfile. If it already exists, update the LBAppProfile. This
is a full replace.
This API is deprecated for the NSX-T Load Balancer, but not for the NSX-T Distributed Load Balancer.
|
PUT /policy/api/v1/infra/lb-app-profiles/{lb-app-profile-id}
|
List LBClientSslProfiles
Paginated list of all LBClientSslProfiles.
|
GET /policy/api/v1/infra/lb-client-ssl-profiles
(Deprecated)
|
Delete LBClientSslProfile and all the entities contained by this
LBClientSslProfile
Delete the LBClientSslProfile along with all the entities contained
by this LBClientSslProfile.
|
DELETE /policy/api/v1/infra/lb-client-ssl-profiles/{lb-client-ssl-profile-id}
(Deprecated)
|
Read LBClientSslProfile
Read a LBClientSslProfile.
|
GET /policy/api/v1/infra/lb-client-ssl-profiles/{lb-client-ssl-profile-id}
(Deprecated)
|
Create or update a LBClientSslProfile
If a LBClientSslProfile with the lb-client-ssl-profile-id is not already
present, create a new LBClientSslProfile. If it already exists, update the
LBClientSslProfile. This is a full replace.
|
PATCH /policy/api/v1/infra/lb-client-ssl-profiles/{lb-client-ssl-profile-id}
(Deprecated)
|
Create or update a LBClientSslProfile
If a LBClientSslProfile with the lb-client-ssl-profile-id is not already
present, create a new LBClientSslProfile. If it already exists, update the
LBClientSslProfile. This is a full replace.
|
PUT /policy/api/v1/infra/lb-client-ssl-profiles/{lb-client-ssl-profile-id}
(Deprecated)
|
List LBMonitorProfiles for infra
Paginated list of all LBMonitorProfiles for infra.
|
GET /policy/api/v1/infra/lb-monitor-profiles
(Deprecated)
|
Delete LBMonitorProfile and all the entities contained by this LBMonitorProfile
Delete the LBMonitorProfile along with all the entities contained
by this LBMonitorProfile.
|
DELETE /policy/api/v1/infra/lb-monitor-profiles/{lb-monitor-profile-id}
(Deprecated)
|
Read LBMonitorProfile
Read a LBMonitorProfile.
|
GET /policy/api/v1/infra/lb-monitor-profiles/{lb-monitor-profile-id}
(Deprecated)
|
Create or update a LBMonitorProfile
If a LBMonitorProfile with the lb-monitor-profile-id is not
already present, create a new LBMonitorProfile. If it already exists,
update the LBMonitorProfile. This is a full replace.
|
PATCH /policy/api/v1/infra/lb-monitor-profiles/{lb-monitor-profile-id}
(Deprecated)
|
Create or update a LBMonitorProfile
If a LBMonitorProfile with the lb-monitor-profile-id is not
already present, create a new LBMonitorProfile. If it already exists,
update the LBMonitorProfile. This is a full replace.
|
PUT /policy/api/v1/infra/lb-monitor-profiles/{lb-monitor-profile-id}
(Deprecated)
|
Read load balancer usage for the given node
API is used to retrieve node usage for load balancer which contains basic
information, LB entity usages and capacities for the given node.
Currently only edge node is supported.
The parameter ?node_path=<node-path> is required. For example, ?node_path=
/infra/sites/default/enforcement-points/default/edge-clusters/
85175e0b-4d74-461d-83e1-f3b785adef9c/edge-nodes/
86e077c0-449f-11e9-87c8-02004eb37029.
|
GET /policy/api/v1/infra/lb-node-usage
(Deprecated)
|
Read load balancer node usage summary
The API is used to retrieve the load balancer node usage summary of all
nodes for every enforcement point.
- If the parameter ?include_usages=true exists, the property node_usages
are included in response. By default, the property node_usages is not
included in response.
- If parameter ?enforcement_point_path=<enforcement-point-path> exists,
only node usage summary from specific enforcement point is included
in response. If no enforcement point path is specified, information will
be aggregated from each enforcement point.
|
GET /policy/api/v1/infra/lb-node-usage-summary
(Deprecated)
|
List LBPersistenceProfiles for infra
Paginated list of all LBPersistenceProfiles for infra.
This API is deprecated for the NSX-T Load Balancer, but not for the NSX-T Distributed Load Balancer.
|
GET /policy/api/v1/infra/lb-persistence-profiles
|
Delete LBPersistenceProfile and all the entities contained by this LBPersistenceProfile
Delete the LBPersistenceProfile along with all the entities
contained by this LBPersistenceProfile.
This API is deprecated for the NSX-T Load Balancer, but not for the NSX-T Distributed Load Balancer.
|
DELETE /policy/api/v1/infra/lb-persistence-profiles/{lb-persistence-profile-id}
|
Read LBPersistenceProfile
Read a LBPersistenceProfile.
This API is deprecated for the NSX-T Load Balancer, but not for the NSX-T Distributed Load Balancer.
|
GET /policy/api/v1/infra/lb-persistence-profiles/{lb-persistence-profile-id}
|
Create or update a LBPersistenceProfile
If a LBPersistenceProfile with the lb-persistence-profile-id is not
already present, create a new LBPersistenceProfile. If it already exists,
update the LBPersistenceProfile. This is a full replace.
This API is deprecated for the NSX-T Load Balancer, but not for the NSX-T Distributed Load Balancer.
|
PATCH /policy/api/v1/infra/lb-persistence-profiles/{lb-persistence-profile-id}
|
Create or update a LBPersistenceProfile
If a LBPersistenceProfile with the lb-persistence-profile-id is not
already present, create a new LBPersistenceProfile. If it already exists,
update the LBPersistenceProfile. This is a full replace.
This API is deprecated for the NSX-T Load Balancer, but not for the NSX-T Distributed Load Balancer.
|
PUT /policy/api/v1/infra/lb-persistence-profiles/{lb-persistence-profile-id}
|
List LBPools
Paginated list of all LBPools.
This API is deprecated for the NSX-T Load Balancer, but not for the NSX-T Distributed Load Balancer.
|
GET /policy/api/v1/infra/lb-pools
|
Delete LBPool and all the entities contained by this LBPool
Delete the LBPool along with all the entities contained
by this LBPool.
This API is deprecated for the NSX-T Load Balancer, but not for the NSX-T Distributed Load Balancer.
|
DELETE /policy/api/v1/infra/lb-pools/{lb-pool-id}
|
Read LBPool
Read a LBPool.
This API is deprecated for the NSX-T Load Balancer, but not for the NSX-T Distributed Load Balancer.
|
GET /policy/api/v1/infra/lb-pools/{lb-pool-id}
|
Create or update a LBPool
If a LBPool with the lb-pool-id is not already present,
create a new LBPool. If it already exists, update the
LBPool. This is a full replace.
This API is deprecated for the NSX-T Load Balancer, but not for the NSX-T Distributed Load Balancer.
|
PATCH /policy/api/v1/infra/lb-pools/{lb-pool-id}
|
Create or update a LBPool
If a LBPool with the lb-pool-id is not already present,
create a new LBPool. If it already exists, update the
LBPool. This is a full replace.
This API is deprecated for the NSX-T Load Balancer, but not for the NSX-T Distributed Load Balancer.
|
PUT /policy/api/v1/infra/lb-pools/{lb-pool-id}
|
List LBServerSslProfiles
Paginated list of all LBServerSslProfiles.
|
GET /policy/api/v1/infra/lb-server-ssl-profiles
(Deprecated)
|
Delete LBServerSslProfile and all the entities contained by this
LBServerSslProfile
Delete the LBServerSslProfile along with all the entities contained
by this LBServerSslProfile.
|
DELETE /policy/api/v1/infra/lb-server-ssl-profiles/{lb-server-ssl-profile-id}
(Deprecated)
|
Read LBServerSslProfile
Read a LBServerSslProfile.
|
GET /policy/api/v1/infra/lb-server-ssl-profiles/{lb-server-ssl-profile-id}
(Deprecated)
|
Create or update a LBServerSslProfile
If a LBServerSslProfile with the lb-server-ssl-profile-id is not already
present, create a new LBServerSslProfile. If it already exists, update the
LBServerSslProfile. This is a full replace.
|
PATCH /policy/api/v1/infra/lb-server-ssl-profiles/{lb-server-ssl-profile-id}
(Deprecated)
|
Create or update a LBServerSslProfile
If a LBServerSslProfile with the lb-server-ssl-profile-id is not already
present, create a new LBServerSslProfile. If it already exists, update the
LBServerSslProfile. This is a full replace.
|
PUT /policy/api/v1/infra/lb-server-ssl-profiles/{lb-server-ssl-profile-id}
(Deprecated)
|
Read load balancer service usage summary
API is used to retrieve the load balancer usage summary for
all load balancer services.
If the parameter ?include_usages=true exists, the property service-usages
is included in the response. By default, service-usages is not included
in the response.
This API is deprecated for the NSX-T Load Balancer, but not for the NSX-T Distributed Load Balancer.
|
GET /policy/api/v1/infra/lb-service-usage-summary
|
List LBService
Paginated list of all LBService.
This API is deprecated for the NSX-T Load Balancer, but not for the NSX-T Distributed Load Balancer.
|
GET /policy/api/v1/infra/lb-services
|
Delete LBService and all the entities contained by this LBService
Delete the LBService along with all the entities contained by
this LBService.
This API is deprecated for the NSX-T Load Balancer, but not for the NSX-T Distributed Load Balancer.
|
DELETE /policy/api/v1/infra/lb-services/{lb-service-id}
|
Read LBService
Read an LBService.
This API is deprecated for the NSX-T Load Balancer, but not for the NSX-T Distributed Load Balancer.
|
GET /policy/api/v1/infra/lb-services/{lb-service-id}
|
Create or update a LBVirtualServer
If a LBService with the lb-service-id is not already
present, create a new LBService. If it already exists, update the
LBService. This is a full replace.
This API is deprecated for the NSX-T Load Balancer, but not for the NSX-T Distributed Load Balancer.
|
PATCH /policy/api/v1/infra/lb-services/{lb-service-id}
|
Create or update a LBService
If a LBService with the lb-service-id is not already
present, create a new LBService. If it already exists, update the
LBService. This is a full replace.
This API is deprecated for the NSX-T Load Balancer, but not for the NSX-T Distributed Load Balancer.
|
PUT /policy/api/v1/infra/lb-services/{lb-service-id}
|
Get LBService status information
Get LBService detailed status information.
- no enforcement point path specified: Information will be aggregated from
each enforcement point.
- {enforcement_point_path}: Information will be retrieved only from the
given enforcement point.
This API is deprecated for the NSX-T Load Balancer, but not for the NSX-T Distributed Load Balancer.
|
GET /policy/api/v1/infra/lb-services/{lb-service-id}/detailed-status
|
Get LBPool status information
Get LBPool detailed status information.
- no enforcement point path specified: Information will be aggregated from
each enforcement point.
- {enforcement_point_path}: Information will be retrieved only from the
given enforcement point.
This API is deprecated for the NSX-T Load Balancer, but not for the NSX-T Distributed Load Balancer.
|
GET /policy/api/v1/infra/lb-services/{lb-service-id}/lb-pools/{lb-pool-id}/detailed-status
|
Get LBPool statistics information
Get LBPoolStatistics information.
- no enforcement point path specified: Information will be aggregated from
each enforcement point.
- {enforcement_point_path}: Information will be retrieved only from the
given enforcement point.
This API is deprecated for the NSX-T Load Balancer, but not for the NSX-T Distributed Load Balancer.
|
GET /policy/api/v1/infra/lb-services/{lb-service-id}/lb-pools/{lb-pool-id}/statistics
|
Get LBVirtualServer status information
Get LBVirtualServer detailed status information.
- no enforcement point path specified: Information will be aggregated from
each enforcement point.
- {enforcement_point_path}: Information will be retrieved only from the
given enforcement point.
This API is deprecated for the NSX-T Load Balancer, but not for the NSX-T Distributed Load Balancer.
|
GET /policy/api/v1/infra/lb-services/{lb-service-id}/lb-virtual-servers/{lb-virtual-server-id}/detailed-status
|
Get LBVirtualServer statistics information
Get LBVirtualServerStatistics information.
- no enforcement point path specified: Information will be aggregated from
each enforcement point.
- {enforcement_point_path}: Information will be retrieved only from the
given enforcement point.
This API is deprecated for the NSX-T Load Balancer, but not for the NSX-T Distributed Load Balancer.
|
GET /policy/api/v1/infra/lb-services/{lb-service-id}/lb-virtual-servers/{lb-virtual-server-id}/statistics
|
Get LBService usage information
Get LBServiceUsage information.
- no enforcement point path specified: Information will be aggregated from
each enforcement point.
- {enforcement_point_path}: Information will be retrieved only from the
given enforcement point.
This API is deprecated for the NSX-T Load Balancer, but not for the NSX-T Distributed Load Balancer.
|
GET /policy/api/v1/infra/lb-services/{lb-service-id}/service-usage
|
Get LBService statistics information
Get LBServiceStatistics information.
- no enforcement point path specified: Information will be aggregated from
each enforcement point.
- {enforcement_point_path}: Information will be retrieved only from the
given enforcement point.
This API is deprecated for the NSX-T Load Balancer, but not for the NSX-T Distributed Load Balancer.
|
GET /policy/api/v1/infra/lb-services/{lb-service-id}/statistics
|
Retrieve a list of supported SSL ciphers and protocols
Retrieve a list of supported SSL ciphers and protocols.
|
GET /policy/api/v1/infra/lb-ssl-ciphers-and-protocols
(Deprecated)
|
List LBVirtualServers
Paginated list of all LBVirtualServers.
This API is deprecated for the NSX-T Load Balancer, but not for the NSX-T Distributed Load Balancer.
|
GET /policy/api/v1/infra/lb-virtual-servers
|
Delete LBVirtualServer and all the entities contained by this LBVirtualServer.
Delete the LBVirtualServer along with all the entities contained by
this LBVirtualServer.
This API is deprecated for the NSX-T Load Balancer, but not for the NSX-T Distributed Load Balancer.
|
DELETE /policy/api/v1/infra/lb-virtual-servers/{lb-virtual-server-id}
|
Read LBVirtualServer
Read a LBVirtualServer.
This API is deprecated for the NSX-T Load Balancer, but not for the NSX-T Distributed Load Balancer.
|
GET /policy/api/v1/infra/lb-virtual-servers/{lb-virtual-server-id}
|
Create or update a LBVirtualServer
If a LBVirtualServer with the lb-virtual-server-id is not already
present, create a new LBVirtualServer. If it already exists, update the
LBVirtualServer. This is a full replace.
This API is deprecated for the NSX-T Load Balancer, but not for the NSX-T Distributed Load Balancer.
|
PATCH /policy/api/v1/infra/lb-virtual-servers/{lb-virtual-server-id}
|
Create or update a LBVirtualServer
If a LBVirtualServer with the lb-virtual-server-id is not already
present, create a new LBVirtualServer. If it already exists, update the
LBVirtualServer. This is a full replace.
This API is deprecated for the NSX-T Load Balancer, but not for the NSX-T Distributed Load Balancer.
|
PUT /policy/api/v1/infra/lb-virtual-servers/{lb-virtual-server-id}
|
List Mac Discovery Profiles
API will list all Mac Discovery Profiles active in current discovery profile id.
|
GET /policy/api/v1/infra/mac-discovery-profiles
GET /policy/api/v1/global-infra/mac-discovery-profiles
GET /policy/api/v1/orgs/{org-id}/projects/{project-id}/infra/mac-discovery-profiles
|
Delete Mac Discovery Profile
API will delete Mac Discovery profile.
|
DELETE /policy/api/v1/infra/mac-discovery-profiles/{mac-discovery-profile-id}
DELETE /policy/api/v1/global-infra/mac-discovery-profiles/{mac-discovery-profile-id}
DELETE /policy/api/v1/orgs/{org-id}/projects/{project-id}/infra/mac-discovery-profiles/{mac-discovery-profile-id}
|
Get Mac Discovery Profile
API will get Mac Discovery profile.
|
GET /policy/api/v1/infra/mac-discovery-profiles/{mac-discovery-profile-id}
GET /policy/api/v1/global-infra/mac-discovery-profiles/{mac-discovery-profile-id}
GET /policy/api/v1/orgs/{org-id}/projects/{project-id}/infra/mac-discovery-profiles/{mac-discovery-profile-id}
|
Create Mac Discovery Profile
API will create Mac Discovery profile.
|
PATCH /policy/api/v1/infra/mac-discovery-profiles/{mac-discovery-profile-id}
PATCH /policy/api/v1/global-infra/mac-discovery-profiles/{mac-discovery-profile-id}
PATCH /policy/api/v1/orgs/{org-id}/projects/{project-id}/infra/mac-discovery-profiles/{mac-discovery-profile-id}
|
Update Mac Discovery Profile
API will update Mac Discovery profile.
|
PUT /policy/api/v1/infra/mac-discovery-profiles/{mac-discovery-profile-id}
PUT /policy/api/v1/global-infra/mac-discovery-profiles/{mac-discovery-profile-id}
PUT /policy/api/v1/orgs/{org-id}/projects/{project-id}/infra/mac-discovery-profiles/{mac-discovery-profile-id}
|
List Manager Ip Pools
Paginated list of Manager Ip Pools.
|
GET /policy/api/v1/infra/manager-ip-pools
|
Read a Manager Ip Pool
Read Manager Ip Pool with given Id.
|
GET /policy/api/v1/infra/manager-ip-pools/{manager-ip-pool-id}
|
List Metadata Proxy Configurations
List all L2 Metadata Proxy Configurations
|
GET /policy/api/v1/infra/metadata-proxies
|
Delete Metadata Proxy Config
API will delete Metadata Proxy Config with ID profile-id
|
DELETE /policy/api/v1/infra/metadata-proxies/{metadata-proxy-id}
|
Get Metadata Proxy Config
API will read Metadata Proxy Config with ID profile-id
|
GET /policy/api/v1/infra/metadata-proxies/{metadata-proxy-id}
|
Create or update Metadata Proxy Config
API will create or update Metadata Proxy Config with ID profile-id.
Maximum 10 Metadata Proxy Configurations are supported.
|
PATCH /policy/api/v1/infra/metadata-proxies/{metadata-proxy-id}
|
Create or update Metadata Proxy Config
API will create or update Metadata Proxy Config with ID profile-id
|
PUT /policy/api/v1/infra/metadata-proxies/{metadata-proxy-id}
|
Get metadata proxy status
|
GET /policy/api/v1/infra/metadata-proxies/{metadata-proxy-id}/statistics
GET /policy/api/v1/global-infra/metadata-proxies/{metadata-proxy-id}/statistics
|
Get metadata proxy status
|
GET /policy/api/v1/infra/metadata-proxies/{metadata-proxy-id}/status
GET /policy/api/v1/global-infra/metadata-proxies/{metadata-proxy-id}/status
|
Read global Operations Configuration
Read global Operations Configuration
|
GET /policy/api/v1/infra/ops-global-config
GET /policy/api/v1/orgs/{org-id}/projects/{project-id}/infra/ops-global-config
|
Update the global Operationconfiguration
Update the global Operationconfiguration
|
PATCH /policy/api/v1/infra/ops-global-config
PATCH /policy/api/v1/orgs/{org-id}/projects/{project-id}/infra/ops-global-config
|
Update the global Operations Configuration
Update the global Operations Configuration
|
PUT /policy/api/v1/infra/ops-global-config
PUT /policy/api/v1/orgs/{org-id}/projects/{project-id}/infra/ops-global-config
|
List Pim Profile
List all pim profile.
|
GET /policy/api/v1/infra/pim-profiles
|
Delete Pim Profile
Delete Pim Profile.
|
DELETE /policy/api/v1/infra/pim-profiles/{pim-profile-id}
|
Read Pim Profile
Read Pim Profile.
|
GET /policy/api/v1/infra/pim-profiles/{pim-profile-id}
|
Update pim profile
Create a pim profile with the pim-profile-id is not already present,
otherwise update the pim profile.
|
PATCH /policy/api/v1/infra/pim-profiles/{pim-profile-id}
|
Update pim profile
Create or update pim profile.
|
PUT /policy/api/v1/infra/pim-profiles/{pim-profile-id}
|
List QoS Profiles
API will list all QoS profiles.
|
GET /policy/api/v1/infra/qos-profiles
GET /policy/api/v1/global-infra/qos-profiles
GET /policy/api/v1/orgs/{org-id}/projects/{project-id}/infra/qos-profiles
|
Delete QoS profile
API will delete QoS profile.
|
DELETE /policy/api/v1/infra/qos-profiles/{qos-profile-id}
DELETE /policy/api/v1/global-infra/qos-profiles/{qos-profile-id}
DELETE /policy/api/v1/orgs/{org-id}/projects/{project-id}/infra/qos-profiles/{qos-profile-id}
|
Details of QoS profile
API will return details of QoS profile.
|
GET /policy/api/v1/infra/qos-profiles/{qos-profile-id}
GET /policy/api/v1/global-infra/qos-profiles/{qos-profile-id}
GET /policy/api/v1/orgs/{org-id}/projects/{project-id}/infra/qos-profiles/{qos-profile-id}
|
Patch QoS profile.
Create a new QoS profile if the QoS profile with
given id does not already exist. If the QoS profile with the
given id already exists, patch with the existing QoS profile.
|
PATCH /policy/api/v1/infra/qos-profiles/{qos-profile-id}
PATCH /policy/api/v1/global-infra/qos-profiles/{qos-profile-id}
PATCH /policy/api/v1/orgs/{org-id}/projects/{project-id}/infra/qos-profiles/{qos-profile-id}
|
Create or Replace QoS profile.
Create or Replace QoS profile.
|
PUT /policy/api/v1/infra/qos-profiles/{qos-profile-id}
PUT /policy/api/v1/global-infra/qos-profiles/{qos-profile-id}
PUT /policy/api/v1/orgs/{org-id}/projects/{project-id}/infra/qos-profiles/{qos-profile-id}
|
List prefix lists
Paginated list of all prefix lists
|
GET /policy/api/v1/infra/routing-config/prefix-lists
|
Delete a prefix list
Delete a prefix list
|
DELETE /policy/api/v1/infra/routing-config/prefix-lists/{prefix-list-id}
|
Read a prefix list
Read a prefix list
|
GET /policy/api/v1/infra/routing-config/prefix-lists/{prefix-list-id}
|
Create or patch a prefix list
If prefix list for prefix-list-id is not already present, create
a prefix list. If it already exists, patch prefix list for prefix-list-id.
Note:
Patching existing prefix-list's "prefixes" property will overwrite the existing prefixes.
GET and PATCH is the expected set of operations to update or append new entries to the existig prefixes.
Patching existing prefixes require order to be preserved to avoid traffic impact. During PATCH operation,
reordering of existing prefixes may impact routes and eventually datapath.
Order here is crucial and it all depends upon action. If action for every prefix is PERMIT then order may
not impact but if there is DENY prefix then change in ordering could lead to traffic impact.
|
PATCH /policy/api/v1/infra/routing-config/prefix-lists/{prefix-list-id}
|
Create or update a prefix list
If prefix list for prefix-list-id is not already present, create
a prefix list. If it already exists, replace the prefix list for
prefix-list-id.
Note:
Updating existing prefixes require order to be preserved to avoid traffic impact. During PATCH operation,
reordering of existing prefixes may impact routes and eventually datapath.
Order here is crucial and it all depends upon action. If action for every prefix is PERMIT then order may
not impact but if there is DENY prefix then change in ordering could lead to traffic impact.
|
PUT /policy/api/v1/infra/routing-config/prefix-lists/{prefix-list-id}
|
List project route filter lists
Paginated list of all route filter lists
|
GET /policy/api/v1/infra/routing-config/project-route-filters
|
Delete a route filter
Delete a route filter
|
DELETE /policy/api/v1/infra/routing-config/project-route-filters/{route-filter-id}
|
Read a project route filter
Read a project route filter
|
GET /policy/api/v1/infra/routing-config/project-route-filters/{route-filter-id}
|
Create or patch a route filter
Create or patch a route filter. This will create a mapping of projects to prefix lists. Prefix lists will be
applied to all T-1 under the specified projects.
|
PATCH /policy/api/v1/infra/routing-config/project-route-filters/{route-filter-id}
|
Create or update project route filter
Create or update a route filter
|
PUT /policy/api/v1/infra/routing-config/project-route-filters/{route-filter-id}
|
Read security global configuration
This reads the security-global-config used for NSX Manager appliance certificates.
These properties are not sent to the hosts.
|
GET /policy/api/v1/infra/security-global-config
GET /policy/api/v1/global-infra/security-global-config
|
Update the security global configuration
This updates the security-global-config used for NSX Manager appliance certificates.
These properties are not sent to the hosts.
|
PUT /policy/api/v1/infra/security-global-config
PUT /policy/api/v1/global-infra/security-global-config
|
List segment security profiles
API will list all segment security profiles.
|
GET /policy/api/v1/infra/segment-security-profiles
GET /policy/api/v1/global-infra/segment-security-profiles
GET /policy/api/v1/orgs/{org-id}/projects/{project-id}/infra/segment-security-profiles
|
DELETE segment security profile
API will delete segment security profile with the given id.
|
DELETE /policy/api/v1/infra/segment-security-profiles/{segment-security-profile-id}
DELETE /policy/api/v1/global-infra/segment-security-profiles/{segment-security-profile-id}
DELETE /policy/api/v1/orgs/{org-id}/projects/{project-id}/infra/segment-security-profiles/{segment-security-profile-id}
|
GET Segment security profile id
API will return details of the segment security profile with given id. If the
profile does not exist, it will return 404.
|
GET /policy/api/v1/infra/segment-security-profiles/{segment-security-profile-id}
GET /policy/api/v1/global-infra/segment-security-profiles/{segment-security-profile-id}
GET /policy/api/v1/orgs/{org-id}/projects/{project-id}/infra/segment-security-profiles/{segment-security-profile-id}
|
PATCH segment security profile id
Create a new segment security profile if the segment security profile with given id does not
exist. Otherwise, PATCH the existing segment security profile
|
PATCH /policy/api/v1/infra/segment-security-profiles/{segment-security-profile-id}
PATCH /policy/api/v1/global-infra/segment-security-profiles/{segment-security-profile-id}
PATCH /policy/api/v1/orgs/{org-id}/projects/{project-id}/infra/segment-security-profiles/{segment-security-profile-id}
|
PUT segment security profile id
Create or replace a segment security profile
|
PUT /policy/api/v1/infra/segment-security-profiles/{segment-security-profile-id}
PUT /policy/api/v1/global-infra/segment-security-profiles/{segment-security-profile-id}
PUT /policy/api/v1/orgs/{org-id}/projects/{project-id}/infra/segment-security-profiles/{segment-security-profile-id}
|
List all segments under infra
Paginated list of all segments under infra.
|
GET /policy/api/v1/infra/segments
GET /policy/api/v1/global-infra/segments
GET /policy/api/v1/orgs/{org-id}/projects/{project-id}/infra/segments
|
List Infra Port Discovery Profile Binding Maps
API will list all Infra Port Discovery Profile Binding Maps in current port id.
|
GET /policy/api/v1/infra/segments/{infra-segment-id}/ports/{infra-port-id}/port-discovery-profile-binding-maps
GET /policy/api/v1/global-infra/segments/{infra-segment-id}/ports/{infra-port-id}/port-discovery-profile-binding-maps
GET /policy/api/v1/orgs/{org-id}/projects/{project-id}/infra/segments/{infra-segment-id}/ports/{infra-port-id}/port-discovery-profile-binding-maps
|
Delete Infra Port Discovery Profile Binding Profile
API will delete Infra Port Discovery Profile Binding Profile
|
DELETE /policy/api/v1/infra/segments/{infra-segment-id}/ports/{infra-port-id}/port-discovery-profile-binding-maps/{port-discovery-profile-binding-map-id}
DELETE /policy/api/v1/global-infra/segments/{infra-segment-id}/ports/{infra-port-id}/port-discovery-profile-binding-maps/{port-discovery-profile-binding-map-id}
DELETE /policy/api/v1/orgs/{org-id}/projects/{project-id}/infra/segments/{infra-segment-id}/ports/{infra-port-id}/port-discovery-profile-binding-maps/{port-discovery-profile-binding-map-id}
|
Get Infra Port Discovery Profile Binding Map
API will get Infra Port Discovery Profile Binding Map
|
GET /policy/api/v1/infra/segments/{infra-segment-id}/ports/{infra-port-id}/port-discovery-profile-binding-maps/{port-discovery-profile-binding-map-id}
GET /policy/api/v1/global-infra/segments/{infra-segment-id}/ports/{infra-port-id}/port-discovery-profile-binding-maps/{port-discovery-profile-binding-map-id}
GET /policy/api/v1/orgs/{org-id}/projects/{project-id}/infra/segments/{infra-segment-id}/ports/{infra-port-id}/port-discovery-profile-binding-maps/{port-discovery-profile-binding-map-id}
|
Create Infra Port Discovery Profile Binding Map
API will create Infra Port Discovery Profile Binding Map. For objects with no binding maps, default profile is applied.
|
PATCH /policy/api/v1/infra/segments/{infra-segment-id}/ports/{infra-port-id}/port-discovery-profile-binding-maps/{port-discovery-profile-binding-map-id}
PATCH /policy/api/v1/global-infra/segments/{infra-segment-id}/ports/{infra-port-id}/port-discovery-profile-binding-maps/{port-discovery-profile-binding-map-id}
PATCH /policy/api/v1/orgs/{org-id}/projects/{project-id}/infra/segments/{infra-segment-id}/ports/{infra-port-id}/port-discovery-profile-binding-maps/{port-discovery-profile-binding-map-id}
|
Update Infra Port Discovery Profile Binding Map
API will update Infra Port Discovery Profile Binding Map. For objects with no binding maps, default profile is applied.
|
PUT /policy/api/v1/infra/segments/{infra-segment-id}/ports/{infra-port-id}/port-discovery-profile-binding-maps/{port-discovery-profile-binding-map-id}
PUT /policy/api/v1/global-infra/segments/{infra-segment-id}/ports/{infra-port-id}/port-discovery-profile-binding-maps/{port-discovery-profile-binding-map-id}
PUT /policy/api/v1/orgs/{org-id}/projects/{project-id}/infra/segments/{infra-segment-id}/ports/{infra-port-id}/port-discovery-profile-binding-maps/{port-discovery-profile-binding-map-id}
|
List Infra Port Monitoring Profile Binding Maps
API will list all Infra Port Monitoring Profile Binding Maps in current port id.
|
GET /policy/api/v1/infra/segments/{infra-segment-id}/ports/{infra-port-id}/port-monitoring-profile-binding-maps
|
Delete Infra Port Monitoring Profile Binding Profile
API will delete Infra Port Monitoring Profile Binding Profile.
|
DELETE /policy/api/v1/infra/segments/{infra-segment-id}/ports/{infra-port-id}/port-monitoring-profile-binding-maps/{port-monitoring-profile-binding-map-id}
|
Get Infra Port Monitoring Profile Binding Map
API will get Infra Port Monitoring Profile Binding Map.
|
GET /policy/api/v1/infra/segments/{infra-segment-id}/ports/{infra-port-id}/port-monitoring-profile-binding-maps/{port-monitoring-profile-binding-map-id}
|
Create Infra Port Monitoring Profile Binding Map
API will create Infra Port Monitoring Profile Binding Map.
|
PATCH /policy/api/v1/infra/segments/{infra-segment-id}/ports/{infra-port-id}/port-monitoring-profile-binding-maps/{port-monitoring-profile-binding-map-id}
|
Update Infra Port Monitoring Profile Binding Map
API will update Infra Port Monitoring Profile Binding Map.
|
PUT /policy/api/v1/infra/segments/{infra-segment-id}/ports/{infra-port-id}/port-monitoring-profile-binding-maps/{port-monitoring-profile-binding-map-id}
|
Get mirror stack status for Infra Port Monitoring Profile Binding Map
API will get Infra Port Monitoring Profile Binding Map mirror stack status.
|
GET /policy/api/v1/infra/segments/{infra-segment-id}/ports/{infra-port-id}/port-monitoring-profile-binding-maps/{port-monitoring-profile-binding-map-id}/mirror-stack-status
|
List Infra Segment Discovery Profile Binding Maps
API will list all Infra Segment Discovery Profile Binding Maps in current segment id.
|
GET /policy/api/v1/infra/segments/{infra-segment-id}/segment-discovery-profile-binding-maps
GET /policy/api/v1/global-infra/segments/{infra-segment-id}/segment-discovery-profile-binding-maps
GET /policy/api/v1/orgs/{org-id}/projects/{project-id}/infra/segments/{infra-segment-id}/segment-discovery-profile-binding-maps
|
Delete Segment Discovery Profile Binding Profile
API will delete Segment Discovery Profile Binding Profile
|
DELETE /policy/api/v1/infra/segments/{infra-segment-id}/segment-discovery-profile-binding-maps/{segment-discovery-profile-binding-map-id}
DELETE /policy/api/v1/orgs/{org-id}/projects/{project-id}/infra/segments/{infra-segment-id}/segment-discovery-profile-binding-maps/{segment-discovery-profile-binding-map-id}
|
Get Infra Segment Discovery Profile Binding Map
API will get Infra Segment Discovery Profile Binding Map
|
GET /policy/api/v1/infra/segments/{infra-segment-id}/segment-discovery-profile-binding-maps/{segment-discovery-profile-binding-map-id}
GET /policy/api/v1/global-infra/segments/{infra-segment-id}/segment-discovery-profile-binding-maps/{segment-discovery-profile-binding-map-id}
GET /policy/api/v1/orgs/{org-id}/projects/{project-id}/infra/segments/{infra-segment-id}/segment-discovery-profile-binding-maps/{segment-discovery-profile-binding-map-id}
|
Create Infra Segment Discovery Profile Binding Map
API will create Infra Segment Discovery Profile Binding Map. For objects with no binding maps, default profile is applied.
|
PATCH /policy/api/v1/infra/segments/{infra-segment-id}/segment-discovery-profile-binding-maps/{segment-discovery-profile-binding-map-id}
PATCH /policy/api/v1/orgs/{org-id}/projects/{project-id}/infra/segments/{infra-segment-id}/segment-discovery-profile-binding-maps/{segment-discovery-profile-binding-map-id}
|
Update Infra Segment Discovery Profile Binding Map
API will update Infra Segment Discovery Profile Binding Map. For objects with no binding maps, default profile is applied.
|
PUT /policy/api/v1/infra/segments/{infra-segment-id}/segment-discovery-profile-binding-maps/{segment-discovery-profile-binding-map-id}
PUT /policy/api/v1/orgs/{org-id}/projects/{project-id}/infra/segments/{infra-segment-id}/segment-discovery-profile-binding-maps/{segment-discovery-profile-binding-map-id}
|
List Infra Segment Monitoring Profile Binding Maps
API will list all Infra Segment Monitoring Profile Binding Maps in current segment id.
|
GET /policy/api/v1/infra/segments/{infra-segment-id}/segment-monitoring-profile-binding-maps
|
Delete Infra Segment Monitoring Profile Binding Profile
API will delete Infra Segment Monitoring Profile Binding Profile.
|
DELETE /policy/api/v1/infra/segments/{infra-segment-id}/segment-monitoring-profile-binding-maps/{segment-monitoring-profile-binding-map-id}
|
Get Infra Segment Monitoring Profile Binding Map
API will get Infra Segment Monitoring Profile Binding Map.
|
GET /policy/api/v1/infra/segments/{infra-segment-id}/segment-monitoring-profile-binding-maps/{segment-monitoring-profile-binding-map-id}
|
Create Infra Segment Monitoring Profile Binding Map
API will create infra segment monitoring profile binding map.
|
PATCH /policy/api/v1/infra/segments/{infra-segment-id}/segment-monitoring-profile-binding-maps/{segment-monitoring-profile-binding-map-id}
|
Update Infra Segment Monitoring Profile Binding Map
API will update Infra Segment Monitoring Profile Binding Map.
|
PUT /policy/api/v1/infra/segments/{infra-segment-id}/segment-monitoring-profile-binding-maps/{segment-monitoring-profile-binding-map-id}
|
Get Infra Segment Monitoring Profile Binding Map
API will get Infra Segment Monitoring Profile Binding Map mirror stack status.
|
GET /policy/api/v1/infra/segments/{infra-segment-id}/segment-monitoring-profile-binding-maps/{segment-monitoring-profile-binding-map-id}/mirror-stack-status
|
Delete infra segment
Delete infra segment
|
DELETE /policy/api/v1/infra/segments/{segment-id}
DELETE /policy/api/v1/orgs/{org-id}/projects/{project-id}/infra/segments/{segment-id}
|
Force delete infra segment
Force delete bypasses validations during segment deletion. This may result in an inconsistent connectivity.
|
DELETE /policy/api/v1/infra/segments/{segment-id}?force=true
DELETE /policy/api/v1/orgs/{org-id}/projects/{project-id}/infra/segments/{segment-id}?force=true
|
Read infra segment
Read infra segment
Note:
Extended Segment: Please note that old vpn path deprecated. If user specify old l2vpn path in the
"l2_extension" object in the PATCH API payload, the path returned in the GET response payload may include the new path
instead of the deprecated l2vpn path. Both old and new l2vpn path refer to same resource. there is no functional impact.
Also note that l2vpn path included in the error messages returned from validation may include the new VPN path
instead of the deprecated l2vpn path. Both new path and old vpn path refer to same resource.
|
GET /policy/api/v1/infra/segments/{segment-id}
GET /policy/api/v1/global-infra/segments/{segment-id}
GET /policy/api/v1/orgs/{org-id}/projects/{project-id}/infra/segments/{segment-id}
|
Create or update a segment
If segment with the segment-id is not already present, create a new segment.
If it already exists, update the segment with specified attributes.
Force parameter is required when workload connectivity is indirectly impacted
with the current update.
|
PATCH /policy/api/v1/infra/segments/{segment-id}?force=true
PATCH /policy/api/v1/orgs/{org-id}/projects/{project-id}/infra/segments/{segment-id}?force=true
|
Create or update a segment
If segment with the segment-id is not already present, create a new segment.
If it already exists, update the segment with specified attributes.
|
PATCH /policy/api/v1/infra/segments/{segment-id}
PATCH /policy/api/v1/orgs/{org-id}/projects/{project-id}/infra/segments/{segment-id}
|
Delete DHCP lease(s) specified by IP and MAC
Delete one or multiple DHCP lease(s) specified by IP and MAC.
If there is a DHCP server running upon the given segment, or this segment
is using a DHCP server running in its connected Tier-0 or Tier-1, the DHCP
lease(s) which match exactly the IP address and the MAC address will be
deleted. If no such lease matches, the deletion for this lease will be
ignored.
The DHCP lease to be deleted will be removed by the system from both active
and standby node. The system will report error if the DHCP lease could not
be removed from both nodes. If the DHCP lease could not be removed on either
node, please check the DHCP server status. Once the DHCP server status is
UP, please invoke the deletion API again to ensure the lease gets deleted
from both nodes.
|
POST /policy/api/v1/infra/segments/{segment-id}?action=delete_dhcp_leases
POST /policy/api/v1/orgs/{org-id}/projects/{project-id}/infra/segments/{segment-id}?action=delete_dhcp_leases
|
Create or update a infra segment
If segment with the segment-id is not already present, create a new segment.
If it already exists, replace the segment with this object.
Note:
Extended Segment: Please note that old vpn path deprecated. If user specify old l2vpn path in the
"l2_extension" object in the PATCH API payload, the path returned in the GET response payload may include the new path
instead of the deprecated l2vpn path. Both old and new l2vpn path refer to same resource. there is no functional impact.
Also note that l2vpn path included in the Alarm, GPRR, error messages returned from validation may include the new VPN path
instead of the deprecated l2vpn path. Both new path and old vpn path refer to same resource.
|
PUT /policy/api/v1/infra/segments/{segment-id}
PUT /policy/api/v1/orgs/{org-id}/projects/{project-id}/infra/segments/{segment-id}
|
Create or update a infra segment
If segment with the segment-id is not already present, create a new segment.
If it already exists, replace the segment with this object.
Force parameter is required when workload connectivity is indirectly impacted
with the current replacement.
Note:
Extended Segment: Please note that old vpn path deprecated. If user specify old l2vpn path in the
"l2_extension" object in the PATCH API payload, the path returned in the GET response payload may include the new path
instead of the deprecated l2vpn path. Both old and new l2vpn path refer to same resource. there is no functional impact.
Also note that l2vpn path included in the Alarm, GPRR, error messages returned from validation may include the new VPN path
instead of the deprecated l2vpn path. Both new path and old vpn path refer to same resource.
|
PUT /policy/api/v1/infra/segments/{segment-id}?force=true
PUT /policy/api/v1/orgs/{org-id}/projects/{project-id}/infra/segments/{segment-id}?force=true
|
Get downlink port Address Resolution Protocol Proxies for infra segment
Returns ARP proxy table for downlink port on connected to the segment
|
GET /policy/api/v1/infra/segments/{segment-id}/arp-proxy
GET /policy/api/v1/global-infra/segments/{segment-id}/arp-proxy
GET /policy/api/v1/orgs/{org-id}/projects/{project-id}/infra/segments/{segment-id}/arp-proxy
|
Get downlink port Address Resolution Protocol Proxies for infra segment in CSV format
Returns ARP proxy table for downlink port on connected to the segment in CSV format
|
GET /policy/api/v1/infra/segments/{segment-id}/arp-proxy?format=csv
GET /policy/api/v1/global-infra/segments/{segment-id}/arp-proxy?format=csv
GET /policy/api/v1/orgs/{org-id}/projects/{project-id}/infra/segments/{segment-id}/arp-proxy?format=csv
|
Get ARP table from segment interface (downlink) in CSV format
Returns ARP table (IPv4) or Neighbor Discovery table (IPv6) in CSV format for the
interface (downlink) attaching segment to tier-0/tier-1 gateway, on a edge
node specified in edge_path parameter.
The edge_path parameter is mandatory.
|
GET /policy/api/v1/infra/segments/{segment-id}/arp-table?format=csv
GET /policy/api/v1/global-infra/segments/{segment-id}/arp-table?format=csv
GET /policy/api/v1/orgs/{org-id}/projects/{project-id}/infra/segments/{segment-id}/arp-table?format=csv
|
Get ARP table from segment interface (downlink)
Returns ARP table (IPv4) or Neighbor Discovery table (IPv6) for the
interface (downlink) attaching segment to tier-0/tier-1 gateway, on a edge
node specified in edge_path parameter.
The edge_path parameter is mandatory.
|
GET /policy/api/v1/infra/segments/{segment-id}/arp-table
GET /policy/api/v1/global-infra/segments/{segment-id}/arp-table
GET /policy/api/v1/orgs/{org-id}/projects/{project-id}/infra/segments/{segment-id}/arp-table
|
Get infra segment bridge end point statistics using segment ID and profile path.
Get detailed information on infra segment bridge end point statistics using segment ID and profile path.
|
GET /policy/api/v1/infra/segments/{segment-id}/bep-statistics
|
Get Tier-1 segment bridge end point status using segment ID and profile path.
Get detailed information on Tier-1 segment bridge end point status using segment ID and profile path.
|
GET /policy/api/v1/infra/segments/{segment-id}/bep-status
|
List all DHCP static bindings
Paginated list of all DHCP static binding instances
|
GET /policy/api/v1/infra/segments/{segment-id}/dhcp-static-binding-configs
GET /policy/api/v1/global-infra/segments/{segment-id}/dhcp-static-binding-configs
GET /policy/api/v1/orgs/{org-id}/projects/{project-id}/infra/segments/{segment-id}/dhcp-static-binding-configs
|
Delete DHCP static binding
Delete DHCP static binding
|
DELETE /policy/api/v1/infra/segments/{segment-id}/dhcp-static-binding-configs/{binding-id}
DELETE /policy/api/v1/orgs/{org-id}/projects/{project-id}/infra/segments/{segment-id}/dhcp-static-binding-configs/{binding-id}
|
Read DHCP static binding
Read DHCP static binding
|
GET /policy/api/v1/infra/segments/{segment-id}/dhcp-static-binding-configs/{binding-id}
GET /policy/api/v1/global-infra/segments/{segment-id}/dhcp-static-binding-configs/{binding-id}
GET /policy/api/v1/orgs/{org-id}/projects/{project-id}/infra/segments/{segment-id}/dhcp-static-binding-configs/{binding-id}
|
Create or update DHCP static binding
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.
|
PATCH /policy/api/v1/infra/segments/{segment-id}/dhcp-static-binding-configs/{binding-id}
PATCH /policy/api/v1/orgs/{org-id}/projects/{project-id}/infra/segments/{segment-id}/dhcp-static-binding-configs/{binding-id}
|
Create or update DHCP static binding
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.
|
PUT /policy/api/v1/infra/segments/{segment-id}/dhcp-static-binding-configs/{binding-id}
PUT /policy/api/v1/orgs/{org-id}/projects/{project-id}/infra/segments/{segment-id}/dhcp-static-binding-configs/{binding-id}
|
Read DHCP static binding state
Read DHCP static binding state
|
GET /policy/api/v1/infra/segments/{segment-id}/dhcp-static-bindings/{binding-id}/state
GET /policy/api/v1/global-infra/segments/{segment-id}/dhcp-static-bindings/{binding-id}/state
GET /policy/api/v1/orgs/{org-id}/projects/{project-id}/infra/segments/{segment-id}/dhcp-static-bindings/{binding-id}/state
|
List all effective profiles for infra segment
List all effective profiles for this segment on given enforcement point.
|
GET /policy/api/v1/infra/segments/{segment-id}/effective-profiles
GET /policy/api/v1/global-infra/segments/{segment-id}/effective-profiles
GET /policy/api/v1/orgs/{org-id}/projects/{project-id}/infra/segments/{segment-id}/effective-profiles
|
Get ARP table for downlink router port on tier-0 router
Get ARP table for downlink router port on tier-0 router.
|
GET /policy/api/v1/infra/segments/{segment-id}/gateway-interface-arp-table
(Deprecated)
GET /policy/api/v1/global-infra/segments/{segment-id}/gateway-interface-arp-table
(Deprecated)
GET /policy/api/v1/orgs/{org-id}/projects/{project-id}/infra/segments/{segment-id}/gateway-interface-arp-table
(Deprecated)
|
Get ARP table for downlink router port on tier-0 router in CSV
Get ARP table for downlink router port on tier-0 router in CSV.
|
GET /policy/api/v1/infra/segments/{segment-id}/gateway-interface-arp-table?format=csv
(Deprecated)
GET /policy/api/v1/global-infra/segments/{segment-id}/gateway-interface-arp-table?format=csv
(Deprecated)
GET /policy/api/v1/orgs/{org-id}/projects/{project-id}/infra/segments/{segment-id}/gateway-interface-arp-table?format=csv
(Deprecated)
|
Get DAD state for downlink router port on tier-0 router
Segment ID is the ID of the segment that is connected to the the tier-0
|
GET /policy/api/v1/infra/segments/{segment-id}/gateway-interface-dad-state
GET /policy/api/v1/global-infra/segments/{segment-id}/gateway-interface-dad-state
GET /policy/api/v1/orgs/{org-id}/projects/{project-id}/infra/segments/{segment-id}/gateway-interface-dad-state
|
Get statistics for downlink router port on tier-0 router
Segment ID is the ID of the segment that is connected to the the tier-0
|
GET /policy/api/v1/infra/segments/{segment-id}/gateway-interface-statistics
GET /policy/api/v1/global-infra/segments/{segment-id}/gateway-interface-statistics
GET /policy/api/v1/orgs/{org-id}/projects/{project-id}/infra/segments/{segment-id}/gateway-interface-statistics
|
Get statistics for downlink router port on tier-0 router
Segment ID is the ID of the segment that is connected to the the tier-0
|
GET /policy/api/v1/infra/segments/{segment-id}/gateway-interface-statistics/summary
GET /policy/api/v1/global-infra/segments/{segment-id}/gateway-interface-statistics/summary
GET /policy/api/v1/orgs/{org-id}/projects/{project-id}/infra/segments/{segment-id}/gateway-interface-statistics/summary
|
Get infra segment MAC table in CSV
Returns MAC table for a segment
|
GET /policy/api/v1/infra/segments/{segment-id}/mac-table?format=csv
GET /policy/api/v1/global-infra/segments/{segment-id}/mac-table?format=csv
GET /policy/api/v1/orgs/{org-id}/projects/{project-id}/infra/segments/{segment-id}/mac-table?format=csv
|
Get infra segment MAC table
Returns MAC table for a segment
|
GET /policy/api/v1/infra/segments/{segment-id}/mac-table
GET /policy/api/v1/global-infra/segments/{segment-id}/mac-table
GET /policy/api/v1/orgs/{org-id}/projects/{project-id}/infra/segments/{segment-id}/mac-table
|
List infra segment ports
List all the ports for an infra.
|
GET /policy/api/v1/infra/segments/{segment-id}/ports
GET /policy/api/v1/global-infra/segments/{segment-id}/ports
GET /policy/api/v1/orgs/{org-id}/projects/{project-id}/infra/segments/{segment-id}/ports
|
Delete an infra segment port
Delete an infra segment port by giving ID. Please note that this operation will not delete
the segment port from vCenter Server if the port was connected to a Virtual Machine.
Please connect Virtual Machine to another network for the segment port to be deleted
from vCenter Server.
|
DELETE /policy/api/v1/infra/segments/{segment-id}/ports/{port-id}
DELETE /policy/api/v1/global-infra/segments/{segment-id}/ports/{port-id}
DELETE /policy/api/v1/orgs/{org-id}/projects/{project-id}/infra/segments/{segment-id}/ports/{port-id}
|
Get infra segment port by ID
Get detail information on an infra segment port by giving ID.
|
GET /policy/api/v1/infra/segments/{segment-id}/ports/{port-id}
GET /policy/api/v1/global-infra/segments/{segment-id}/ports/{port-id}
GET /policy/api/v1/orgs/{org-id}/projects/{project-id}/infra/segments/{segment-id}/ports/{port-id}
|
Patch an infra segment port
Create an infra 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.
|
PATCH /policy/api/v1/infra/segments/{segment-id}/ports/{port-id}
PATCH /policy/api/v1/global-infra/segments/{segment-id}/ports/{port-id}
PATCH /policy/api/v1/orgs/{org-id}/projects/{project-id}/infra/segments/{segment-id}/ports/{port-id}
|
Create or update an infra segment port
Create an infra segment port if it does not exist based on the IDs, or update existing port
information by replacing the port object already exists.
|
PUT /policy/api/v1/infra/segments/{segment-id}/ports/{port-id}
PUT /policy/api/v1/global-infra/segments/{segment-id}/ports/{port-id}
PUT /policy/api/v1/orgs/{org-id}/projects/{project-id}/infra/segments/{segment-id}/ports/{port-id}
|
List all effective profiles for infra segment port
List all effective profiles for this segment port on given enforcement point.
|
GET /policy/api/v1/infra/segments/{segment-id}/ports/{port-id}/effective-profiles
GET /policy/api/v1/global-infra/segments/{segment-id}/ports/{port-id}/effective-profiles
GET /policy/api/v1/orgs/{org-id}/projects/{project-id}/infra/segments/{segment-id}/ports/{port-id}/effective-profiles
|
Get infra segment port MAC table in CSV
Returns MAC table for a segment port
|
GET /policy/api/v1/infra/segments/{segment-id}/ports/{port-id}/mac-table?format=csv
GET /policy/api/v1/global-infra/segments/{segment-id}/ports/{port-id}/mac-table?format=csv
GET /policy/api/v1/orgs/{org-id}/projects/{project-id}/infra/segments/{segment-id}/ports/{port-id}/mac-table?format=csv
|
Get MAC table for infra segment port
Returns MAC table for a segment port
|
GET /policy/api/v1/infra/segments/{segment-id}/ports/{port-id}/mac-table
GET /policy/api/v1/global-infra/segments/{segment-id}/ports/{port-id}/mac-table
GET /policy/api/v1/orgs/{org-id}/projects/{project-id}/infra/segments/{segment-id}/ports/{port-id}/mac-table
|
List Port QoS Profile Binding Maps
API will list all Port QoS Profile Binding Maps in current port id.
|
GET /policy/api/v1/infra/segments/{segment-id}/ports/{port-id}/port-qos-profile-binding-maps
GET /policy/api/v1/global-infra/segments/{segment-id}/ports/{port-id}/port-qos-profile-binding-maps
GET /policy/api/v1/orgs/{org-id}/projects/{project-id}/infra/segments/{segment-id}/ports/{port-id}/port-qos-profile-binding-maps
|
Delete Port QoS Profile Binding Profile
API will delete Port QoS Profile Binding Profile.
|
DELETE /policy/api/v1/infra/segments/{segment-id}/ports/{port-id}/port-qos-profile-binding-maps/{port-qos-profile-binding-map-id}
DELETE /policy/api/v1/global-infra/segments/{segment-id}/ports/{port-id}/port-qos-profile-binding-maps/{port-qos-profile-binding-map-id}
DELETE /policy/api/v1/orgs/{org-id}/projects/{project-id}/infra/segments/{segment-id}/ports/{port-id}/port-qos-profile-binding-maps/{port-qos-profile-binding-map-id}
|
Get Port QoS Profile Binding Map
API will get Port QoS Profile Binding Map.
|
GET /policy/api/v1/infra/segments/{segment-id}/ports/{port-id}/port-qos-profile-binding-maps/{port-qos-profile-binding-map-id}
GET /policy/api/v1/global-infra/segments/{segment-id}/ports/{port-id}/port-qos-profile-binding-maps/{port-qos-profile-binding-map-id}
GET /policy/api/v1/orgs/{org-id}/projects/{project-id}/infra/segments/{segment-id}/ports/{port-id}/port-qos-profile-binding-maps/{port-qos-profile-binding-map-id}
|
Create Port QoS Profile Binding Map
API will create Port QoS Profile Binding Map. For objects with no binding maps, default profile is applied.
|
PATCH /policy/api/v1/infra/segments/{segment-id}/ports/{port-id}/port-qos-profile-binding-maps/{port-qos-profile-binding-map-id}
PATCH /policy/api/v1/global-infra/segments/{segment-id}/ports/{port-id}/port-qos-profile-binding-maps/{port-qos-profile-binding-map-id}
PATCH /policy/api/v1/orgs/{org-id}/projects/{project-id}/infra/segments/{segment-id}/ports/{port-id}/port-qos-profile-binding-maps/{port-qos-profile-binding-map-id}
|
Update Port QoS Profile Binding Map
API will update Port QoS Profile Binding Map. For objects with no binding maps, default profile is applied.
|
PUT /policy/api/v1/infra/segments/{segment-id}/ports/{port-id}/port-qos-profile-binding-maps/{port-qos-profile-binding-map-id}
PUT /policy/api/v1/global-infra/segments/{segment-id}/ports/{port-id}/port-qos-profile-binding-maps/{port-qos-profile-binding-map-id}
PUT /policy/api/v1/orgs/{org-id}/projects/{project-id}/infra/segments/{segment-id}/ports/{port-id}/port-qos-profile-binding-maps/{port-qos-profile-binding-map-id}
|
List infra segment port security profile binding maps
API will list all port security profile binding maps.
|
GET /policy/api/v1/infra/segments/{segment-id}/ports/{port-id}/port-security-profile-binding-maps
GET /policy/api/v1/global-infra/segments/{segment-id}/ports/{port-id}/port-security-profile-binding-maps
GET /policy/api/v1/orgs/{org-id}/projects/{project-id}/infra/segments/{segment-id}/ports/{port-id}/port-security-profile-binding-maps
|
Delete the infra segment port security profile binding map
API will delete the port security profile binding map.
|
DELETE /policy/api/v1/infra/segments/{segment-id}/ports/{port-id}/port-security-profile-binding-maps/{port-security-profile-binding-map-id}
DELETE /policy/api/v1/global-infra/segments/{segment-id}/ports/{port-id}/port-security-profile-binding-maps/{port-security-profile-binding-map-id}
DELETE /policy/api/v1/orgs/{org-id}/projects/{project-id}/infra/segments/{segment-id}/ports/{port-id}/port-security-profile-binding-maps/{port-security-profile-binding-map-id}
|
Get infra segment port security profile binding map
API will return details of the port security profile binding map. If the
security profile binding map does not exist, it will return 404.
|
GET /policy/api/v1/infra/segments/{segment-id}/ports/{port-id}/port-security-profile-binding-maps/{port-security-profile-binding-map-id}
GET /policy/api/v1/global-infra/segments/{segment-id}/ports/{port-id}/port-security-profile-binding-maps/{port-security-profile-binding-map-id}
GET /policy/api/v1/orgs/{org-id}/projects/{project-id}/infra/segments/{segment-id}/ports/{port-id}/port-security-profile-binding-maps/{port-security-profile-binding-map-id}
|
Patch infra segment port security profile binding map
Create a new port security profile binding map if the given security profile
binding map does not exist. Otherwise, patch the existing port security
profile binding map.
For objects with no binding maps, default profile is applied.
|
PATCH /policy/api/v1/infra/segments/{segment-id}/ports/{port-id}/port-security-profile-binding-maps/{port-security-profile-binding-map-id}
PATCH /policy/api/v1/global-infra/segments/{segment-id}/ports/{port-id}/port-security-profile-binding-maps/{port-security-profile-binding-map-id}
PATCH /policy/api/v1/orgs/{org-id}/projects/{project-id}/infra/segments/{segment-id}/ports/{port-id}/port-security-profile-binding-maps/{port-security-profile-binding-map-id}
|
Create or replace the infra segment port security profile binding map
API will create or replace the port security profile binding map.
For objects with no binding maps, default profile is applied.
|
PUT /policy/api/v1/infra/segments/{segment-id}/ports/{port-id}/port-security-profile-binding-maps/{port-security-profile-binding-map-id}
PUT /policy/api/v1/global-infra/segments/{segment-id}/ports/{port-id}/port-security-profile-binding-maps/{port-security-profile-binding-map-id}
PUT /policy/api/v1/orgs/{org-id}/projects/{project-id}/infra/segments/{segment-id}/ports/{port-id}/port-security-profile-binding-maps/{port-security-profile-binding-map-id}
|
Get infra segment port state
Returns infra segment port state on enforcement point
|
GET /policy/api/v1/infra/segments/{segment-id}/ports/{port-id}/state
GET /policy/api/v1/global-infra/segments/{segment-id}/ports/{port-id}/state
GET /policy/api/v1/orgs/{org-id}/projects/{project-id}/infra/segments/{segment-id}/ports/{port-id}/state
|
List Segment QoS Profile Binding Maps
API will list all Segment QoS Profile Binding Maps in current segment id.
|
GET /policy/api/v1/infra/segments/{segment-id}/segment-qos-profile-binding-maps
GET /policy/api/v1/global-infra/segments/{segment-id}/segment-qos-profile-binding-maps
GET /policy/api/v1/orgs/{org-id}/projects/{project-id}/infra/segments/{segment-id}/segment-qos-profile-binding-maps
|
Delete Segment QoS Profile Binding Profile
API will delete Segment QoS Profile Binding Profile.
|
DELETE /policy/api/v1/infra/segments/{segment-id}/segment-qos-profile-binding-maps/{segment-qos-profile-binding-map-id}
DELETE /policy/api/v1/orgs/{org-id}/projects/{project-id}/infra/segments/{segment-id}/segment-qos-profile-binding-maps/{segment-qos-profile-binding-map-id}
|
Get Segment QoS Profile Binding Map
API will get Segment QoS Profile Binding Map.
|
GET /policy/api/v1/infra/segments/{segment-id}/segment-qos-profile-binding-maps/{segment-qos-profile-binding-map-id}
GET /policy/api/v1/global-infra/segments/{segment-id}/segment-qos-profile-binding-maps/{segment-qos-profile-binding-map-id}
GET /policy/api/v1/orgs/{org-id}/projects/{project-id}/infra/segments/{segment-id}/segment-qos-profile-binding-maps/{segment-qos-profile-binding-map-id}
|
Create Segment QoS Profile Binding Map
API will create segment QoS profile binding map. For objects with no binding maps, default profile is applied.
|
PATCH /policy/api/v1/infra/segments/{segment-id}/segment-qos-profile-binding-maps/{segment-qos-profile-binding-map-id}
PATCH /policy/api/v1/orgs/{org-id}/projects/{project-id}/infra/segments/{segment-id}/segment-qos-profile-binding-maps/{segment-qos-profile-binding-map-id}
|
Update Segment QoS Profile Binding Map
API will update Segment QoS Profile Binding Map. For objects with no binding maps, default profile is applied.
|
PUT /policy/api/v1/infra/segments/{segment-id}/segment-qos-profile-binding-maps/{segment-qos-profile-binding-map-id}
PUT /policy/api/v1/orgs/{org-id}/projects/{project-id}/infra/segments/{segment-id}/segment-qos-profile-binding-maps/{segment-qos-profile-binding-map-id}
|
List infra segment security profile binding maps
API will list all segment security profile binding maps.
|
GET /policy/api/v1/infra/segments/{segment-id}/segment-security-profile-binding-maps
GET /policy/api/v1/global-infra/segments/{segment-id}/segment-security-profile-binding-maps
GET /policy/api/v1/orgs/{org-id}/projects/{project-id}/infra/segments/{segment-id}/segment-security-profile-binding-maps
|
Delete infra segment security profile binding map
API will delete segment security profile binding map.
|
DELETE /policy/api/v1/infra/segments/{segment-id}/segment-security-profile-binding-maps/{segment-security-profile-binding-map-id}
DELETE /policy/api/v1/orgs/{org-id}/projects/{project-id}/infra/segments/{segment-id}/segment-security-profile-binding-maps/{segment-security-profile-binding-map-id}
|
Get infra segment security profile binding map
API will return details of the segment security profile binding map. If the
binding map does not exist, it will return 404.
|
GET /policy/api/v1/infra/segments/{segment-id}/segment-security-profile-binding-maps/{segment-security-profile-binding-map-id}
GET /policy/api/v1/global-infra/segments/{segment-id}/segment-security-profile-binding-maps/{segment-security-profile-binding-map-id}
GET /policy/api/v1/orgs/{org-id}/projects/{project-id}/infra/segments/{segment-id}/segment-security-profile-binding-maps/{segment-security-profile-binding-map-id}
|
Patch infra 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.
|
PATCH /policy/api/v1/infra/segments/{segment-id}/segment-security-profile-binding-maps/{segment-security-profile-binding-map-id}
PATCH /policy/api/v1/orgs/{org-id}/projects/{project-id}/infra/segments/{segment-id}/segment-security-profile-binding-maps/{segment-security-profile-binding-map-id}
|
Create or replace infra 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.
|
PUT /policy/api/v1/infra/segments/{segment-id}/segment-security-profile-binding-maps/{segment-security-profile-binding-map-id}
PUT /policy/api/v1/orgs/{org-id}/projects/{project-id}/infra/segments/{segment-id}/segment-security-profile-binding-maps/{segment-security-profile-binding-map-id}
|
Get infra segment TEP table
Returns TEP table for a segment
|
GET /policy/api/v1/infra/segments/{segment-id}/tep-table
GET /policy/api/v1/global-infra/segments/{segment-id}/tep-table
GET /policy/api/v1/orgs/{org-id}/projects/{project-id}/infra/segments/{segment-id}/tep-table
|
Get tier-1 segment TEP table in CSV
Returns TEP table for a segment in CSV
|
GET /policy/api/v1/infra/segments/{segment-id}/tep-table?format=csv
GET /policy/api/v1/global-infra/segments/{segment-id}/tep-table?format=csv
GET /policy/api/v1/orgs/{org-id}/projects/{project-id}/infra/segments/{segment-id}/tep-table?format=csv
|
Get infra segment port statistics information
Get infra segment port statistics information.
|
GET /policy/api/v1/infra/segments/{segments-id}/ports/{port-id}/statistics
GET /policy/api/v1/global-infra/segments/{segments-id}/ports/{port-id}/statistics
GET /policy/api/v1/orgs/{org-id}/projects/{project-id}/infra/segments/{segments-id}/ports/{port-id}/statistics
|
Get infra segment port status information
Get infra segment port status information.
|
GET /policy/api/v1/infra/segments/{segments-id}/ports/{port-id}/status
GET /policy/api/v1/global-infra/segments/{segments-id}/ports/{port-id}/status
GET /policy/api/v1/orgs/{org-id}/projects/{project-id}/infra/segments/{segments-id}/ports/{port-id}/status
|
Get infra segment state information
Get infra segment state information.
|
GET /policy/api/v1/infra/segments/{segments-id}/state
GET /policy/api/v1/global-infra/segments/{segments-id}/state
GET /policy/api/v1/orgs/{org-id}/projects/{project-id}/infra/segments/{segments-id}/state
|
Get infra segment statistics information
Get infra segment statistics information.
|
GET /policy/api/v1/infra/segments/{segments-id}/statistics
GET /policy/api/v1/global-infra/segments/{segments-id}/statistics
GET /policy/api/v1/orgs/{org-id}/projects/{project-id}/infra/segments/{segments-id}/statistics
|
List Service Segments
Paginated list of all Service Segments
|
GET /policy/api/v1/infra/segments/service-segments
|
Delete Service Segment
Delete Service Segment with given ID
|
DELETE /policy/api/v1/infra/segments/service-segments/{service-segment-id}
|
Read Service Segment
Read a Service Segment with the given id
|
GET /policy/api/v1/infra/segments/service-segments/{service-segment-id}
|
Create a service segment
A service segment with the service-segment-id is created.
Modification of service segment is not supported.
|
PATCH /policy/api/v1/infra/segments/service-segments/{service-segment-id}
|
Create service segment
A service segment with the service-segment-id is created.
Modification of service segment is not supported.
|
PUT /policy/api/v1/infra/segments/service-segments/{service-segment-id}
|
Get infra segments by configuration state
Returns all infra segments with configuration state on the enforcement
point specified in the request
|
GET /policy/api/v1/infra/segments/state
GET /policy/api/v1/global-infra/segments/state
GET /policy/api/v1/orgs/{org-id}/projects/{project-id}/infra/segments/state
|
List L2 Bridge Endpoint Profiles
List all L2 bridge profiles
|
GET /policy/api/v1/infra/sites/{site-id}/enforcement-points/{enforcement-point-id}/edge-bridge-profiles
GET /policy/api/v1/global-infra/sites/{site-id}/enforcement-points/{enforcement-point-id}/edge-bridge-profiles
|
Delete L2 Bridge Endpoint Profile
API will delete L2 bridge profile with ID profile-id
|
DELETE /policy/api/v1/infra/sites/{site-id}/enforcement-points/{enforcement-point-id}/edge-bridge-profiles/{profile-id}
DELETE /policy/api/v1/global-infra/sites/{site-id}/enforcement-points/{enforcement-point-id}/edge-bridge-profiles/{profile-id}
|
Get L2 Bridge Endpoint Profile
Read L2 bridge profile with ID profile-id
|
GET /policy/api/v1/infra/sites/{site-id}/enforcement-points/{enforcement-point-id}/edge-bridge-profiles/{profile-id}
GET /policy/api/v1/global-infra/sites/{site-id}/enforcement-points/{enforcement-point-id}/edge-bridge-profiles/{profile-id}
|
Create or update L2 Bridge Endpoint Profile
API will create or update L2 bridge profile with ID profile-id.
L2 Bridge profile is only allowed under an enforcement-point with path
/infra/sites/default/enforcement-points/default.
|
PATCH /policy/api/v1/infra/sites/{site-id}/enforcement-points/{enforcement-point-id}/edge-bridge-profiles/{profile-id}
PATCH /policy/api/v1/global-infra/sites/{site-id}/enforcement-points/{enforcement-point-id}/edge-bridge-profiles/{profile-id}
|
Create or update L2 Bridge Endpoint Profile
API will create or update L2 bridge profile with ID profile-id.
L2 Bridge profile is only allowed under an enforcement-point with path
/infra/sites/default/enforcement-points/default.
|
PUT /policy/api/v1/infra/sites/{site-id}/enforcement-points/{enforcement-point-id}/edge-bridge-profiles/{profile-id}
PUT /policy/api/v1/global-infra/sites/{site-id}/enforcement-points/{enforcement-point-id}/edge-bridge-profiles/{profile-id}
|
List Transport Zones under an Enforcement Point
Paginated list of all Transport Zones under an Enforcement Point
|
GET /policy/api/v1/infra/sites/{site-id}/enforcement-points/{enforcementpoint-id}/transport-zones
GET /policy/api/v1/global-infra/sites/{site-id}/enforcement-points/{enforcementpoint-id}/transport-zones
|
Delete a Transport Zone under an Enforcement Point
Delete a Transport Zone under an Enforcement Point.
|
DELETE /policy/api/v1/infra/sites/{site-id}/enforcement-points/{enforcementpoint-id}/transport-zones/{transport-zone-id}
|
Read a Transport Zone under an Enforcement Point
Read a Transport Zone under an Enforcement Point
|
GET /policy/api/v1/infra/sites/{site-id}/enforcement-points/{enforcementpoint-id}/transport-zones/{transport-zone-id}
GET /policy/api/v1/global-infra/sites/{site-id}/enforcement-points/{enforcementpoint-id}/transport-zones/{transport-zone-id}
|
Patch a Transport Zone under an Enforcement Point
Patch a Transport Zone under an Enforcement Point
|
PATCH /policy/api/v1/infra/sites/{site-id}/enforcement-points/{enforcementpoint-id}/transport-zones/{transport-zone-id}
|
PUT a Transport Zone under an Enforcement Point
PUT a Transport Zone under an Enforcement Point
|
PUT /policy/api/v1/infra/sites/{site-id}/enforcement-points/{enforcementpoint-id}/transport-zones/{transport-zone-id}
|
List SpoofGuard profiles
API will list all SpoofGuard profiles.
|
GET /policy/api/v1/infra/spoofguard-profiles
GET /policy/api/v1/global-infra/spoofguard-profiles
GET /policy/api/v1/orgs/{org-id}/projects/{project-id}/infra/spoofguard-profiles
|
Delete SpoofGuard profile
API will delete SpoofGuard profile with the given id.
|
DELETE /policy/api/v1/infra/spoofguard-profiles/{spoofguard-profile-id}
DELETE /policy/api/v1/global-infra/spoofguard-profiles/{spoofguard-profile-id}
DELETE /policy/api/v1/orgs/{org-id}/projects/{project-id}/infra/spoofguard-profiles/{spoofguard-profile-id}
|
Get SpoofGuard profile
API will return details of the SpoofGuard profile with given id. If the
profile does not exist, it will return 404.
|
GET /policy/api/v1/infra/spoofguard-profiles/{spoofguard-profile-id}
GET /policy/api/v1/global-infra/spoofguard-profiles/{spoofguard-profile-id}
GET /policy/api/v1/orgs/{org-id}/projects/{project-id}/infra/spoofguard-profiles/{spoofguard-profile-id}
|
Patch SpoofGuard profile
Create a new SpoofGuard profile if the SpoofGuard profile with the given id
does not exist. Otherwise, patch with the existing SpoofGuard profile.
|
PATCH /policy/api/v1/infra/spoofguard-profiles/{spoofguard-profile-id}
PATCH /policy/api/v1/global-infra/spoofguard-profiles/{spoofguard-profile-id}
PATCH /policy/api/v1/orgs/{org-id}/projects/{project-id}/infra/spoofguard-profiles/{spoofguard-profile-id}
|
Create or replace SpoofGuard profile
API will create or replace SpoofGuard profile.
|
PUT /policy/api/v1/infra/spoofguard-profiles/{spoofguard-profile-id}
PUT /policy/api/v1/global-infra/spoofguard-profiles/{spoofguard-profile-id}
PUT /policy/api/v1/orgs/{org-id}/projects/{project-id}/infra/spoofguard-profiles/{spoofguard-profile-id}
|
List Tier-0s
Paginated list of all Tier-0s
|
GET /policy/api/v1/infra/tier-0s
GET /policy/api/v1/global-infra/tier-0s
|
Recover of Tier0 and linked tier1 gateway(s).
API to recover specified Tier0 gateway and linked tier1 gateway from
primary site path to new primary site path. This will update intent of
affected Tier-0 and Tier-1 gateway.
|
POST /policy/api/v1/infra/tier-0s?action=site_failover
|
Delete Tier-0
Delete Tier-0
|
DELETE /policy/api/v1/infra/tier-0s/{tier-0-id}
|
Read Tier-0
Read Tier-0
|
GET /policy/api/v1/infra/tier-0s/{tier-0-id}
GET /policy/api/v1/global-infra/tier-0s/{tier-0-id}
|
Create or update a Tier-0
If a Tier-0 with the tier-0-id is not already present, create a new
Tier-0. If it already exists, update the Tier-0 for specified attributes.
|
PATCH /policy/api/v1/infra/tier-0s/{tier-0-id}
|
Reprocess Tier0 gateway configuration and publish updates to NSX controller
Reprocess Tier0 gateway configuration and configuration of related entities like Tier0 interfaces
and static routes, etc. Any missing Updates are published to NSX controller.
|
POST /policy/api/v1/infra/tier-0s/{tier-0-id}?action=reprocess
|
Create or update a Tier-0
If a Tier-0 with the tier-0-id is not already present, create a new
Tier-0. If it already exists, replace the Tier-0 instance with the new object.
|
PUT /policy/api/v1/infra/tier-0s/{tier-0-id}
|
Get Tier-0 Address Resolution Protocol Proxies
Returns ARP proxy table for a tier-0
|
GET /policy/api/v1/infra/tier-0s/{tier-0-id}/arp-proxies
GET /policy/api/v1/global-infra/tier-0s/{tier-0-id}/arp-proxies
|
Get Tier-0 Address Resolution Protocol Proxies in CSV format
Returns ARP proxy table for a tier-0 in CSV format
|
GET /policy/api/v1/infra/tier-0s/{tier-0-id}/arp-proxies?format=csv
GET /policy/api/v1/global-infra/tier-0s/{tier-0-id}/arp-proxies?format=csv
|
List BGP community lists
Paginated list of all community lists under a tier-0
|
GET /policy/api/v1/infra/tier-0s/{tier-0-id}/community-lists
GET /policy/api/v1/global-infra/tier-0s/{tier-0-id}/community-lists
|
Delete a BGP community list
Delete a BGP community list
|
DELETE /policy/api/v1/infra/tier-0s/{tier-0-id}/community-lists/{community-list-id}
|
Read a BGP community list
Read a BGP community list
|
GET /policy/api/v1/infra/tier-0s/{tier-0-id}/community-lists/{community-list-id}
GET /policy/api/v1/global-infra/tier-0s/{tier-0-id}/community-lists/{community-list-id}
|
Create or update a BGP community list
If a community list with the community-list-id is not already present,
create a new community list. If it already exists, update the community
list for specified attributes.
|
PATCH /policy/api/v1/infra/tier-0s/{tier-0-id}/community-lists/{community-list-id}
|
Create or update a BGP community list
If a community list with the community-list-id is not already present,
create a new community list. If it already exists, replace the community
list instance with the new object.
|
PUT /policy/api/v1/infra/tier-0s/{tier-0-id}/community-lists/{community-list-id}
|
Delete DNS configuration for tier-0 instance
Delete DNS configuration for tier-0 instance
|
DELETE /policy/api/v1/infra/tier-0s/{tier-0-id}/dns-forwarder
|
Read the DNS Forwarder for the given tier-0 instance
Read the DNS Forwarder for the given tier-0 instance
|
GET /policy/api/v1/infra/tier-0s/{tier-0-id}/dns-forwarder
GET /policy/api/v1/global-infra/tier-0s/{tier-0-id}/dns-forwarder
|
Update the DNS Forwarder
Update the DNS Forwarder
|
PATCH /policy/api/v1/infra/tier-0s/{tier-0-id}/dns-forwarder
|
Perform the specified DNS forwarder action
Perform the specified action for Tier0 DNS forwarder on specified enforcement point.
|
POST /policy/api/v1/infra/tier-0s/{tier-0-id}/dns-forwarder
POST /policy/api/v1/global-infra/tier-0s/{tier-0-id}/dns-forwarder
|
Update the DNS Forwarder
Update the DNS Forwarder
|
PUT /policy/api/v1/infra/tier-0s/{tier-0-id}/dns-forwarder
|
Resolve a given address via the dns forwarder at Tier0
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.
|
GET /policy/api/v1/infra/tier-0s/{tier-0-id}/dns-forwarder/nslookup
GET /policy/api/v1/global-infra/tier-0s/{tier-0-id}/dns-forwarder/nslookup
|
Get tier-0 DNS forwarder statistics
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.
|
GET /policy/api/v1/infra/tier-0s/{tier-0-id}/dns-forwarder/statistics
GET /policy/api/v1/global-infra/tier-0s/{tier-0-id}/dns-forwarder/statistics
|
Get current status of tier-0 DNS forwarder
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.
|
GET /policy/api/v1/infra/tier-0s/{tier-0-id}/dns-forwarder/status
GET /policy/api/v1/global-infra/tier-0s/{tier-0-id}/dns-forwarder/status
|
Read Evpn Configuration
Read Evpn Configuration.
|
GET /policy/api/v1/infra/tier-0s/{tier-0-id}/evpn
|
Create or Update evpn configuration
Create a evpn configuration if it is not already present,
otherwise update the evpn configuration.
|
PATCH /policy/api/v1/infra/tier-0s/{tier-0-id}/evpn
|
Create or Update evpn configuration
Create or update evpn configuration.
|
PUT /policy/api/v1/infra/tier-0s/{tier-0-id}/evpn
|
Get forwarding table from tier-0
Get forwarding table from tier-0
|
GET /policy/api/v1/infra/tier-0s/{tier-0-id}/forwarding-table
GET /policy/api/v1/global-infra/tier-0s/{tier-0-id}/forwarding-table
|
Get forwarding table from tier-0 in CSV format
Get forwarding table from tier-0 gateway in CSV format.
|
GET /policy/api/v1/infra/tier-0s/{tier-0-id}/forwarding-table?format=csv
GET /policy/api/v1/global-infra/tier-0s/{tier-0-id}/forwarding-table?format=csv
|
List inter-vrf routing configurations
List all inter-vrf routing configurations.
|
GET /policy/api/v1/infra/tier-0s/{tier-0-id}/inter-vrf-routing
|
Delete inter-vrf routing config
Delete inter-vrf routing config.
|
DELETE /policy/api/v1/infra/tier-0s/{tier-0-id}/inter-vrf-routing/{inter-vrf-routing-id}
|
Read inter-vrf routing config
Read inter-vrf routing config.
|
GET /policy/api/v1/infra/tier-0s/{tier-0-id}/inter-vrf-routing/{inter-vrf-routing-id}
|
Create or update inter-vrf routing config
Create or update inter-vrf routing config.
|
PATCH /policy/api/v1/infra/tier-0s/{tier-0-id}/inter-vrf-routing/{inter-vrf-routing-id}
|
Create or update inter-vrf routing config
Create or update inter-vrf routing config.
|
PUT /policy/api/v1/infra/tier-0s/{tier-0-id}/inter-vrf-routing/{inter-vrf-routing-id}
|
List advertised networks
Returns information about all networks which advertised to TIER0 LR.
|
GET /policy/api/v1/infra/tier-0s/{tier-0-id}/inter-vrf-routing/{inter-vrf-routing-id}/advertised-networks
|
List advertised networks in CSV format
List advertised networks in CSV format.
|
GET /policy/api/v1/infra/tier-0s/{tier-0-id}/inter-vrf-routing/{inter-vrf-routing-id}/advertised-networks?format=csv
|
Get IPSec VPN service list result
Get paginated list of all IPSec VPN services
for given Tier-0.
|
GET /policy/api/v1/infra/tier-0s/{tier-0-id}/ipsec-vpn-services
|
Delete IPSec VPN service
Delete IPSec VPN service for under Tier-0.
|
DELETE /policy/api/v1/infra/tier-0s/{tier-0-id}/ipsec-vpn-services/{service-id}
|
Get IPSec VPN service
Get IPSec VPN service under Tier-0.
|
GET /policy/api/v1/infra/tier-0s/{tier-0-id}/ipsec-vpn-services/{service-id}
|
Create or patch IPSec VPN service
Create or patch IPSec VPN service under Tier-0.
|
PATCH /policy/api/v1/infra/tier-0s/{tier-0-id}/ipsec-vpn-services/{service-id}
|
Create or fully replace IPSec VPN service
Create or fully replace IPSec VPN service under given Tier-0.
Revision is optional for creation and required for update.
|
PUT /policy/api/v1/infra/tier-0s/{tier-0-id}/ipsec-vpn-services/{service-id}
|
Get IPSec VPN local endpoint list result
Get paginated list of all IPSec VPN local endpoints
for a given ipsec vpn service under Tier-0.
|
GET /policy/api/v1/infra/tier-0s/{tier-0-id}/ipsec-vpn-services/{service-id}/local-endpoints
|
Delete IPSec VPN local endpoint
Delete IPSec VPN local endpoint for a given ipsec vpn
service under Tier-0.
|
DELETE /policy/api/v1/infra/tier-0s/{tier-0-id}/ipsec-vpn-services/{service-id}/local-endpoints/{local-endpoint-id}
|
Get IPSec VPN local endpoint
Get IPSec VPN local endpoint for a given ipsec vpn
service under Tier-0.
|
GET /policy/api/v1/infra/tier-0s/{tier-0-id}/ipsec-vpn-services/{service-id}/local-endpoints/{local-endpoint-id}
|
Create or patch a custom IPSec VPN local endpoint
Create or patch a custom IPSec VPN local endpoint
under Tier-0.
|
PATCH /policy/api/v1/infra/tier-0s/{tier-0-id}/ipsec-vpn-services/{service-id}/local-endpoints/{local-endpoint-id}
|
Create or fully replace IPSec VPN local endpoint
Create or fully replace IPSec VPN local endpoint
for a given ipsec vpn service under Tier-0.
Revision is optional for creation and required for update.
|
PUT /policy/api/v1/infra/tier-0s/{tier-0-id}/ipsec-vpn-services/{service-id}/local-endpoints/{local-endpoint-id}
|
Get IPSec VPN sessions list result
Get paginated list of all IPSec VPN sessions
for a given ipsec vpn service under Tier-0.
|
GET /policy/api/v1/infra/tier-0s/{tier-0-id}/ipsec-vpn-services/{service-id}/sessions
|
Delete IPSec VPN session
Delete IPSec VPN session for a given ipsec vpn
service under Tier-0.
|
DELETE /policy/api/v1/infra/tier-0s/{tier-0-id}/ipsec-vpn-services/{service-id}/sessions/{session-id}
|
Get IPSec VPN Session
Get IPSec VPN session with senstive data for
a given ipsec vpn service under Tier-0.
|
GET /policy/api/v1/infra/tier-0s/{tier-0-id}/ipsec-vpn-services/{service-id}/sessions/{session-id}?action=show_sensitive_data
|
Get IPSec VPN Session
Get IPSec VPN session without sensitive data
for a given ipsec vpn service under Tier-0.
|
GET /policy/api/v1/infra/tier-0s/{tier-0-id}/ipsec-vpn-services/{service-id}/sessions/{session-id}
|
Create or patch an IPSec VPN session
Create or patch an IPSec VPN session for
a given ipsec vpn service under Tier-0.
|
PATCH /policy/api/v1/infra/tier-0s/{tier-0-id}/ipsec-vpn-services/{service-id}/sessions/{session-id}
|
Create or fully replace IPSec VPN session
Create or fully replace IPSec VPN session for a given
ipsec vpn service under Tier-0.
Revision is optional for creation and required for update.
|
PUT /policy/api/v1/infra/tier-0s/{tier-0-id}/ipsec-vpn-services/{service-id}/sessions/{session-id}
|
Get IPSec VPN session detailed status under Tier-0
- no enforcement point path specified: detailed status is evaluated on each enforcement point.
- an enforcement point path is specified: detailed status is evaluated only on the given
enforcement point.
- source=realtime: detailed status is fetched realtime from the enforcement point.
- source=cached: cached detailed status from enforcement point is returned.
|
GET /policy/api/v1/infra/tier-0s/{tier-0-id}/ipsec-vpn-services/{service-id}/sessions/{session-id}/detailed-status
(Deprecated)
|
Get IPSec VPN configuration for the peer site
Download IPSec VPN configuration for the peer site. Peer config also
contains PSK; be careful when sharing or storing it.
|
GET /policy/api/v1/infra/tier-0s/{tier-0-id}/ipsec-vpn-services/{service-id}/sessions/{session-id}/peer-config
|
Get IPSec VPN session statistics under Tier-0
- no enforcement point path specified: statistics are evaluated on each enforcement point.
- an enforcement point path is specified: statistics are evaluated only on the given
enforcement point.
- source=realtime: statistics are fetched realtime from the enforcement point.
- source=cached: cached statistics from enforcement point are returned.
Please note that cache synchronization is based on triggering this API with
source=realtime or empty source and not polling based.
|
GET /policy/api/v1/infra/tier-0s/{tier-0-id}/ipsec-vpn-services/{service-id}/sessions/{session-id}/statistics
|
Reset the statistics of the given VPN session
Resets the statistics of the given VPN session.
Since source of data is enforcement point, data is
reset there.
|
POST /policy/api/v1/infra/tier-0s/{tier-0-id}/ipsec-vpn-services/{service-id}/sessions/{session-id}/statistics
POST /policy/api/v1/global-infra/tier-0s/{tier-0-id}/ipsec-vpn-services/{service-id}/sessions/{session-id}/statistics
|
Get IPSec VPN Session Summary
Summarized view of all tier-0 IPSec VPN sessions for a specified service.
|
GET /policy/api/v1/infra/tier-0s/{tier-0-id}/ipsec-vpn-services/{service-id}/summary
GET /policy/api/v1/orgs/{org-id}/projects/{project-id}/infra/tier-0s/{tier-0-id}/ipsec-vpn-services/{service-id}/summary
|
Get L2VPN service list result under Tier-0
Get paginated list of all L2VPN services under Tier-0.
|
GET /policy/api/v1/infra/tier-0s/{tier-0-id}/l2vpn-services
|
Delete L2VPN service under Tier-0
Delete L2VPN service for given Tier-0.
|
DELETE /policy/api/v1/infra/tier-0s/{tier-0-id}/l2vpn-services/{service-id}
|
Get L2VPN service under Tier-0
Get L2VPN service for given Tier-0
|
GET /policy/api/v1/infra/tier-0s/{tier-0-id}/l2vpn-services/{service-id}
|
Create or patch L2VPN service under Tier-0
Create or patch L2VPN service for given Tier-0
|
PATCH /policy/api/v1/infra/tier-0s/{tier-0-id}/l2vpn-services/{service-id}
|
Create or fully replace L2VPN service under Tier-0
Create or fully replace L2VPN service for given Tier-0. Revision is optional for creation and required for update.
|
PUT /policy/api/v1/infra/tier-0s/{tier-0-id}/l2vpn-services/{service-id}
|
Get L2VPN sessions list result under Tier-0
Get paginated list of all L2VPN sessions under Tier-0.
|
GET /policy/api/v1/infra/tier-0s/{tier-0-id}/l2vpn-services/{service-id}/sessions
|
Delete L2VPN session under Tier-0
Delete L2VPN session under Tier-0. When L2VPN Service is in CLIENT Mode, the L2VPN Session is deleted along with its transpot tunnels and related resources.
|
DELETE /policy/api/v1/infra/tier-0s/{tier-0-id}/l2vpn-services/{service-id}/sessions/{session-id}
|
Get L2VPN Session under Tier-0
Get L2VPN session under Tier-0.
|
GET /policy/api/v1/infra/tier-0s/{tier-0-id}/l2vpn-services/{service-id}/sessions/{session-id}
|
Create or patch an L2VPN session under Tier-0
Create or patch an L2VPN session under Tier-0. API supported
only when L2VPN Service is in Server Mode.
|
PATCH /policy/api/v1/infra/tier-0s/{tier-0-id}/l2vpn-services/{service-id}/sessions/{session-id}
|
Create or patch an L2VPN session under Tier-0 from Peer Codes
Create or patch an L2VPN session under Tier-0 from Peer Codes.
In addition to the L2VPN Session, the IPSec VPN Session, along
with the IKE, Tunnel, and DPD Profiles are created and owned by
the system. IPSec VPN Service and Local Endpoint are created only
when required, i.e., an IPSec VPN Service does not already exist,
or an IPSec VPN Local Endpoint with same local address does not
already exist.
Updating the L2VPN Session can be performed only through this API
by specifying new peer codes. Use of specific APIs to update the
L2VPN Session and the different resources associated with it is
not allowed, except for IPSec VPN Service and Local Endpoint,
resources that are not system owned.
API supported only when L2VPN Service is in Client Mode.
|
POST /policy/api/v1/infra/tier-0s/{tier-0-id}/l2vpn-services/{service-id}/sessions/{session-id}?action=create_with_peer_code
|
Create or fully replace L2VPN session under Tier-0
Create or fully replace L2VPN session under Tier-0. API supported
only when L2VPN Service is in Server Mode.
Revision is optional for creation and required for update.
|
PUT /policy/api/v1/infra/tier-0s/{tier-0-id}/l2vpn-services/{service-id}/sessions/{session-id}
|
Get L2VPN session detailed status under Tier-0
- no enforcement point path specified: detailed tatus is evaluated on each enforcement point.
- an enforcement point path is specified: detailed status is evaluated only on the given
enforcement point.
- source=realtime: detailed tatus is fetched realtime from the enforcement point.
- source=cached: cached detailed status is returned.
|
GET /policy/api/v1/infra/tier-0s/{tier-0-id}/l2vpn-services/{service-id}/sessions/{session-id}/detailed-status
|
Get Tier-0 L2VPN session configuration for the peer site
Get peer config for the Tier-0 L2VPN session to configure the remote
side of the tunnel.
- no enforcement point path specified: L2VPN Session Peer Codes
will be evaluated on each enforcement point.
- enforcement point paths specified: L2VPN Session Peer Codes
are evaluated only on the given enforcement points.
API supported only when L2VPN Service is in Server Mode.
|
GET /policy/api/v1/infra/tier-0s/{tier-0-id}/l2vpn-services/{service-id}/sessions/{session-id}/peer-config
|
Get L2Vpn session remote mac for logical switch
Returns L2Vpn session remote macs for a logical switch.
Data is fetched from enforcement point.
This API is deprecated. Please use GET /infra/tier-0s/<tier-0-id>/ipsec-vpn-services/<service-id>/
sessions/<session-id>/detailed-status instead.
|
GET /policy/api/v1/infra/tier-0s/{tier-0-id}/l2vpn-services/{service-id}/sessions/{session-id}/remote-mac
|
Get L2VPN session statistics under Tier-0
- no enforcement point path specified: statistics are evaluated on each enforcement point.
- an enforcement point path is specified: statistics are evaluated only on the given
enforcement point.
- source=realtime: statistics are fetched realtime from the enforcement point.
- source=cached: cached statistics from the enforcement point are returned.
|
GET /policy/api/v1/infra/tier-0s/{tier-0-id}/l2vpn-services/{service-id}/sessions/{session-id}/statistics
|
List Tier-0 locale-services
Paginated list of all Tier-0 locale-services
|
GET /policy/api/v1/infra/tier-0s/{tier-0-id}/locale-services
GET /policy/api/v1/global-infra/tier-0s/{tier-0-id}/locale-services
|
Get Tier-0 Address Resolution Protocol Proxies
Returns ARP proxy table for a tier-0
|
GET /policy/api/v1/infra/tier-0s/{tier-0-id}/locale-services/{locale-service-id}/arp-proxies
(Deprecated)
GET /policy/api/v1/global-infra/tier-0s/{tier-0-id}/locale-services/{locale-service-id}/arp-proxies
(Deprecated)
|
Delete overridden BGP routing config
Deletes the specified overridden BgpRoutingConfig. If the BgpRoutingConfig
is not overridden, it won't get deleted.
|
DELETE /policy/api/v1/infra/tier-0s/{tier-0-id}/locale-services/{locale-service-id}/bgp
DELETE /policy/api/v1/global-infra/tier-0s/{tier-0-id}/locale-services/{locale-service-id}/bgp
|
Read BGP routing config
Read BGP routing config
|
GET /policy/api/v1/infra/tier-0s/{tier-0-id}/locale-services/{locale-service-id}/bgp
GET /policy/api/v1/global-infra/tier-0s/{tier-0-id}/locale-services/{locale-service-id}/bgp
|
Create or update BGP routing config
If an BGP routing config not present, create BGP routing config.
If it already exists, update the routing config.
|
PATCH /policy/api/v1/infra/tier-0s/{tier-0-id}/locale-services/{locale-service-id}/bgp
PATCH /policy/api/v1/global-infra/tier-0s/{tier-0-id}/locale-services/{locale-service-id}/bgp
|
Create or update a BGP routing config
If BGP routing config is not already present, create BGP routing config.
If it already exists, replace the BGP routing config with this object.
|
PUT /policy/api/v1/infra/tier-0s/{tier-0-id}/locale-services/{locale-service-id}/bgp
PUT /policy/api/v1/global-infra/tier-0s/{tier-0-id}/locale-services/{locale-service-id}/bgp
|
List BGP neighbor configurations
Paginated list of all BGP neighbor configurations
|
GET /policy/api/v1/infra/tier-0s/{tier-0-id}/locale-services/{locale-service-id}/bgp/neighbors
GET /policy/api/v1/global-infra/tier-0s/{tier-0-id}/locale-services/{locale-service-id}/bgp/neighbors
|
Delete BGP neighbor config
Delete BGP neighbor config
|
DELETE /policy/api/v1/infra/tier-0s/{tier-0-id}/locale-services/{locale-service-id}/bgp/neighbors/{neighbor-id}
DELETE /policy/api/v1/global-infra/tier-0s/{tier-0-id}/locale-services/{locale-service-id}/bgp/neighbors/{neighbor-id}
|
Read BGP neighbor config
Read BGP neighbor config
|
GET /policy/api/v1/infra/tier-0s/{tier-0-id}/locale-services/{locale-service-id}/bgp/neighbors/{neighbor-id}
GET /policy/api/v1/global-infra/tier-0s/{tier-0-id}/locale-services/{locale-service-id}/bgp/neighbors/{neighbor-id}
|
Create or update a BGP neighbor config
If BGP neighbor config with the neighbor-id is not already present, create a new
neighbor config. If it already exists, replace the BGP neighbor config with this object.
|
PATCH /policy/api/v1/infra/tier-0s/{tier-0-id}/locale-services/{locale-service-id}/bgp/neighbors/{neighbor-id}
PATCH /policy/api/v1/global-infra/tier-0s/{tier-0-id}/locale-services/{locale-service-id}/bgp/neighbors/{neighbor-id}
|
Create or update a BGP neighbor config
If BGP neighbor config with the neighbor-id is not already present, create a new
neighbor config. If it already exists, replace the BGP neighbor config with this object.
|
PUT /policy/api/v1/infra/tier-0s/{tier-0-id}/locale-services/{locale-service-id}/bgp/neighbors/{neighbor-id}
PUT /policy/api/v1/global-infra/tier-0s/{tier-0-id}/locale-services/{locale-service-id}/bgp/neighbors/{neighbor-id}
|
Get BGP neighbor advertised routes
Returns routes advertised by BGP neighbor from all edge transport nodes on which
this neighbor is currently enabled.
The query parameter "source=cached" is not supported.
|
GET /policy/api/v1/infra/tier-0s/{tier-0-id}/locale-services/{locale-service-id}/bgp/neighbors/{neighbor-id}/advertised-routes
GET /policy/api/v1/global-infra/tier-0s/{tier-0-id}/locale-services/{locale-service-id}/bgp/neighbors/{neighbor-id}/advertised-routes
|
Get BGP neighbor advertised routes in CSV format
Returns routes advertised by BGP neighbor from all edge transport nodes on which
this neighbor is currently enabled in CSV format. Routes from all enforcement points are returned.
|
GET /policy/api/v1/infra/tier-0s/{tier-0-id}/locale-services/{locale-service-id}/bgp/neighbors/{neighbor-id}/advertised-routes?format=csv
GET /policy/api/v1/global-infra/tier-0s/{tier-0-id}/locale-services/{locale-service-id}/bgp/neighbors/{neighbor-id}/advertised-routes?format=csv
|
Get routes learned by BGP neighbor in CSV format
Returns routes learned by BGP neighbor from all edge nodes on which
this neighbor is currently enabled. Routes from all enforcement points are returned.
|
GET /policy/api/v1/infra/tier-0s/{tier-0-id}/locale-services/{locale-service-id}/bgp/neighbors/{neighbor-id}/routes?format=csv
GET /policy/api/v1/global-infra/tier-0s/{tier-0-id}/locale-services/{locale-service-id}/bgp/neighbors/{neighbor-id}/routes?format=csv
|
Get routes learned by BGP neighbor
Returns routes learned by BGP neighbor from all edge nodes on which
this neighbor is currently enabled.
|
GET /policy/api/v1/infra/tier-0s/{tier-0-id}/locale-services/{locale-service-id}/bgp/neighbors/{neighbor-id}/routes
GET /policy/api/v1/global-infra/tier-0s/{tier-0-id}/locale-services/{locale-service-id}/bgp/neighbors/{neighbor-id}/routes
|
Get BGP neighbor status for the Tier0
Returns the status of all the BGP neighbors for the given Tier0.
To get BGP neighbor status for a particular enforcement point,
parameter "enforcement_point_path=<enforcement_point_path>" needs to be specified.
If an enforcement_point is unspecified, then bgp neighbor status for all enforcement points is fetched.
To get BGP neighbors status for the logical router from particular edge node,
parameter "edge_path=<edge_path>" needs to be specified.
If an edge_path is unspecified, then bgp neighbor status for all edges is fetched.
|
GET /policy/api/v1/infra/tier-0s/{tier-0-id}/locale-services/{locale-service-id}/bgp/neighbors/status
GET /policy/api/v1/global-infra/tier-0s/{tier-0-id}/locale-services/{locale-service-id}/bgp/neighbors/status
|
List Tier-0 Interface groups
Paginated list of all Tier-0 Interface groups under locale service.
|
GET /policy/api/v1/infra/tier-0s/{tier-0-id}/locale-services/{locale-service-id}/interface-groups
|
Get tier-0 interface group statistics information
Get tier-0 interface group statistics information.
|
GET /policy/api/v1/infra/tier-0s/{tier-0-id}/locale-services/{locale-service-id}/interface-groups/{interface-group-id}/statistics
GET /policy/api/v1/global-infra/tier-0s/{tier-0-id}/locale-services/{locale-service-id}/interface-groups/{interface-group-id}/statistics
|
Delete Tier-0 Interface group
Delete Tier-0 Interface group
|
DELETE /policy/api/v1/infra/tier-0s/{tier-0-id}/locale-services/{locale-service-id}/interface-groups/{label-id}
|
Read Tier-0 Interface group
Read Tier-0 Interface group
|
GET /policy/api/v1/infra/tier-0s/{tier-0-id}/locale-services/{locale-service-id}/interface-groups/{label-id}
|
Create or update a Tier-0 Interface group.
If an Interface group with the label-id is not already present, create a new
Interface group. If it already exists, update the Interface group for specified attributes.
|
PATCH /policy/api/v1/infra/tier-0s/{tier-0-id}/locale-services/{locale-service-id}/interface-groups/{label-id}
|
Update a Tier-0 Interface group.
Update the Interface group for specified attributes.
|
PUT /policy/api/v1/infra/tier-0s/{tier-0-id}/locale-services/{locale-service-id}/interface-groups/{label-id}
|
List Tier-0 Interfaces
Paginated list of all Tier-0 Interfaces
|
GET /policy/api/v1/infra/tier-0s/{tier-0-id}/locale-services/{locale-service-id}/interfaces
GET /policy/api/v1/global-infra/tier-0s/{tier-0-id}/locale-services/{locale-service-id}/interfaces
|
Delete Tier-0 interface
Delete Tier-0 interface
|
DELETE /policy/api/v1/infra/tier-0s/{tier-0-id}/locale-services/{locale-service-id}/interfaces/{interface-id}
DELETE /policy/api/v1/global-infra/tier-0s/{tier-0-id}/locale-services/{locale-service-id}/interfaces/{interface-id}
|
Read Tier-0 interface
Read Tier-0 interface
|
GET /policy/api/v1/infra/tier-0s/{tier-0-id}/locale-services/{locale-service-id}/interfaces/{interface-id}
GET /policy/api/v1/global-infra/tier-0s/{tier-0-id}/locale-services/{locale-service-id}/interfaces/{interface-id}
|
Create or update a Tier-0 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.
|
PATCH /policy/api/v1/infra/tier-0s/{tier-0-id}/locale-services/{locale-service-id}/interfaces/{interface-id}
PATCH /policy/api/v1/global-infra/tier-0s/{tier-0-id}/locale-services/{locale-service-id}/interfaces/{interface-id}
|
Create or update a Tier-0 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.
|
PUT /policy/api/v1/infra/tier-0s/{tier-0-id}/locale-services/{locale-service-id}/interfaces/{interface-id}
PUT /policy/api/v1/global-infra/tier-0s/{tier-0-id}/locale-services/{locale-service-id}/interfaces/{interface-id}
|
Get Tier-0 Interface Address Resolution Protocol Proxies in CSV format
Returns ARP proxy table for a tier-0 interface in CSV format. Interfaces can be of types
- EXTERNAL and SERVICE. Interfaces of type LOOBACK and downlink are not
supported.
|
GET /policy/api/v1/infra/tier-0s/{tier-0-id}/locale-services/{locale-service-id}/interfaces/{interface-id}/arp-proxy?format=csv
GET /policy/api/v1/global-infra/tier-0s/{tier-0-id}/locale-services/{locale-service-id}/interfaces/{interface-id}/arp-proxy?format=csv
|
Get Tier-0 Interface Address Resolution Protocol Proxies
Returns ARP proxy table for a tier-0 interface. Interfaces can be of types
- EXTERNAL and SERVICE. Interfaces of type LOOBACK and downlink are not
supported.
|
GET /policy/api/v1/infra/tier-0s/{tier-0-id}/locale-services/{locale-service-id}/interfaces/{interface-id}/arp-proxy
GET /policy/api/v1/global-infra/tier-0s/{tier-0-id}/locale-services/{locale-service-id}/interfaces/{interface-id}/arp-proxy
|
Get ARP table from tier-0 interface in CSV format
Returns ARP table (IPv4) or Neighbor Discovery table (IPv6) in CSV format
for the tier-0 interface, on a edge node if a query parameter
"edge_path=<policy-edge-path>" is given. The edge_path
parameter is mandatory if the interface type is not EXTERNAL.
|
GET /policy/api/v1/infra/tier-0s/{tier-0-id}/locale-services/{locale-service-id}/interfaces/{interface-id}/arp-table?format=csv
GET /policy/api/v1/global-infra/tier-0s/{tier-0-id}/locale-services/{locale-service-id}/interfaces/{interface-id}/arp-table?format=csv
|
Get ARP table from tier-0 interface
Returns ARP table (IPv4) or Neighbor Discovery table (IPv6) for the
tier-0 interface, on a edge node if a query parameter
"edge_path=<policy-edge-path>" is given. The edge_path
parameter is mandatory if the interface type is not EXTERNAL.
|
GET /policy/api/v1/infra/tier-0s/{tier-0-id}/locale-services/{locale-service-id}/interfaces/{interface-id}/arp-table
GET /policy/api/v1/global-infra/tier-0s/{tier-0-id}/locale-services/{locale-service-id}/interfaces/{interface-id}/arp-table
|
Get DAD status by interface
Get tier-0 interface DAD state information.
|
GET /policy/api/v1/infra/tier-0s/{tier-0-id}/locale-services/{locale-service-id}/interfaces/{interface-id}/dad-state
GET /policy/api/v1/global-infra/tier-0s/{tier-0-id}/locale-services/{locale-service-id}/interfaces/{interface-id}/dad-state
|
Get tier-0 interface statistics information
Get tier-0 interface statistics information.
|
GET /policy/api/v1/infra/tier-0s/{tier-0-id}/locale-services/{locale-service-id}/interfaces/{interface-id}/statistics
GET /policy/api/v1/global-infra/tier-0s/{tier-0-id}/locale-services/{locale-service-id}/interfaces/{interface-id}/statistics
|
Get tier-0 interface statistics summary information
Get tier-0 interface statistics summary information.
|
GET /policy/api/v1/infra/tier-0s/{tier-0-id}/locale-services/{locale-service-id}/interfaces/{interface-id}/statistics/summary
GET /policy/api/v1/global-infra/tier-0s/{tier-0-id}/locale-services/{locale-service-id}/interfaces/{interface-id}/statistics/summary
|
Get IPSec VPN service list result
Get paginated list of all IPSec VPN services
for given locale service under Tier-0.
Note:
Please note that request is validated and any error messages returned from validation may include the new VPN path
instead of the deprecated path. Both new path and old path refer to same resource.
|
GET /policy/api/v1/infra/tier-0s/{tier-0-id}/locale-services/{locale-service-id}/ipsec-vpn-services
(Deprecated)
|
Delete IPSec VPN service
Delete IPSec VPN service for given locale
service under Tier-0.
|
DELETE /policy/api/v1/infra/tier-0s/{tier-0-id}/locale-services/{locale-service-id}/ipsec-vpn-services/{service-id}
(Deprecated)
|
Get IPSec VPN service
Get IPSec VPN service for given locale
service under Tier-0.
|
GET /policy/api/v1/infra/tier-0s/{tier-0-id}/locale-services/{locale-service-id}/ipsec-vpn-services/{service-id}
(Deprecated)
|
Create or patch IPSec VPN service
Create or patch IPSec VPN service for given locale
service under Tier-0.
|
PATCH /policy/api/v1/infra/tier-0s/{tier-0-id}/locale-services/{locale-service-id}/ipsec-vpn-services/{service-id}
(Deprecated)
|
Create or fully replace IPSec 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.
|
PUT /policy/api/v1/infra/tier-0s/{tier-0-id}/locale-services/{locale-service-id}/ipsec-vpn-services/{service-id}
(Deprecated)
|
Get IPSec VPN local endpoint list result
Get paginated list of all IPSec VPN local endpoints
for a given locale service under Tier-0.
|
GET /policy/api/v1/infra/tier-0s/{tier-0-id}/locale-services/{locale-service-id}/ipsec-vpn-services/{service-id}/local-endpoints
(Deprecated)
|
Delete IPSec VPN local endpoint
Delete IPSec VPN local endpoint for a given locale
service under Tier-0.
|
DELETE /policy/api/v1/infra/tier-0s/{tier-0-id}/locale-services/{locale-service-id}/ipsec-vpn-services/{service-id}/local-endpoints/{local-endpoint-id}
(Deprecated)
|
Get IPSec VPN local endpoint
Get IPSec VPN local endpoint for a given locale
service under Tier-0.
|
GET /policy/api/v1/infra/tier-0s/{tier-0-id}/locale-services/{locale-service-id}/ipsec-vpn-services/{service-id}/local-endpoints/{local-endpoint-id}
(Deprecated)
|
Create or patch a custom IPSec VPN local endpoint
Create or patch a custom IPSec VPN local endpoint
for a given locale service under Tier-0.
|
PATCH /policy/api/v1/infra/tier-0s/{tier-0-id}/locale-services/{locale-service-id}/ipsec-vpn-services/{service-id}/local-endpoints/{local-endpoint-id}
(Deprecated)
|
Create or fully replace IPSec VPN local endpoint
Create or fully replace IPSec VPN local endpoint
for a given locale service under Tier-0.
Revision is optional for creation and required for update.
Note:
Please note that request is validated and any error messages returned from validation may include the new VPN path
instead of the deprecated path. Both new path and old path refer to same resource.
Also VPN path returned in the Alarm, GPRR payload may include the new VPN path
|
PUT /policy/api/v1/infra/tier-0s/{tier-0-id}/locale-services/{locale-service-id}/ipsec-vpn-services/{service-id}/local-endpoints/{local-endpoint-id}
(Deprecated)
|
Get IPSec VPN sessions list result
Get paginated list of all IPSec VPN sessions
for a given locale service under Tier-0.
|
GET /policy/api/v1/infra/tier-0s/{tier-0-id}/locale-services/{locale-service-id}/ipsec-vpn-services/{service-id}/sessions
(Deprecated)
|
Delete IPSec VPN session
Delete IPSec VPN session for a given locale
service under Tier-0.
|
DELETE /policy/api/v1/infra/tier-0s/{tier-0-id}/locale-services/{locale-service-id}/ipsec-vpn-services/{service-id}/sessions/{session-id}
(Deprecated)
|
Get IPSec VPN Session
Get IPSec VPN session with senstive data for
a given locale service under Tier-0.
|
GET /policy/api/v1/infra/tier-0s/{tier-0-id}/locale-services/{locale-service-id}/ipsec-vpn-services/{service-id}/sessions/{session-id}?action=show_sensitive_data
(Deprecated)
|
Get IPSec VPN Session
Get IPSec VPN session without sensitive data
for a given locale service under Tier-0.
|
GET /policy/api/v1/infra/tier-0s/{tier-0-id}/locale-services/{locale-service-id}/ipsec-vpn-services/{service-id}/sessions/{session-id}
(Deprecated)
|
Create or patch an IPSec VPN session
Create or patch an IPSec VPN session for
a given locale service under Tier-0.
|
PATCH /policy/api/v1/infra/tier-0s/{tier-0-id}/locale-services/{locale-service-id}/ipsec-vpn-services/{service-id}/sessions/{session-id}
(Deprecated)
|
Create or fully replace IPSec VPN session
Create or fully replace IPSec VPN session for a given
locale service under Tier-0.
Revision is optional for creation and required for update.
|
PUT /policy/api/v1/infra/tier-0s/{tier-0-id}/locale-services/{locale-service-id}/ipsec-vpn-services/{service-id}/sessions/{session-id}
(Deprecated)
|
Get IPSec VPN session detailed status under Tier-0
- no enforcement point path specified: detailed status is evaluated on each enforcement point.
- an enforcement point path is specified: detailed status is evaluated only on the given
enforcement point.
- source=realtime: detailed status is fetched realtime from the enforcement point.
- source=cached: cached detailed status from enforcement point is returned.
|
GET /policy/api/v1/infra/tier-0s/{tier-0-id}/locale-services/{locale-service-id}/ipsec-vpn-services/{service-id}/sessions/{session-id}/detailed-status
(Deprecated)
GET /policy/api/v1/orgs/{org-id}/projects/{project-id}/infra/tier-0s/{tier-0-id}/locale-services/{locale-service-id}/ipsec-vpn-services/{service-id}/sessions/{session-id}/detailed-status
(Deprecated)
|
Get IPSec VPN configuration for the peer site
Download IPSec VPN configuration for the peer site. Peer config also
contains PSK; be careful when sharing or storing it.
|
GET /policy/api/v1/infra/tier-0s/{tier-0-id}/locale-services/{locale-service-id}/ipsec-vpn-services/{service-id}/sessions/{session-id}/peer-config
(Deprecated)
|
Get IPSec VPN session statistics under Tier-0
- no enforcement point path specified: statistics are evaluated on each enforcement point.
- an enforcement point path is specified: statistics are evaluated only on the given
enforcement point.
- source=realtime: statistics are fetched realtime from the enforcement point.
- source=cached: cached statistics from enforcement point are returned.
|
GET /policy/api/v1/infra/tier-0s/{tier-0-id}/locale-services/{locale-service-id}/ipsec-vpn-services/{service-id}/sessions/{session-id}/statistics
(Deprecated)
GET /policy/api/v1/orgs/{org-id}/projects/{project-id}/infra/tier-0s/{tier-0-id}/locale-services/{locale-service-id}/ipsec-vpn-services/{service-id}/sessions/{session-id}/statistics
(Deprecated)
|
Reset the statistics of the given VPN session
Resets the statistics of the given VPN session.
Since source of data is enforcement point, data is
reset there.
|
POST /policy/api/v1/infra/tier-0s/{tier-0-id}/locale-services/{locale-service-id}/ipsec-vpn-services/{service-id}/sessions/{session-id}/statistics
(Deprecated)
POST /policy/api/v1/orgs/{org-id}/projects/{project-id}/infra/tier-0s/{tier-0-id}/locale-services/{locale-service-id}/ipsec-vpn-services/{service-id}/sessions/{session-id}/statistics
(Deprecated)
|
Get IPSec VPN Session Summary
Summarized view of all tier-0 IPSec VPN sessions for a specified service.
|
GET /policy/api/v1/infra/tier-0s/{tier-0-id}/locale-services/{locale-service-id}/ipsec-vpn-services/{service-id}/summary
(Deprecated)
GET /policy/api/v1/orgs/{org-id}/projects/{project-id}/infra/tier-0s/{tier-0-id}/locale-services/{locale-service-id}/ipsec-vpn-services/{service-id}/summary
(Deprecated)
|
Get L2VPN service list result under Tier-0
Get paginated list of all L2VPN services under Tier-0.
|
GET /policy/api/v1/infra/tier-0s/{tier-0-id}/locale-services/{locale-service-id}/l2vpn-services
(Deprecated)
|
Delete L2VPN service under Tier-0
Delete L2VPN service for given Tier-0 locale service.
|
DELETE /policy/api/v1/infra/tier-0s/{tier-0-id}/locale-services/{locale-service-id}/l2vpn-services/{service-id}
(Deprecated)
|
Get L2VPN service under Tier-0
Get L2VPN service for given Tier-0 locale service.
|
GET /policy/api/v1/infra/tier-0s/{tier-0-id}/locale-services/{locale-service-id}/l2vpn-services/{service-id}
(Deprecated)
|
Create or patch L2VPN service under Tier-0
Create or patch L2VPN service for given Tier-0 locale service.
|
PATCH /policy/api/v1/infra/tier-0s/{tier-0-id}/locale-services/{locale-service-id}/l2vpn-services/{service-id}
(Deprecated)
|
Create or fully replace L2VPN service under Tier-0
Create or fully replace L2VPN service for given Tier-0 locale service.
Revision is optional for creation and required for update.
|
PUT /policy/api/v1/infra/tier-0s/{tier-0-id}/locale-services/{locale-service-id}/l2vpn-services/{service-id}
(Deprecated)
|
Get L2VPN sessions list result under Tier-0
Get paginated list of all L2VPN sessions under Tier-0.
|
GET /policy/api/v1/infra/tier-0s/{tier-0-id}/locale-services/{locale-service-id}/l2vpn-services/{service-id}/sessions
(Deprecated)
|
Delete L2VPN session under Tier-0
Delete L2VPN session under Tier-0. When L2VPN Service is in CLIENT Mode,
the L2VPN Session is deleted along with its transpot tunnels and related
resources.
|
DELETE /policy/api/v1/infra/tier-0s/{tier-0-id}/locale-services/{locale-service-id}/l2vpn-services/{service-id}/sessions/{session-id}
(Deprecated)
|
Get L2VPN Session under Tier-0
Get L2VPN session under Tier-0.
|
GET /policy/api/v1/infra/tier-0s/{tier-0-id}/locale-services/{locale-service-id}/l2vpn-services/{service-id}/sessions/{session-id}
(Deprecated)
|
Create or patch an L2VPN session under Tier-0
Create or patch an L2VPN session under Tier-0. API supported
only when L2VPN Service is in Server Mode.
|
PATCH /policy/api/v1/infra/tier-0s/{tier-0-id}/locale-services/{locale-service-id}/l2vpn-services/{service-id}/sessions/{session-id}
(Deprecated)
|
Create or patch an L2VPN session under Tier-0 from Peer Codes
Create or patch an L2VPN session under Tier-0 from Peer Codes.
In addition to the L2VPN Session, the IPSec VPN Session, along
with the IKE, Tunnel, and DPD Profiles are created and owned by
the system. IPSec VPN Service and Local Endpoint are created only
when required, i.e., an IPSec VPN Service does not already exist,
or an IPSec VPN Local Endpoint with same local address does not
already exist.
Updating the L2VPN Session can be performed only through this API
by specifying new peer codes. Use of specific APIs to update the
L2VPN Session and the different resources associated with it is
not allowed, except for IPSec VPN Service and Local Endpoint,
resources that are not system owned.
API supported only when L2VPN Service is in Client Mode.
Note:
Please note that request is validated and any error messages returned from validation may include the new VPN path
instead of the deprecated path. Both new path and old path refer to same resource.
Also VPN path returned in the Alarm, GPRR payload may include the new VPN path.
|
POST /policy/api/v1/infra/tier-0s/{tier-0-id}/locale-services/{locale-service-id}/l2vpn-services/{service-id}/sessions/{session-id}?action=create_with_peer_code
(Deprecated)
|
Create or fully replace L2VPN session under Tier-0
Create or fully replace L2VPN session under Tier-0. API supported
only when L2VPN Service is in Server Mode.
Revision is optional for creation and required for update.
|
PUT /policy/api/v1/infra/tier-0s/{tier-0-id}/locale-services/{locale-service-id}/l2vpn-services/{service-id}/sessions/{session-id}
(Deprecated)
|
Get L2VPN session detailed status under Tier-0
- no enforcement point path specified: detailed tatus is evaluated on each enforcement point.
- an enforcement point path is specified: detailed status is evaluated only on the given
enforcement point.
- source=realtime: detailed tatus is fetched realtime from the enforcement point.
- source=cached: cached detailed status is returned.
|
GET /policy/api/v1/infra/tier-0s/{tier-0-id}/locale-services/{locale-service-id}/l2vpn-services/{service-id}/sessions/{session-id}/detailed-status
(Deprecated)
|
Get Tier-0 L2VPN session configuration for the peer site
Get peer config for the Tier-0 L2VPN session to configure the remote
side of the tunnel.
- no enforcement point path specified: L2VPN Session Peer Codes
will be evaluated on each enforcement point.
- enforcement point paths specified: L2VPN Session Peer Codes
are evaluated only on the given enforcement points.
API supported only when L2VPN Service is in Server Mode.
|
GET /policy/api/v1/infra/tier-0s/{tier-0-id}/locale-services/{locale-service-id}/l2vpn-services/{service-id}/sessions/{session-id}/peer-config
(Deprecated)
|
Get L2Vpn session remote mac for logical switch
Returns L2Vpn session remote macs for a logical switch.
Data is fetched from enforcement point.
|
GET /policy/api/v1/infra/tier-0s/{tier-0-id}/locale-services/{locale-service-id}/l2vpn-services/{service-id}/sessions/{session-id}/remote-mac
(Deprecated)
|
Get L2VPN session statistics under Tier-0
- no enforcement point path specified: statistics are evaluated on each enforcement point.
- an enforcement point path is specified: statistics are evaluated only on the given
enforcement point.
- source=realtime: statistics are fetched realtime from the enforcement point.
- source=cached: cached statistics from the enforcement point are returned.
|
GET /policy/api/v1/infra/tier-0s/{tier-0-id}/locale-services/{locale-service-id}/l2vpn-services/{service-id}/sessions/{session-id}/statistics
(Deprecated)
|
Read OSPF routing config
Read OSPF routing config
|
GET /policy/api/v1/infra/tier-0s/{tier-0-id}/locale-services/{locale-service-id}/ospf
|
Create or update a OSPF routing config
If OSPF routing config is not already present, create OSPF routing config.
If it already exists, replace the OSPF routing config with this object.
|
PATCH /policy/api/v1/infra/tier-0s/{tier-0-id}/locale-services/{locale-service-id}/ospf
|
Create or update a OSPF routing config
If OSPF routing config is not already present, create OSPF routing config.
If it already exists, replace the OSPF routing config with this object.
|
PUT /policy/api/v1/infra/tier-0s/{tier-0-id}/locale-services/{locale-service-id}/ospf
|
List OSPF area configurations
List all OSPF area configurations.
|
GET /policy/api/v1/infra/tier-0s/{tier-0-id}/locale-services/{locale-service-id}/ospf/areas
|
Delete OSPF Area config
Delete OSPF Area config
|
DELETE /policy/api/v1/infra/tier-0s/{tier-0-id}/locale-services/{locale-service-id}/ospf/areas/{area-id}
|
Read OSPF Area config
Read OSPF Area config
|
GET /policy/api/v1/infra/tier-0s/{tier-0-id}/locale-services/{locale-service-id}/ospf/areas/{area-id}
|
Create or update a OSPF Area config
If OSPF Area config is not already present, create OSPF Area config.
If it already exists, replace the OSPF Area config with this object.
|
PATCH /policy/api/v1/infra/tier-0s/{tier-0-id}/locale-services/{locale-service-id}/ospf/areas/{area-id}
|
Create or update a OSPF Area config
If OSPF Area config is not already present, create OSPF Area config.
If it already exists, replace the OSPF Area config with this object.
|
PUT /policy/api/v1/infra/tier-0s/{tier-0-id}/locale-services/{locale-service-id}/ospf/areas/{area-id}
|
Get OSPF database information
Get OSPF database information.
|
GET /policy/api/v1/infra/tier-0s/{tier-0-id}/locale-services/{locale-service-id}/ospf/database
|
Get OSPF Database information in CSV format
Get OSPF Database information in CSV format.
|
GET /policy/api/v1/infra/tier-0s/{tier-0-id}/locale-services/{locale-service-id}/ospf/database?format=csv
|
Get OSPF neighbor information
Get OSPF neighbor information.
|
GET /policy/api/v1/infra/tier-0s/{tier-0-id}/locale-services/{locale-service-id}/ospf/neighbors
|
Get OSPF route information
Get OSPF route information.
|
GET /policy/api/v1/infra/tier-0s/{tier-0-id}/locale-services/{locale-service-id}/ospf/routes
|
Get OSPF route information in CSV format
Get OSPF route information in CSV format.
|
GET /policy/api/v1/infra/tier-0s/{tier-0-id}/locale-services/{locale-service-id}/ospf/routes?format=csv
|
List Service Interfaces
Paginated list of all Service Interfaces
|
GET /policy/api/v1/infra/tier-0s/{tier-0-id}/locale-services/{locale-service-id}/service-interfaces
GET /policy/api/v1/global-infra/tier-0s/{tier-0-id}/locale-services/{locale-service-id}/service-interfaces
|
Delete service interface
Delete service interface
|
DELETE /policy/api/v1/infra/tier-0s/{tier-0-id}/locale-services/{locale-service-id}/service-interfaces/{interface-id}
|
Read service interface
Read service interface
|
GET /policy/api/v1/infra/tier-0s/{tier-0-id}/locale-services/{locale-service-id}/service-interfaces/{interface-id}
GET /policy/api/v1/global-infra/tier-0s/{tier-0-id}/locale-services/{locale-service-id}/service-interfaces/{interface-id}
|
Create or update a Tier-0 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.
|
PATCH /policy/api/v1/infra/tier-0s/{tier-0-id}/locale-services/{locale-service-id}/service-interfaces/{interface-id}
|
Create a service interface
If an interface with the interface-id is not already present, create a new
interface. Modification of service interface is not allowed.
|
PUT /policy/api/v1/infra/tier-0s/{tier-0-id}/locale-services/{locale-service-id}/service-interfaces/{interface-id}
|
List Tier-0 Deployment maps
Paginated list of all Tier-0 Deployment Entries.
|
GET /policy/api/v1/infra/tier-0s/{tier-0-id}/locale-services/{locale-service-id}/tier-0-deployment-maps
GET /policy/api/v1/global-infra/tier-0s/{tier-0-id}/locale-services/{locale-service-id}/tier-0-deployment-maps
|
Delete Tier-0 Deployment Map
Delete Tier-0 Deployment Map
|
DELETE /policy/api/v1/infra/tier-0s/{tier-0-id}/locale-services/{locale-service-id}/tier-0-deployment-maps/{tier-0-deployment-map-id}
|
Read a Tier-0 Deployment Map
Read a Tier-0 Deployment Map
|
GET /policy/api/v1/infra/tier-0s/{tier-0-id}/locale-services/{locale-service-id}/tier-0-deployment-maps/{tier-0-deployment-map-id}
GET /policy/api/v1/global-infra/tier-0s/{tier-0-id}/locale-services/{locale-service-id}/tier-0-deployment-maps/{tier-0-deployment-map-id}
|
Patch a Tier-0 Deployment Map under Tier-0
If the passed Tier-0 Deployment Map does not already exist, create a new Tier-0 Deployment Map.
If it already exists, patch it.
|
PATCH /policy/api/v1/infra/tier-0s/{tier-0-id}/locale-services/{locale-service-id}/tier-0-deployment-maps/{tier-0-deployment-map-id}
|
Create a new Tier-0 Deployment Map under Tier-0
If the passed Tier-0 Deployment Map does not already exist, create a new Tier-0 Deployment Map.
If it already exists, replace it.
|
PUT /policy/api/v1/infra/tier-0s/{tier-0-id}/locale-services/{locale-service-id}/tier-0-deployment-maps/{tier-0-deployment-map-id}
|
Delete Tier-0 locale-services
Delete Tier-0 locale-services
|
DELETE /policy/api/v1/infra/tier-0s/{tier-0-id}/locale-services/{locale-services-id}
|
Read Tier-0 locale-services
Read Tier-0 locale-services
|
GET /policy/api/v1/infra/tier-0s/{tier-0-id}/locale-services/{locale-services-id}
GET /policy/api/v1/global-infra/tier-0s/{tier-0-id}/locale-services/{locale-services-id}
|
Create or update a tier-0 locale-services
If a Tier-0 locale-services with the locale-services-id is not already
present, create a new locale-services. If it already exists, update
Tier-0 locale-services with specified attributes.
|
PATCH /policy/api/v1/infra/tier-0s/{tier-0-id}/locale-services/{locale-services-id}
|
Create or update a Tier-0 locale-services
If a Tier-0 locale-services with the locale-services-id is not already
present, create a new locale-services. If it already exists, replace the
Tier-0 locale-services instance with the new object.
|
PUT /policy/api/v1/infra/tier-0s/{tier-0-id}/locale-services/{locale-services-id}
|
List evpn tunnel endpoint configuration
List all evpn tunnel endpoint configuration.
|
GET /policy/api/v1/infra/tier-0s/{tier-0-id}/locale-services/{locale-services-id}/evpn-tunnel-endpoints
|
Delete evpn tunnel endpoint configuration
Delete evpn tunnel endpoint configuration.
|
DELETE /policy/api/v1/infra/tier-0s/{tier-0-id}/locale-services/{locale-services-id}/evpn-tunnel-endpoints/{tunnel-endpoint-id}
|
Read evpn tunnel endpoint configuration
Read evpn tunnel endpoint configuration.
|
GET /policy/api/v1/infra/tier-0s/{tier-0-id}/locale-services/{locale-services-id}/evpn-tunnel-endpoints/{tunnel-endpoint-id}
|
Create or Update evpn tunnel endpoint configuration
Create a evpn tunnel endpoint config if the tunnel-endpoint-id is not already present,
otherwise update the tunnel endpoint configuration.
|
PATCH /policy/api/v1/infra/tier-0s/{tier-0-id}/locale-services/{locale-services-id}/evpn-tunnel-endpoints/{tunnel-endpoint-id}
|
Create or Update evpn tunnel endpoint configuration
Create or update evpn tunnel endpoint configuration.
|
PUT /policy/api/v1/infra/tier-0s/{tier-0-id}/locale-services/{locale-services-id}/evpn-tunnel-endpoints/{tunnel-endpoint-id}
|
Read Multicast Configuration
Read Multicast Configuration.
|
GET /policy/api/v1/infra/tier-0s/{tier-0-id}/locale-services/{locale-services-id}/multicast
|
Create or update multicast configuration
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.
|
PATCH /policy/api/v1/infra/tier-0s/{tier-0-id}/locale-services/{locale-services-id}/multicast
|
Create or update multicast configuration
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.
|
PUT /policy/api/v1/infra/tier-0s/{tier-0-id}/locale-services/{locale-services-id}/multicast
|
Get Multicast Forwarding In Csv Format
Get Multicast Forwarding In CSV Format.
|
GET /policy/api/v1/infra/tier-0s/{tier-0-id}/locale-services/{locale-services-id}/multicast/forwarding?format=csv
|
Get Multicast Forwarding
Get Multicast Forwarding.
|
GET /policy/api/v1/infra/tier-0s/{tier-0-id}/locale-services/{locale-services-id}/multicast/forwarding
|
Get IGMP Memberships in CSV format
Get Igmp Memberships in CSV format.
|
GET /policy/api/v1/infra/tier-0s/{tier-0-id}/locale-services/{locale-services-id}/multicast/igmp-memberships?format=csv
|
Get IGMP Memberships
Get Igmp Memberships.
|
GET /policy/api/v1/infra/tier-0s/{tier-0-id}/locale-services/{locale-services-id}/multicast/igmp-memberships
|
Get PIM Rendezvous Point Mappings In CSV Format
Get PIM Rendezvous Point Mappings In CSV Format.
|
GET /policy/api/v1/infra/tier-0s/{tier-0-id}/locale-services/{locale-services-id}/multicast/pim-rp-mappings?format=csv
|
Get PIM Rendezvous Point Mappings
Get PIM Rendezvous Point Mappings.
|
GET /policy/api/v1/infra/tier-0s/{tier-0-id}/locale-services/{locale-services-id}/multicast/pim-rp-mappings
|
Get Multicast Routes in Csv Format
Get Multicast Routes in CSV Format.
|
GET /policy/api/v1/infra/tier-0s/{tier-0-id}/locale-services/{locale-services-id}/multicast/routes?format=csv
|
Get Multicast Routes
Get Multicast Routes.
|
GET /policy/api/v1/infra/tier-0s/{tier-0-id}/locale-services/{locale-services-id}/multicast/routes
|
List Tunnel
List Tunnel
|
GET /policy/api/v1/infra/tier-0s/{tier-0-id}/locale-services/{locale-svc-id}/tunnels
|
Delete Tunnel by given tunnel Id
Delete Tunnel by given tunnel Id
|
DELETE /policy/api/v1/infra/tier-0s/{tier-0-id}/locale-services/{locale-svc-id}/tunnels/{tunnel-id}
|
Get Policy Tunnel
Get Policy Tunnel
|
GET /policy/api/v1/infra/tier-0s/{tier-0-id}/locale-services/{locale-svc-id}/tunnels/{tunnel-id}
|
Patch Tunnel
Patch Tunnel
|
PATCH /policy/api/v1/infra/tier-0s/{tier-0-id}/locale-services/{locale-svc-id}/tunnels/{tunnel-id}
|
Create or Update Tunnel
Create or Update Tunnel
|
PUT /policy/api/v1/infra/tier-0s/{tier-0-id}/locale-services/{locale-svc-id}/tunnels/{tunnel-id}
|
Get policy Tunnel statistics for given tunnel-id
Get policy Tunnel statistics for given tunnel-id
|
GET /policy/api/v1/infra/tier-0s/{tier-0-id}/locale-services/{locale-svc-id}/tunnels/{tunnel-id}/statistics
|
Get policy Tunnel statistics summary for given tunnel-id
Get policy Tunnel statistics summary for given tunnel-id
|
GET /policy/api/v1/infra/tier-0s/{tier-0-id}/locale-services/{locale-svc-id}/tunnels/{tunnel-id}/statistics/summary
|
Get policy Tunnel status for given tunnel-id
Get policy Tunnel status for given tunnel-id
|
GET /policy/api/v1/infra/tier-0s/{tier-0-id}/locale-services/{locale-svc-id}/tunnels/{tunnel-id}/status
|
List Policy NAT types.
List all NAT sections under the given Tier-0 ID.
For more details related to NAT section please refer to PolicyNAT schema.
|
GET /policy/api/v1/infra/tier-0s/{tier-0-id}/nat
GET /policy/api/v1/global-infra/tier-0s/{tier-0-id}/nat
|
List NAT Rules
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.
Note:
IPSecVpnSession as Scope: Please note that old IPSecVpnSession policy path deprecated. If user specifiy old IPSecVpnSession path in the
scope property in the PATCH/PUT API, the path returned in the GET response payload will be a new path instead of the deprecated IPSecVpnSession path
Both old and new IPSecVpnSession path refer to same resource. there is no functional impact.
|
GET /policy/api/v1/infra/tier-0s/{tier-0-id}/nat/{nat-id}/nat-rules
GET /policy/api/v1/global-infra/tier-0s/{tier-0-id}/nat/{nat-id}/nat-rules
|
Delete NAT Rule
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.
|
DELETE /policy/api/v1/infra/tier-0s/{tier-0-id}/nat/{nat-id}/nat-rules/{nat-rule-id}
|
Get NAT Rule
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.
Note:
IPSecVpnSession as Scope: Please note that old IPSecVpnSession policy path deprecated. If user specifiy old IPSecVpnSession path in the
scope property in the PUT/PATCH API, the path returned in the GET response payload will be a new path instead of the deprecated IPSecVpnSession path
Both old and new IPSecVpnSession path refer to same resource. there is no functional impact.
|
GET /policy/api/v1/infra/tier-0s/{tier-0-id}/nat/{nat-id}/nat-rules/{nat-rule-id}
GET /policy/api/v1/global-infra/tier-0s/{tier-0-id}/nat/{nat-id}/nat-rules/{nat-rule-id}
|
Create or update a NAT Rule on tier-0
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.
Note:
IPSecVpnSession as Scope: Please note that old IPSecVpnSession policy path deprecated. If user specifiy old IPSecVpnSession path in the
scope property in the PATCH API, the path returned in the GET response payload will be a new path instead of the deprecated IPSecVpnSession path
Both old and new IPSecVpnSession path refer to same resource. there is no functional impact.
|
PATCH /policy/api/v1/infra/tier-0s/{tier-0-id}/nat/{nat-id}/nat-rules/{nat-rule-id}
|
Create or update NAT Rule
Create or 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.
Note:
IPSecVpnSession as Scope: Please note that old IPSecVpnSession policy path deprecated. If user specifiy old IPSecVpnSession path in the
scope property in the PUT API, the path returned in the PUT/GET response payload will be a new path instead of the deprecated IPSecVpnSession path
Both old and new IPSecVpnSession path refer to same resource. there is no functional impact.
|
PUT /policy/api/v1/infra/tier-0s/{tier-0-id}/nat/{nat-id}/nat-rules/{nat-rule-id}
|
Get NAT Rule Statistics
Get NAT Rule Statistics 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.
|
GET /policy/api/v1/infra/tier-0s/{tier-0-id}/nat/{nat-id}/nat-rules/{nat-rule-id}/statistics
GET /policy/api/v1/global-infra/tier-0s/{tier-0-id}/nat/{nat-id}/nat-rules/{nat-rule-id}/statistics
|
List NAT Rules Statistics
List NAT Rules Statistics from Tier-0 denoted by Tier-0 ID.
|
GET /policy/api/v1/infra/tier-0s/{tier-0-id}/nat/statistics
GET /policy/api/v1/global-infra/tier-0s/{tier-0-id}/nat/statistics
|
Get total number of IPv4 or IPv6 routes on a Tier0
Get total number of IPv4 or IPv6 routes on a Tier0
|
GET /policy/api/v1/infra/tier-0s/{tier-0-id}/number-of-routes
GET /policy/api/v1/global-infra/tier-0s/{tier-0-id}/number-of-routes
|
List prefix lists
Paginated list of all prefix lists
|
GET /policy/api/v1/infra/tier-0s/{tier-0-id}/prefix-lists
GET /policy/api/v1/global-infra/tier-0s/{tier-0-id}/prefix-lists
|
Delete a prefix list
Delete a prefix list
|
DELETE /policy/api/v1/infra/tier-0s/{tier-0-id}/prefix-lists/{prefix-list-id}
|
Read a prefix list
Read a prefix list
|
GET /policy/api/v1/infra/tier-0s/{tier-0-id}/prefix-lists/{prefix-list-id}
GET /policy/api/v1/global-infra/tier-0s/{tier-0-id}/prefix-lists/{prefix-list-id}
|
Create or patch a prefix list
If prefix list for prefix-list-id is not already present, create
a prefix list. If it already exists, patch prefix list for prefix-list-id.
Note:
Patching existing prefix-list's "prefixes" property will overwrite the existing prefixes.
GET and PATCH is the expected set of operations to update or append new entries to the existig prefixes.
Patching existing prefixes require order to be preserved to avoid traffic impact. During PATCH operation,
reordering of existing prefixes may impact routes and eventually datapath.
Order here is crucial and it all depends upon action. If action for every prefix is PERMIT then order may
not impact but if there is DENY prefix then change in ordering could lead to traffic impact.
|
PATCH /policy/api/v1/infra/tier-0s/{tier-0-id}/prefix-lists/{prefix-list-id}
|
Create or update a prefix list
If prefix list for prefix-list-id is not already present, create
a prefix list. If it already exists, replace the prefix list for
prefix-list-id.
Note:
Updating existing prefixes require order to be preserved to avoid traffic impact. During PATCH operation,
reordering of existing prefixes may impact routes and eventually datapath.
Order here is crucial and it all depends upon action. If action for every prefix is PERMIT then order may
not impact but if there is DENY prefix then change in ordering could lead to traffic impact.
|
PUT /policy/api/v1/infra/tier-0s/{tier-0-id}/prefix-lists/{prefix-list-id}
|
List route maps
Paginated list of all route maps under a tier-0
|
GET /policy/api/v1/infra/tier-0s/{tier-0-id}/route-maps
GET /policy/api/v1/global-infra/tier-0s/{tier-0-id}/route-maps
|
Delete a route map
Delete a route map
|
DELETE /policy/api/v1/infra/tier-0s/{tier-0-id}/route-maps/{route-map-id}
|
Read a route map
Read a route map
|
GET /policy/api/v1/infra/tier-0s/{tier-0-id}/route-maps/{route-map-id}
GET /policy/api/v1/global-infra/tier-0s/{tier-0-id}/route-maps/{route-map-id}
|
Create or update a route map
If a route map with the route-map-id is not already present, create a new
route map. If it already exists, update the route map for specified
attributes.
|
PATCH /policy/api/v1/infra/tier-0s/{tier-0-id}/route-maps/{route-map-id}
|
Create or update a route map
If a route map with the route-map-id is not already present,
create a new route map. If it already exists, replace the
route map instance with the new object.
|
PUT /policy/api/v1/infra/tier-0s/{tier-0-id}/route-maps/{route-map-id}
|
Get routing table from tier-0
Get routing table from tier-0
|
GET /policy/api/v1/infra/tier-0s/{tier-0-id}/routing-table
GET /policy/api/v1/global-infra/tier-0s/{tier-0-id}/routing-table
|
Get routing table from tier-0 in CSV format
Get routing table from tier-0 gateway in CSV format.
|
GET /policy/api/v1/infra/tier-0s/{tier-0-id}/routing-table?format=csv
GET /policy/api/v1/global-infra/tier-0s/{tier-0-id}/routing-table?format=csv
|
Get Tier0 state
Returns
|
GET /policy/api/v1/infra/tier-0s/{tier-0-id}/state
GET /policy/api/v1/global-infra/tier-0s/{tier-0-id}/state
|
List Tier-0 Static Routes
Paginated list of all Tier-0 Static Routes
|
GET /policy/api/v1/infra/tier-0s/{tier-0-id}/static-routes
GET /policy/api/v1/global-infra/tier-0s/{tier-0-id}/static-routes
|
Delete Tier-0 static routes
Delete Tier-0 static routes
|
DELETE /policy/api/v1/infra/tier-0s/{tier-0-id}/static-routes/{route-id}
|
Read Tier-0 static routes
Read Tier-0 static routes
|
GET /policy/api/v1/infra/tier-0s/{tier-0-id}/static-routes/{route-id}
GET /policy/api/v1/global-infra/tier-0s/{tier-0-id}/static-routes/{route-id}
|
Create or update a Tier-0 static routes
If static routes for route-id are not already present, create
static routes. If it already exists, update static routes for route-id.
|
PATCH /policy/api/v1/infra/tier-0s/{tier-0-id}/static-routes/{route-id}
|
Create or update a Tier-0 static routes
If static routes for route-id are not already present, create
static routes. If it already exists, replace the static routes for route-id.
|
PUT /policy/api/v1/infra/tier-0s/{tier-0-id}/static-routes/{route-id}
PUT /policy/api/v1/global-infra/tier-0s/{tier-0-id}/static-routes/{route-id}
|
List StaticRouteBfdPeers
Paginated list of all StaticRouteBfdPeers.
|
GET /policy/api/v1/infra/tier-0s/{tier-0-id}/static-routes/bfd-peers
GET /policy/api/v1/global-infra/tier-0s/{tier-0-id}/static-routes/bfd-peers
|
Delete this StaticRouteBfdPeer and all the entities contained by it.
Delete this StaticRouteBfdPeer and all the entities contained by it.
|
DELETE /policy/api/v1/infra/tier-0s/{tier-0-id}/static-routes/bfd-peers/{bfd-peer-id}
|
Read a StaticRouteBfdPeer
Read a StaticRouteBfdPeer with the bfd-peer-id.
|
GET /policy/api/v1/infra/tier-0s/{tier-0-id}/static-routes/bfd-peers/{bfd-peer-id}
GET /policy/api/v1/global-infra/tier-0s/{tier-0-id}/static-routes/bfd-peers/{bfd-peer-id}
|
Create or update a StaticRouteBfdPeer
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.
|
PATCH /policy/api/v1/infra/tier-0s/{tier-0-id}/static-routes/bfd-peers/{bfd-peer-id}
|
Create or update a StaticRouteBfdPeer
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.
|
PUT /policy/api/v1/infra/tier-0s/{tier-0-id}/static-routes/bfd-peers/{bfd-peer-id}
|
Get tier-0 router link arp information
Get tier-0 interface arp information.
|
GET /policy/api/v1/infra/tier-0s/{tier-0-id}/tier-1-interface/arp-table
GET /policy/api/v1/global-infra/tier-0s/{tier-0-id}/tier-1-interface/arp-table
|
Get ARP table from tier-0 router link interface in CSV format
Returns ARP table (IPv4) or Neighbor Discovery table (IPv6) in CSV format
for the tier-0 router link interface, on a edge node. The edge_path
parameter is mandatory if the interface type is not EXTERNAL.
|
GET /policy/api/v1/infra/tier-0s/{tier-0-id}/tier-1-interface/arp-table?format=csv
GET /policy/api/v1/global-infra/tier-0s/{tier-0-id}/tier-1-interface/arp-table?format=csv
|
Get tier-0 router link statistics information
Get tier-0 interface statistics information.
|
GET /policy/api/v1/infra/tier-0s/{tier-0-id}/tier-1-interface/statistics
GET /policy/api/v1/global-infra/tier-0s/{tier-0-id}/tier-1-interface/statistics
|
Get tier-0 router link statistics summary information
Get tier-0 interface statistics summary information. In case tier 1 is A/A, and the edge cluster is not
the response will have interface_policy_path and logical_router_port_id empty because all logical router
port stats are aggregated from all edge nodes.
|
GET /policy/api/v1/infra/tier-0s/{tier-0-id}/tier-1-interface/statistics/summary
GET /policy/api/v1/global-infra/tier-0s/{tier-0-id}/tier-1-interface/statistics/summary
|
List Tier-1 instances
Paginated list of all Tier-1 instances
|
GET /policy/api/v1/infra/tier-1s
GET /policy/api/v1/global-infra/tier-1s
GET /policy/api/v1/orgs/{org-id}/projects/{project-id}/infra/tier-1s
|
Delete Tier-1 configuration
Delete Tier-1 configuration
|
DELETE /policy/api/v1/infra/tier-1s/{tier-1-id}
DELETE /policy/api/v1/orgs/{org-id}/projects/{project-id}/infra/tier-1s/{tier-1-id}
|
Read Tier-1 configuration
Read Tier-1 configuration
|
GET /policy/api/v1/infra/tier-1s/{tier-1-id}
GET /policy/api/v1/global-infra/tier-1s/{tier-1-id}
GET /policy/api/v1/orgs/{org-id}/projects/{project-id}/infra/tier-1s/{tier-1-id}
|
Create or update Tier-1 configuration
If Tier-1 with the tier-1-id is not already present, create a new Tier-1 instance.
If it already exists, update the tier-1 instance with specified attributes.
|
PATCH /policy/api/v1/infra/tier-1s/{tier-1-id}
PATCH /policy/api/v1/orgs/{org-id}/projects/{project-id}/infra/tier-1s/{tier-1-id}
|
Reprocess Tier1 gateway configuration and publish updates to NSX controller
Reprocess Tier1 gateway configuration and configuration of related entities like Tier1 interfaces
and static routes, etc. Any missing Updates are published to NSX controller.
|
POST /policy/api/v1/infra/tier-1s/{tier-1-id}?action=reprocess
POST /policy/api/v1/orgs/{org-id}/projects/{project-id}/infra/tier-1s/{tier-1-id}?action=reprocess
|
Create or update tier-1 configuration
If Tier-1 with the tier-1-id is not already present, create a new Tier-1 instance.
If it already exists, replace the Tier-1 instance with this object.
|
PUT /policy/api/v1/infra/tier-1s/{tier-1-id}
PUT /policy/api/v1/orgs/{org-id}/projects/{project-id}/infra/tier-1s/{tier-1-id}
|
List advertised networks
Return networks which are advertised to connected TIER0 gateway.
|
GET /policy/api/v1/infra/tier-1s/{tier-1-id}/advertised-networks
GET /policy/api/v1/global-infra/tier-1s/{tier-1-id}/advertised-networks
GET /policy/api/v1/orgs/{org-id}/projects/{project-id}/infra/tier-1s/{tier-1-id}/advertised-networks
|
List advertised networks in CSV format
Return networks which are advertised to connected TIER0 gateway in CSV format.
|
GET /policy/api/v1/infra/tier-1s/{tier-1-id}/advertised-networks/csv
GET /policy/api/v1/global-infra/tier-1s/{tier-1-id}/advertised-networks/csv
GET /policy/api/v1/orgs/{org-id}/projects/{project-id}/infra/tier-1s/{tier-1-id}/advertised-networks/csv
|
Get Tier-1 Address Resolution Protocol Proxies
Returns ARP proxy table for a tier-1
|
GET /policy/api/v1/infra/tier-1s/{tier-1-id}/arp-proxies
GET /policy/api/v1/global-infra/tier-1s/{tier-1-id}/arp-proxies
GET /policy/api/v1/orgs/{org-id}/projects/{project-id}/infra/tier-1s/{tier-1-id}/arp-proxies
|
Get Tier-1 Address Resolution Protocol Proxies in CSV format
Returns ARP proxy table for a tier-1 in CSV format
|
GET /policy/api/v1/infra/tier-1s/{tier-1-id}/arp-proxies?format=csv
GET /policy/api/v1/global-infra/tier-1s/{tier-1-id}/arp-proxies?format=csv
GET /policy/api/v1/orgs/{org-id}/projects/{project-id}/infra/tier-1s/{tier-1-id}/arp-proxies?format=csv
|
Delete DNS configuration for tier-1 instance
Delete DNS configuration for tier-1 instance
|
DELETE /policy/api/v1/infra/tier-1s/{tier-1-id}/dns-forwarder
DELETE /policy/api/v1/orgs/{org-id}/projects/{project-id}/infra/tier-1s/{tier-1-id}/dns-forwarder
|
Read the DNS Forwarder for the given tier-1 instance
Read the DNS Forwarder for the given tier-1 instance
|
GET /policy/api/v1/infra/tier-1s/{tier-1-id}/dns-forwarder
GET /policy/api/v1/global-infra/tier-1s/{tier-1-id}/dns-forwarder
GET /policy/api/v1/orgs/{org-id}/projects/{project-id}/infra/tier-1s/{tier-1-id}/dns-forwarder
|
Create or update the DNS Forwarder
Create or update the DNS Forwarder
|
PATCH /policy/api/v1/infra/tier-1s/{tier-1-id}/dns-forwarder
PATCH /policy/api/v1/orgs/{org-id}/projects/{project-id}/infra/tier-1s/{tier-1-id}/dns-forwarder
|
Perform the specified DNS forwarder action
Perform the specified action for Tier0 DNS forwarder on specified enforcement point.
|
POST /policy/api/v1/infra/tier-1s/{tier-1-id}/dns-forwarder
POST /policy/api/v1/global-infra/tier-1s/{tier-1-id}/dns-forwarder
POST /policy/api/v1/orgs/{org-id}/projects/{project-id}/infra/tier-1s/{tier-1-id}/dns-forwarder
|
Create or update the DNS Forwarder
Create or update the DNS Forwarder
|
PUT /policy/api/v1/infra/tier-1s/{tier-1-id}/dns-forwarder
PUT /policy/api/v1/orgs/{org-id}/projects/{project-id}/infra/tier-1s/{tier-1-id}/dns-forwarder
|
Resolve a given address via the dns forwarder at Tier1
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.
|
GET /policy/api/v1/infra/tier-1s/{tier-1-id}/dns-forwarder/nslookup
GET /policy/api/v1/global-infra/tier-1s/{tier-1-id}/dns-forwarder/nslookup
GET /policy/api/v1/orgs/{org-id}/projects/{project-id}/infra/tier-1s/{tier-1-id}/dns-forwarder/nslookup
|
Get tier-1 DNS forwarder statistics
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.
|
GET /policy/api/v1/infra/tier-1s/{tier-1-id}/dns-forwarder/statistics
GET /policy/api/v1/global-infra/tier-1s/{tier-1-id}/dns-forwarder/statistics
GET /policy/api/v1/orgs/{org-id}/projects/{project-id}/infra/tier-1s/{tier-1-id}/dns-forwarder/statistics
|
Get current status of tier-1 DNS forwarder
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.
|
GET /policy/api/v1/infra/tier-1s/{tier-1-id}/dns-forwarder/status
GET /policy/api/v1/global-infra/tier-1s/{tier-1-id}/dns-forwarder/status
GET /policy/api/v1/orgs/{org-id}/projects/{project-id}/infra/tier-1s/{tier-1-id}/dns-forwarder/status
|
Get forwarding table from tier-1 in CSV format
Get forwarding table from tier-1 gateway in CSV format.
|
GET /policy/api/v1/infra/tier-1s/{tier-1-id}/forwarding-table?format=csv
GET /policy/api/v1/global-infra/tier-1s/{tier-1-id}/forwarding-table?format=csv
GET /policy/api/v1/orgs/{org-id}/projects/{project-id}/infra/tier-1s/{tier-1-id}/forwarding-table?format=csv
|
Get forwarding table from tier-1
Get forwarding table from tier-1
|
GET /policy/api/v1/infra/tier-1s/{tier-1-id}/forwarding-table
GET /policy/api/v1/global-infra/tier-1s/{tier-1-id}/forwarding-table
GET /policy/api/v1/orgs/{org-id}/projects/{project-id}/infra/tier-1s/{tier-1-id}/forwarding-table
|
Get IPSec VPN service list result
Get paginated list of all IPSec VPN services
under Tier-1.
|
GET /policy/api/v1/infra/tier-1s/{tier-1-id}/ipsec-vpn-services
|
Delete IPSec VPN service
Delete given IPSec VPN service under Tier-1.
|
DELETE /policy/api/v1/infra/tier-1s/{tier-1-id}/ipsec-vpn-services/{service-id}
|
Get IPSec VPN service
Get given IPSec VPN service under Tier-1.
|
GET /policy/api/v1/infra/tier-1s/{tier-1-id}/ipsec-vpn-services/{service-id}
|
Create or patch IPSec VPN service
Create or patch IPSec VPN service under Tier-1.
|
PATCH /policy/api/v1/infra/tier-1s/{tier-1-id}/ipsec-vpn-services/{service-id}
|
Create or fully replace IPSec VPN service
Create or fully replace IPSec VPN service under Tier-1.
Revision is optional for creation and required for update.
|
PUT /policy/api/v1/infra/tier-1s/{tier-1-id}/ipsec-vpn-services/{service-id}
|
Get IPSec VPN local endpoint list result
Get paginated list of all IPSec VPN local endpoints
for a given ipsec vpn service under Tier-1.
|
GET /policy/api/v1/infra/tier-1s/{tier-1-id}/ipsec-vpn-services/{service-id}/local-endpoints
|
Delete IPSec VPN local endpoint
Delete IPSec VPN local endpoint for a ipsec vpn
service under Tier-1.
|
DELETE /policy/api/v1/infra/tier-1s/{tier-1-id}/ipsec-vpn-services/{service-id}/local-endpoints/{local-endpoint-id}
|
Get IPSec VPN local endpoint
Get IPSec VPN local endpoint for a ipsec vpn
service under Tier-1.
|
GET /policy/api/v1/infra/tier-1s/{tier-1-id}/ipsec-vpn-services/{service-id}/local-endpoints/{local-endpoint-id}
|
Create or patch a custom IPSec VPN local endpoint
Create or patch a custom IPSec VPN local endpoint for a given ipsec vpn service under Tier-1.
|
PATCH /policy/api/v1/infra/tier-1s/{tier-1-id}/ipsec-vpn-services/{service-id}/local-endpoints/{local-endpoint-id}
|
Create or fully replace IPSec VPN local endpoint
Create or fully replace IPSec VPN local endpoint
for a given ipsec vpn service under Tier-1.
Revision is optional for creation and required for update.
|
PUT /policy/api/v1/infra/tier-1s/{tier-1-id}/ipsec-vpn-services/{service-id}/local-endpoints/{local-endpoint-id}
|
Get IPSec VPN sessions list result
Get paginated list of all IPSec VPN sessions for a given ipsec vpn
service under Tier-1.
|
GET /policy/api/v1/infra/tier-1s/{tier-1-id}/ipsec-vpn-services/{service-id}/sessions
|
Delete IPSec VPN session
Delete IPSec VPN session for a given ipsec-vpn service under Tier-1.
|
DELETE /policy/api/v1/infra/tier-1s/{tier-1-id}/ipsec-vpn-services/{service-id}/sessions/{session-id}
|
Get IPSec VPN Session
Get IPSec VPN session without sensitive data for a ipsec vpn
service under Tier-1.
|
GET /policy/api/v1/infra/tier-1s/{tier-1-id}/ipsec-vpn-services/{service-id}/sessions/{session-id}
|
Get IPSec VPN Session
Get IPSec VPN session with senstive data for a ipsec vpn
service under Tier-1.
|
GET /policy/api/v1/infra/tier-1s/{tier-1-id}/ipsec-vpn-services/{service-id}/sessions/{session-id}?action=show_sensitive_data
|
Create or patch an IPSec VPN session
Create or patch an IPSec VPN session for a ipsec vpn
service under Tier-1.
|
PATCH /policy/api/v1/infra/tier-1s/{tier-1-id}/ipsec-vpn-services/{service-id}/sessions/{session-id}
|
Create or fully replace IPSec VPN session
Create or fully replace IPSec VPN session for a ipsec vpn
service under Tier-1.
Revision is optional for creation and required for update.
|
PUT /policy/api/v1/infra/tier-1s/{tier-1-id}/ipsec-vpn-services/{service-id}/sessions/{session-id}
|
Get IPSec VPN session detailed status under Tier-1
- no enforcement point path specified: detailed status is evaluated on each enforcement point.
- an enforcement point path is specified: detailed status is evaluated only on the given
enforcement point.
- source=realtime: detailed status is fetched realtime from the enforcement point.
- source=cached: cached detailed status from enforcement point is returned.
|
GET /policy/api/v1/infra/tier-1s/{tier-1-id}/ipsec-vpn-services/{service-id}/sessions/{session-id}/detailed-status
|
Get IPSec VPN configuration for the peer site
Download IPSec VPN configuration for the peer site. Peer config also
contains PSK; be careful when sharing or storing it.
|
GET /policy/api/v1/infra/tier-1s/{tier-1-id}/ipsec-vpn-services/{service-id}/sessions/{session-id}/peer-config
|
Get IPSec VPN session statistics under Tier-1
- no enforcement point path specified: statistics are evaluated on each enforcement point.
- an enforcement point path is specified: statistics are evaluated only on the given
enforcement point.
- source=realtime: statistics are fetched realtime from the enforcement point.
- source=cached: cached statistics from enforcement point are returned.
Please note that cache synchronization is based on triggering this API with
source=realtime or empty source and not polling based.
|
GET /policy/api/v1/infra/tier-1s/{tier-1-id}/ipsec-vpn-services/{service-id}/sessions/{session-id}/statistics
|
Reset the statistics of the given VPN session
Resets the statistics of the given VPN session.
Since source of data is enforcement point, data is
reset there.
|
POST /policy/api/v1/infra/tier-1s/{tier-1-id}/ipsec-vpn-services/{service-id}/sessions/{session-id}/statistics
POST /policy/api/v1/global-infra/tier-1s/{tier-1-id}/ipsec-vpn-services/{service-id}/sessions/{session-id}/statistics
|
Get IPSec VPN Session Summary
Summarized view of all tier-1 IPSec VPN sessions for a specified service.
|
GET /policy/api/v1/infra/tier-1s/{tier-1-id}/ipsec-vpn-services/{service-id}/summary
|
Get L2VPN service list result under Tier-1
Get paginated list of all L2VPN services under Tier-1.
|
GET /policy/api/v1/infra/tier-1s/{tier-1-id}/l2vpn-services
|
Delete L2VPN service under Tier-1
Delete L2VPN service for given Tier-1.
|
DELETE /policy/api/v1/infra/tier-1s/{tier-1-id}/l2vpn-services/{service-id}
|
Get L2VPN service under Tier-1
Get L2VPN service for given Tier-1.
|
GET /policy/api/v1/infra/tier-1s/{tier-1-id}/l2vpn-services/{service-id}
|
Create or patch L2VPN service under Tier-1
Create or patch L2VPN service for given Tier-1.
|
PATCH /policy/api/v1/infra/tier-1s/{tier-1-id}/l2vpn-services/{service-id}
|
Create or fully replace L2VPN service under Tier-1
Create or fully replace L2VPN service for given Tier-1. Revision is optional for creation and required for update.
|
PUT /policy/api/v1/infra/tier-1s/{tier-1-id}/l2vpn-services/{service-id}
|
Get L2VPN sessions list result under Tier-1
Get paginated list of all L2VPN sessions under Tier-1.
|
GET /policy/api/v1/infra/tier-1s/{tier-1-id}/l2vpn-services/{service-id}/sessions
|
Delete L2VPN session under Tier-1
Delete L2VPN session under Tier-1. When L2VPN Service is in CLIENT Mode, the L2VPN Session is deleted along with its transpot tunnels and related resources.
|
DELETE /policy/api/v1/infra/tier-1s/{tier-1-id}/l2vpn-services/{service-id}/sessions/{session-id}
|
Get L2VPN Session under Tier-1
Get L2VPN session under Tier-1.
|
GET /policy/api/v1/infra/tier-1s/{tier-1-id}/l2vpn-services/{service-id}/sessions/{session-id}
|
Create or patch an L2VPN session under Tier-1
Create or patch an L2VPN session under Tier-1. API supported
only when L2VPN Service is in Server Mode.
|
PATCH /policy/api/v1/infra/tier-1s/{tier-1-id}/l2vpn-services/{service-id}/sessions/{session-id}
|
Create or patch an L2VPN session under Tier-1 from Peer Codes
Create or patch an L2VPN session under Tier-1 from Peer Codes.
In addition to the L2VPN Session, the IPSec VPN Session, along
with the IKE, Tunnel, and DPD Profiles are created and owned by
the system. IPSec VPN Service and Local Endpoint are created only
when required, i.e., an IPSec VPN Service does not already exist,
or an IPSec VPN Local Endpoint with same local address does not
already exist.
Updating the L2VPN Session can be performed only through this API
by specifying new peer codes. Use of specific APIs to update the
L2VPN Session and the different resources associated with it is
not allowed, except for IPSec VPN Service and Local Endpoint,
resources that are not system owned.
API supported only when L2VPN Service is in Client Mode.
|
POST /policy/api/v1/infra/tier-1s/{tier-1-id}/l2vpn-services/{service-id}/sessions/{session-id}?action=create_with_peer_code
|
Create or fully replace L2VPN session under Tier-1
Create or fully replace L2VPN session under Tier-1. API supported
only when L2VPN Service is in Server Mode.
Revision is optional for creation and required for update.
|
PUT /policy/api/v1/infra/tier-1s/{tier-1-id}/l2vpn-services/{service-id}/sessions/{session-id}
|
Get L2VPN session detailed status under Tier-1
- no enforcement point path specified: detailed tatus is evaluated on each enforcement point.
- an enforcement point path is specified: detailed status is evaluated only on the given
enforcement point.
- source=realtime: detailed tatus is fetched realtime from the enforcement point.
- source=cached: cached detailed status is returned.
|
GET /policy/api/v1/infra/tier-1s/{tier-1-id}/l2vpn-services/{service-id}/sessions/{session-id}/detailed-status
|
Get Tier-1 L2VPN session configuration for the peer site
Get peer config for the Tier-1 L2VPN session to configure the remote
side of the tunnel.
- no enforcement point path specified: L2VPN Session Peer Codes
will be evaluated on each enforcement point.
- enforcement point paths specified: L2VPN Session Peer Codes
are evaluated only on the given enforcement points.
API supported only when L2VPN Service is in Server Mode.
|
GET /policy/api/v1/infra/tier-1s/{tier-1-id}/l2vpn-services/{service-id}/sessions/{session-id}/peer-config
|
Get L2Vpn session remote mac for logical switch
Returns L2Vpn session remote macs for a logical switch.
Data is fetched from enforcement point.
|
GET /policy/api/v1/infra/tier-1s/{tier-1-id}/l2vpn-services/{service-id}/sessions/{session-id}/remote-mac
|
Get L2VPN session statistics under Tier-1
- no enforcement point path specified: statistics are evaluated on each enforcement point.
- an enforcement point path is specified: statistics are evaluated only on the given
enforcement point.
- source=realtime: statistics are fetched realtime from the enforcement point.
- source=cached: cached statistics from the enforcement point are returned.
|
GET /policy/api/v1/infra/tier-1s/{tier-1-id}/l2vpn-services/{service-id}/sessions/{session-id}/statistics
|
List Tier-1 locale-services
Paginated list of all Tier-1 locale-services
|
GET /policy/api/v1/infra/tier-1s/{tier-1-id}/locale-services
GET /policy/api/v1/global-infra/tier-1s/{tier-1-id}/locale-services
GET /policy/api/v1/orgs/{org-id}/projects/{project-id}/infra/tier-1s/{tier-1-id}/locale-services
|
Get Tier-1 Address Resolution Protocol Proxies
Get Tier-1 Address Resolution Protocol Proxies.
|
GET /policy/api/v1/infra/tier-1s/{tier-1-id}/locale-services/{locale-service-id}/arp-proxies
(Deprecated)
GET /policy/api/v1/global-infra/tier-1s/{tier-1-id}/locale-services/{locale-service-id}/arp-proxies
(Deprecated)
GET /policy/api/v1/orgs/{org-id}/projects/{project-id}/infra/tier-1s/{tier-1-id}/locale-services/{locale-service-id}/arp-proxies
(Deprecated)
|
List Tier-1 Interface groups
Paginated list of all Tier-1 Interface groups under locale service.
|
GET /policy/api/v1/infra/tier-1s/{tier-1-id}/locale-services/{locale-service-id}/interface-groups
GET /policy/api/v1/orgs/{org-id}/projects/{project-id}/infra/tier-1s/{tier-1-id}/locale-services/{locale-service-id}/interface-groups
|
Delete Tier-1 Interface group
Delete Tier-1 Interface group
|
DELETE /policy/api/v1/infra/tier-1s/{tier-1-id}/locale-services/{locale-service-id}/interface-groups/{group-id}
DELETE /policy/api/v1/orgs/{org-id}/projects/{project-id}/infra/tier-1s/{tier-1-id}/locale-services/{locale-service-id}/interface-groups/{group-id}
|
Read Tier-1 Interface group
Read Tier-1 Interface group
|
GET /policy/api/v1/infra/tier-1s/{tier-1-id}/locale-services/{locale-service-id}/interface-groups/{group-id}
GET /policy/api/v1/orgs/{org-id}/projects/{project-id}/infra/tier-1s/{tier-1-id}/locale-services/{locale-service-id}/interface-groups/{group-id}
|
Create or update a Tier-1 Interface group.
If an Interface group with the label-id is not already present, create a new
Interface group. If it already exists, update the Interface group for specified attributes.
|
PATCH /policy/api/v1/infra/tier-1s/{tier-1-id}/locale-services/{locale-service-id}/interface-groups/{group-id}
PATCH /policy/api/v1/orgs/{org-id}/projects/{project-id}/infra/tier-1s/{tier-1-id}/locale-services/{locale-service-id}/interface-groups/{group-id}
|
Update a Tier-1 Interface group.
Update the Interface group for specified attributes.
|
PUT /policy/api/v1/infra/tier-1s/{tier-1-id}/locale-services/{locale-service-id}/interface-groups/{group-id}
PUT /policy/api/v1/orgs/{org-id}/projects/{project-id}/infra/tier-1s/{tier-1-id}/locale-services/{locale-service-id}/interface-groups/{group-id}
|
Get tier-1 interface group statistics information
Get tier-1 interface group statistics information.
|
GET /policy/api/v1/infra/tier-1s/{tier-1-id}/locale-services/{locale-service-id}/interface-groups/{interface-group-id}/statistics
GET /policy/api/v1/global-infra/tier-1s/{tier-1-id}/locale-services/{locale-service-id}/interface-groups/{interface-group-id}/statistics
GET /policy/api/v1/orgs/{org-id}/projects/{project-id}/infra/tier-1s/{tier-1-id}/locale-services/{locale-service-id}/interface-groups/{interface-group-id}/statistics
|
Get Tier-1 Interface Address Resolution Protocol Proxies in CSV format
Returns ARP proxy table for a tier-1 interface in CSV format
|
GET /policy/api/v1/infra/tier-1s/{tier-1-id}/locale-services/{locale-service-id}/interfaces/{interface-id}/arp-proxy?format=csv
GET /policy/api/v1/global-infra/tier-1s/{tier-1-id}/locale-services/{locale-service-id}/interfaces/{interface-id}/arp-proxy?format=csv
GET /policy/api/v1/orgs/{org-id}/projects/{project-id}/infra/tier-1s/{tier-1-id}/locale-services/{locale-service-id}/interfaces/{interface-id}/arp-proxy?format=csv
|
Get Tier-1 Interface Address Resolution Protocol Proxies
Returns ARP proxy table for a tier-1 interface
|
GET /policy/api/v1/infra/tier-1s/{tier-1-id}/locale-services/{locale-service-id}/interfaces/{interface-id}/arp-proxy
GET /policy/api/v1/global-infra/tier-1s/{tier-1-id}/locale-services/{locale-service-id}/interfaces/{interface-id}/arp-proxy
GET /policy/api/v1/orgs/{org-id}/projects/{project-id}/infra/tier-1s/{tier-1-id}/locale-services/{locale-service-id}/interfaces/{interface-id}/arp-proxy
|
Get ARP table from tier-1 interface
Returns ARP table (IPv4) or Neighbor Discovery table (IPv6) for the
tier-1 interface, on a edge node specified in edge_path parameter.
The edge_path parameter is mandatory.
|
GET /policy/api/v1/infra/tier-1s/{tier-1-id}/locale-services/{locale-service-id}/interfaces/{interface-id}/arp-table
GET /policy/api/v1/global-infra/tier-1s/{tier-1-id}/locale-services/{locale-service-id}/interfaces/{interface-id}/arp-table
GET /policy/api/v1/orgs/{org-id}/projects/{project-id}/infra/tier-1s/{tier-1-id}/locale-services/{locale-service-id}/interfaces/{interface-id}/arp-table
|
Get ARP table from tier-1 interface in CSV format
Returns ARP table (IPv4) or Neighbor Discovery table (IPv6) in CSV format
for the tier-1 interface, on a edge node specified in edge_path parameter.
The edge_path parameter is mandatory.
|
GET /policy/api/v1/infra/tier-1s/{tier-1-id}/locale-services/{locale-service-id}/interfaces/{interface-id}/arp-table?format=csv
GET /policy/api/v1/global-infra/tier-1s/{tier-1-id}/locale-services/{locale-service-id}/interfaces/{interface-id}/arp-table?format=csv
GET /policy/api/v1/orgs/{org-id}/projects/{project-id}/infra/tier-1s/{tier-1-id}/locale-services/{locale-service-id}/interfaces/{interface-id}/arp-table?format=csv
|
Get DAD status by interface
Get tier-1 interface DAD state information.
|
GET /policy/api/v1/infra/tier-1s/{tier-1-id}/locale-services/{locale-service-id}/interfaces/{interface-id}/dad-state
GET /policy/api/v1/global-infra/tier-1s/{tier-1-id}/locale-services/{locale-service-id}/interfaces/{interface-id}/dad-state
GET /policy/api/v1/orgs/{org-id}/projects/{project-id}/infra/tier-1s/{tier-1-id}/locale-services/{locale-service-id}/interfaces/{interface-id}/dad-state
|
Get tier-1 interface statistics information
Get tier-1 interface statistics information.
|
GET /policy/api/v1/infra/tier-1s/{tier-1-id}/locale-services/{locale-service-id}/interfaces/{interface-id}/statistics
GET /policy/api/v1/global-infra/tier-1s/{tier-1-id}/locale-services/{locale-service-id}/interfaces/{interface-id}/statistics
GET /policy/api/v1/orgs/{org-id}/projects/{project-id}/infra/tier-1s/{tier-1-id}/locale-services/{locale-service-id}/interfaces/{interface-id}/statistics
|
Get tier-1 interface statistics summary information
Get tier-1 interface statistics information.
|
GET /policy/api/v1/infra/tier-1s/{tier-1-id}/locale-services/{locale-service-id}/interfaces/{interface-id}/statistics/summary
GET /policy/api/v1/global-infra/tier-1s/{tier-1-id}/locale-services/{locale-service-id}/interfaces/{interface-id}/statistics/summary
GET /policy/api/v1/orgs/{org-id}/projects/{project-id}/infra/tier-1s/{tier-1-id}/locale-services/{locale-service-id}/interfaces/{interface-id}/statistics/summary
|
Get IPSec VPN service list result
Get paginated list of all IPSec VPN services
for a given locale service under Tier-1.
|
GET /policy/api/v1/infra/tier-1s/{tier-1-id}/locale-services/{locale-service-id}/ipsec-vpn-services
(Deprecated)
|
Delete IPSec VPN service
Delete IPSec VPN service for a given locale service under Tier-1.
|
DELETE /policy/api/v1/infra/tier-1s/{tier-1-id}/locale-services/{locale-service-id}/ipsec-vpn-services/{service-id}
(Deprecated)
|
Get IPSec VPN service
Get IPSec VPN service for a given locale
service under Tier-1.
|
GET /policy/api/v1/infra/tier-1s/{tier-1-id}/locale-services/{locale-service-id}/ipsec-vpn-services/{service-id}
(Deprecated)
|
Create or patch IPSec VPN service
Create or patch IPSec VPN service for a given locale
service under Tier-1.
|
PATCH /policy/api/v1/infra/tier-1s/{tier-1-id}/locale-services/{locale-service-id}/ipsec-vpn-services/{service-id}
(Deprecated)
|
Create or fully replace IPSec 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.
|
PUT /policy/api/v1/infra/tier-1s/{tier-1-id}/locale-services/{locale-service-id}/ipsec-vpn-services/{service-id}
(Deprecated)
|
Get IPSec VPN local endpoint list result
Get paginated list of all IPSec VPN local endpoints
for a given locale service under Tier-1.
|
GET /policy/api/v1/infra/tier-1s/{tier-1-id}/locale-services/{locale-service-id}/ipsec-vpn-services/{service-id}/local-endpoints
(Deprecated)
|
Delete IPSec VPN local endpoint
Delete IPSec VPN local endpoint for a given locale
service under Tier-1.
|
DELETE /policy/api/v1/infra/tier-1s/{tier-1-id}/locale-services/{locale-service-id}/ipsec-vpn-services/{service-id}/local-endpoints/{local-endpoint-id}
(Deprecated)
|
Get IPSec VPN local endpoint
Get IPSec VPN local endpoint for a given locale
service under Tier-1.
|
GET /policy/api/v1/infra/tier-1s/{tier-1-id}/locale-services/{locale-service-id}/ipsec-vpn-services/{service-id}/local-endpoints/{local-endpoint-id}
(Deprecated)
|
Create or patch a custom IPSec VPN local endpoint
Create or patch a custom IPSec VPN local endpoint for a given locale service under Tier-1.
|
PATCH /policy/api/v1/infra/tier-1s/{tier-1-id}/locale-services/{locale-service-id}/ipsec-vpn-services/{service-id}/local-endpoints/{local-endpoint-id}
(Deprecated)
|
Create or fully replace IPSec VPN local endpoint
Create or fully replace IPSec VPN local endpoint
for a given locale service under Tier-1.
Revision is optional for creation and required for update.
|
PUT /policy/api/v1/infra/tier-1s/{tier-1-id}/locale-services/{locale-service-id}/ipsec-vpn-services/{service-id}/local-endpoints/{local-endpoint-id}
(Deprecated)
|
Get IPSec VPN sessions list result
Get paginated list of all IPSec VPN sessions for a given locale
service under Tier-1.
|
GET /policy/api/v1/infra/tier-1s/{tier-1-id}/locale-services/{locale-service-id}/ipsec-vpn-services/{service-id}/sessions
(Deprecated)
|
Delete IPSec VPN session
Delete IPSec VPN session for a given locale service under Tier-1.
|
DELETE /policy/api/v1/infra/tier-1s/{tier-1-id}/locale-services/{locale-service-id}/ipsec-vpn-services/{service-id}/sessions/{session-id}
(Deprecated)
|
Get IPSec VPN Session
Get IPSec VPN session with senstive data for a given locale
service under Tier-1.
|
GET /policy/api/v1/infra/tier-1s/{tier-1-id}/locale-services/{locale-service-id}/ipsec-vpn-services/{service-id}/sessions/{session-id}?action=show_sensitive_data
(Deprecated)
|
Get IPSec VPN Session
Get IPSec VPN session without sensitive data for a given locale
service under Tier-1.
|
GET /policy/api/v1/infra/tier-1s/{tier-1-id}/locale-services/{locale-service-id}/ipsec-vpn-services/{service-id}/sessions/{session-id}
(Deprecated)
|
Create or patch an IPSec VPN session
Create or patch an IPSec VPN session for a given locale
service under Tier-1.
|
PATCH /policy/api/v1/infra/tier-1s/{tier-1-id}/locale-services/{locale-service-id}/ipsec-vpn-services/{service-id}/sessions/{session-id}
(Deprecated)
|
Create or fully replace IPSec VPN session
Create or fully replace IPSec VPN session for a given locale
service under Tier-1.
Revision is optional for creation and required for update.
|
PUT /policy/api/v1/infra/tier-1s/{tier-1-id}/locale-services/{locale-service-id}/ipsec-vpn-services/{service-id}/sessions/{session-id}
(Deprecated)
|
Get IPSec VPN session detailed status under Tier-1
- no enforcement point path specified: detailed status is evaluated on each enforcement point.
- an enforcement point path is specified: detailed status is evaluated only on the given
enforcement point.
- source=realtime: detailed status is fetched realtime from the enforcement point.
- source=cached: cached detailed status from enforcement point is returned.
|
GET /policy/api/v1/infra/tier-1s/{tier-1-id}/locale-services/{locale-service-id}/ipsec-vpn-services/{service-id}/sessions/{session-id}/detailed-status
(Deprecated)
GET /policy/api/v1/orgs/{org-id}/projects/{project-id}/infra/tier-1s/{tier-1-id}/locale-services/{locale-service-id}/ipsec-vpn-services/{service-id}/sessions/{session-id}/detailed-status
(Deprecated)
|
Get IPSec VPN configuration for the peer site
Download IPSec VPN configuration for the peer site. Peer config also
contains PSK; be careful when sharing or storing it.
|
GET /policy/api/v1/infra/tier-1s/{tier-1-id}/locale-services/{locale-service-id}/ipsec-vpn-services/{service-id}/sessions/{session-id}/peer-config
(Deprecated)
|
Get IPSec VPN session statistics under Tier-1
- no enforcement point path specified: statistics are evaluated on each enforcement point.
- an enforcement point path is specified: statistics are evaluated only on the given
enforcement point.
- source=realtime: statistics are fetched realtime from the enforcement point.
- source=cached: cached statistics from enforcement point are returned.
|
GET /policy/api/v1/infra/tier-1s/{tier-1-id}/locale-services/{locale-service-id}/ipsec-vpn-services/{service-id}/sessions/{session-id}/statistics
(Deprecated)
GET /policy/api/v1/orgs/{org-id}/projects/{project-id}/infra/tier-1s/{tier-1-id}/locale-services/{locale-service-id}/ipsec-vpn-services/{service-id}/sessions/{session-id}/statistics
(Deprecated)
|
Reset the statistics of the given VPN session
Resets the statistics of the given VPN session.
Since source of data is enforcement point, data is
reset there.
|
POST /policy/api/v1/infra/tier-1s/{tier-1-id}/locale-services/{locale-service-id}/ipsec-vpn-services/{service-id}/sessions/{session-id}/statistics
(Deprecated)
POST /policy/api/v1/orgs/{org-id}/projects/{project-id}/infra/tier-1s/{tier-1-id}/locale-services/{locale-service-id}/ipsec-vpn-services/{service-id}/sessions/{session-id}/statistics
(Deprecated)
|
Get IPSec VPN Session Summary
Summarized view of all tier-1 IPSec VPN sessions for a specified service.
|
GET /policy/api/v1/infra/tier-1s/{tier-1-id}/locale-services/{locale-service-id}/ipsec-vpn-services/{service-id}/summary
(Deprecated)
GET /policy/api/v1/orgs/{org-id}/projects/{project-id}/infra/tier-1s/{tier-1-id}/locale-services/{locale-service-id}/ipsec-vpn-services/{service-id}/summary
(Deprecated)
|
Get L2VPN service list result under Tier-1
Get paginated list of all L2VPN services under Tier-1.
|
GET /policy/api/v1/infra/tier-1s/{tier-1-id}/locale-services/{locale-service-id}/l2vpn-services
(Deprecated)
|
Delete L2VPN service under Tier-1
Delete L2VPN service for given Tier-1 locale service.
|
DELETE /policy/api/v1/infra/tier-1s/{tier-1-id}/locale-services/{locale-service-id}/l2vpn-services/{service-id}
(Deprecated)
|
Get L2VPN service under Tier-1
Get L2VPN service for given Tier-1 locale service.
|
GET /policy/api/v1/infra/tier-1s/{tier-1-id}/locale-services/{locale-service-id}/l2vpn-services/{service-id}
(Deprecated)
|
Create or patch L2VPN service under Tier-1
Create or patch L2VPN service for given Tier-1 locale service.
|
PATCH /policy/api/v1/infra/tier-1s/{tier-1-id}/locale-services/{locale-service-id}/l2vpn-services/{service-id}
(Deprecated)
|
Create or fully replace L2VPN service under Tier-1
Create or fully replace L2VPN service for given Tier-1 locale service.
Revision is optional for creation and required for update.
|
PUT /policy/api/v1/infra/tier-1s/{tier-1-id}/locale-services/{locale-service-id}/l2vpn-services/{service-id}
(Deprecated)
|
Get L2VPN sessions list result under Tier-1
Get paginated list of all L2VPN sessions under Tier-1.
|
GET /policy/api/v1/infra/tier-1s/{tier-1-id}/locale-services/{locale-service-id}/l2vpn-services/{service-id}/sessions
(Deprecated)
|
Delete L2VPN session under Tier-1
Delete L2VPN session under Tier-1. When L2VPN Service is
in CLIENT Mode, the L2VPN Session is deleted along with its transpot
tunnels and related resources.
|
DELETE /policy/api/v1/infra/tier-1s/{tier-1-id}/locale-services/{locale-service-id}/l2vpn-services/{service-id}/sessions/{session-id}
(Deprecated)
|
Get L2VPN Session under Tier-1
Get L2VPN session under Tier-1.
|
GET /policy/api/v1/infra/tier-1s/{tier-1-id}/locale-services/{locale-service-id}/l2vpn-services/{service-id}/sessions/{session-id}
(Deprecated)
|
Create or patch an L2VPN session under Tier-1
Create or patch an L2VPN session under Tier-1. API supported
only when L2VPN Service is in Server Mode.
|
PATCH /policy/api/v1/infra/tier-1s/{tier-1-id}/locale-services/{locale-service-id}/l2vpn-services/{service-id}/sessions/{session-id}
(Deprecated)
|
Create or patch an L2VPN session under Tier-1 from Peer Codes
Create or patch an L2VPN session under Tier-1 from Peer Codes.
In addition to the L2VPN Session, the IPSec VPN Session, along
with the IKE, Tunnel, and DPD Profiles are created and owned by
the system. IPSec VPN Service and Local Endpoint are created only
when required, i.e., an IPSec VPN Service does not already exist,
or an IPSec VPN Local Endpoint with same local address does not
already exist.
Updating the L2VPN Session can be performed only through this API
by specifying new peer codes. Use of specific APIs to update the
L2VPN Session and the different resources associated with it is
not allowed, except for IPSec VPN Service and Local Endpoint,
resources that are not system owned.
API supported only when L2VPN Service is in Client Mode.
|
POST /policy/api/v1/infra/tier-1s/{tier-1-id}/locale-services/{locale-service-id}/l2vpn-services/{service-id}/sessions/{session-id}?action=create_with_peer_code
(Deprecated)
|
Create or fully replace L2VPN session under Tier-1
Create or fully replace L2VPN session under Tier-1. API supported
only when L2VPN Service is in Server Mode.
Revision is optional for creation and required for update.
|
PUT /policy/api/v1/infra/tier-1s/{tier-1-id}/locale-services/{locale-service-id}/l2vpn-services/{service-id}/sessions/{session-id}
(Deprecated)
|
Get L2VPN session detailed status under Tier-1
- no enforcement point path specified: detailed tatus is evaluated on each enforcement point.
- an enforcement point path is specified: detailed status is evaluated only on the given
enforcement point.
- source=realtime: detailed tatus is fetched realtime from the enforcement point.
- source=cached: cached detailed status is returned.
sessions/<session-id>/detailed-status instead.
|
GET /policy/api/v1/infra/tier-1s/{tier-1-id}/locale-services/{locale-service-id}/l2vpn-services/{service-id}/sessions/{session-id}/detailed-status
(Deprecated)
|
Get Tier-1 L2VPN session configuration for the peer site
Get peer config for the Tier-1 L2VPN session to configure the remote
side of the tunnel.
- no enforcement point path specified: L2VPN Session Peer Codes
will be evaluated on each enforcement point.
- enforcement point paths specified: L2VPN Session Peer Codes
are evaluated only on the given enforcement points.
API supported only when L2VPN Service is in Server Mode.
|
GET /policy/api/v1/infra/tier-1s/{tier-1-id}/locale-services/{locale-service-id}/l2vpn-services/{service-id}/sessions/{session-id}/peer-config
(Deprecated)
|
Get L2Vpn session remote mac for logical switch
Returns L2Vpn session remote macs for a logical switch.
Data is fetched from enforcement point.
|
GET /policy/api/v1/infra/tier-1s/{tier-1-id}/locale-services/{locale-service-id}/l2vpn-services/{service-id}/sessions/{session-id}/remote-mac
(Deprecated)
|
Get L2VPN session statistics under Tier-1
- no enforcement point path specified: statistics are evaluated on each enforcement point.
- an enforcement point path is specified: statistics are evaluated only on the given
enforcement point.
- source=realtime: statistics are fetched realtime from the enforcement point.
- source=cached: cached statistics from the enforcement point are returned.
|
GET /policy/api/v1/infra/tier-1s/{tier-1-id}/locale-services/{locale-service-id}/l2vpn-services/{service-id}/sessions/{session-id}/statistics
(Deprecated)
|
List Tier 1 Service Interfaces
Paginated list of all Tier 1 Service Interfaces
|
GET /policy/api/v1/infra/tier-1s/{tier-1-id}/locale-services/{locale-service-id}/service-interfaces
GET /policy/api/v1/global-infra/tier-1s/{tier-1-id}/locale-services/{locale-service-id}/service-interfaces
GET /policy/api/v1/orgs/{org-id}/projects/{project-id}/infra/tier-1s/{tier-1-id}/locale-services/{locale-service-id}/service-interfaces
|
Delete Tier 1 service interface
Delete Tier 1 service interface
|
DELETE /policy/api/v1/infra/tier-1s/{tier-1-id}/locale-services/{locale-service-id}/service-interfaces/{interface-id}
DELETE /policy/api/v1/orgs/{org-id}/projects/{project-id}/infra/tier-1s/{tier-1-id}/locale-services/{locale-service-id}/service-interfaces/{interface-id}
|
Read Tier 1 service interface
Read Tier 1 service interface
|
GET /policy/api/v1/infra/tier-1s/{tier-1-id}/locale-services/{locale-service-id}/service-interfaces/{interface-id}
GET /policy/api/v1/global-infra/tier-1s/{tier-1-id}/locale-services/{locale-service-id}/service-interfaces/{interface-id}
GET /policy/api/v1/orgs/{org-id}/projects/{project-id}/infra/tier-1s/{tier-1-id}/locale-services/{locale-service-id}/service-interfaces/{interface-id}
|
Create or update a Tier-1 service interface
If a Tier1 service interface with the interface-id is not already present, create a new Tier1 service
interface.
|
PATCH /policy/api/v1/infra/tier-1s/{tier-1-id}/locale-services/{locale-service-id}/service-interfaces/{interface-id}
PATCH /policy/api/v1/orgs/{org-id}/projects/{project-id}/infra/tier-1s/{tier-1-id}/locale-services/{locale-service-id}/service-interfaces/{interface-id}
|
Create a Tier1 service interface
If a Tier1 service interface with the interface-id is not already present, create a new Tier1 service
interface. Modification of Tier 1 service interface is not allowed.
|
PUT /policy/api/v1/infra/tier-1s/{tier-1-id}/locale-services/{locale-service-id}/service-interfaces/{interface-id}
PUT /policy/api/v1/orgs/{org-id}/projects/{project-id}/infra/tier-1s/{tier-1-id}/locale-services/{locale-service-id}/service-interfaces/{interface-id}
|
Delete Tier-1 locale-services
Delete Tier-1 locale-services
|
DELETE /policy/api/v1/infra/tier-1s/{tier-1-id}/locale-services/{locale-services-id}
DELETE /policy/api/v1/orgs/{org-id}/projects/{project-id}/infra/tier-1s/{tier-1-id}/locale-services/{locale-services-id}
|
Read Tier-1 locale-services
Read Tier-1 locale-services
|
GET /policy/api/v1/infra/tier-1s/{tier-1-id}/locale-services/{locale-services-id}
GET /policy/api/v1/global-infra/tier-1s/{tier-1-id}/locale-services/{locale-services-id}
GET /policy/api/v1/orgs/{org-id}/projects/{project-id}/infra/tier-1s/{tier-1-id}/locale-services/{locale-services-id}
|
Create or update a Tier-1 locale-services
If a Tier-1 locale services with the locale-services-id is not already
present, create a new locale services. If it already exists, update
Tier-1 locale services with specified attributes.
|
PATCH /policy/api/v1/infra/tier-1s/{tier-1-id}/locale-services/{locale-services-id}
PATCH /policy/api/v1/orgs/{org-id}/projects/{project-id}/infra/tier-1s/{tier-1-id}/locale-services/{locale-services-id}
|
Create or update a Tier-1 locale-services
If a Tier-1 locale services with the locale-services-id is not already
present, create a new locale-services. If it already exists, replace the
Tier-1 locale services instance with the new object.
Modifying edge cluster re-allocates NSX service routers of TIER1 to a different edge
cluster. You can also place edge nodes manually and provide maximum two indices
for HA mode ACTIVE_STANDBY. To re-allocating edge cluster is a disruptive operation
and all existing statistics of Tier1 gateway will be removed.
|
PUT /policy/api/v1/infra/tier-1s/{tier-1-id}/locale-services/{locale-services-id}
PUT /policy/api/v1/orgs/{org-id}/projects/{project-id}/infra/tier-1s/{tier-1-id}/locale-services/{locale-services-id}
|
List Tier-1 interfaces
Paginated list of all Tier-1 interfaces
|
GET /policy/api/v1/infra/tier-1s/{tier-1-id}/locale-services/{locale-services-id}/interfaces
GET /policy/api/v1/global-infra/tier-1s/{tier-1-id}/locale-services/{locale-services-id}/interfaces
GET /policy/api/v1/orgs/{org-id}/projects/{project-id}/infra/tier-1s/{tier-1-id}/locale-services/{locale-services-id}/interfaces
|
Delete Tier-1 interface
Delete Tier-1 interface
|
DELETE /policy/api/v1/infra/tier-1s/{tier-1-id}/locale-services/{locale-services-id}/interfaces/{interface-id}
DELETE /policy/api/v1/orgs/{org-id}/projects/{project-id}/infra/tier-1s/{tier-1-id}/locale-services/{locale-services-id}/interfaces/{interface-id}
|
Read Tier-1 interface
Read Tier-1 interface
|
GET /policy/api/v1/infra/tier-1s/{tier-1-id}/locale-services/{locale-services-id}/interfaces/{interface-id}
GET /policy/api/v1/global-infra/tier-1s/{tier-1-id}/locale-services/{locale-services-id}/interfaces/{interface-id}
GET /policy/api/v1/orgs/{org-id}/projects/{project-id}/infra/tier-1s/{tier-1-id}/locale-services/{locale-services-id}/interfaces/{interface-id}
|
Create or update a Tier-1 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.
|
PATCH /policy/api/v1/infra/tier-1s/{tier-1-id}/locale-services/{locale-services-id}/interfaces/{interface-id}
PATCH /policy/api/v1/orgs/{org-id}/projects/{project-id}/infra/tier-1s/{tier-1-id}/locale-services/{locale-services-id}/interfaces/{interface-id}
|
Create or update a tier-1 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.
|
PUT /policy/api/v1/infra/tier-1s/{tier-1-id}/locale-services/{locale-services-id}/interfaces/{interface-id}
PUT /policy/api/v1/orgs/{org-id}/projects/{project-id}/infra/tier-1s/{tier-1-id}/locale-services/{locale-services-id}/interfaces/{interface-id}
|
Read Multicast Configuration
Read Multicast Configuration.
|
GET /policy/api/v1/infra/tier-1s/{tier-1-id}/locale-services/{locale-services-id}/multicast
|
Create or update multicast configuration
Create or update a Tier-1 multicast configuration defining the multicast replication range.
It will update the configuration if there is already one in place.
|
PATCH /policy/api/v1/infra/tier-1s/{tier-1-id}/locale-services/{locale-services-id}/multicast
|
Create or update multicast configuration
Create or update a Tier-1 multicast configuration defining the multicast replication range.
It will update the configuration if there is already one in place.
|
PUT /policy/api/v1/infra/tier-1s/{tier-1-id}/locale-services/{locale-services-id}/multicast
|
Get Multicast Forwarding In Csv Format
Get Multicast Forwarding In CSV Format.
|
GET /policy/api/v1/infra/tier-1s/{tier-1-id}/locale-services/{locale-services-id}/multicast/forwarding?format=csv
|
Get Multicast Forwarding
Get Multicast Forwarding.
|
GET /policy/api/v1/infra/tier-1s/{tier-1-id}/locale-services/{locale-services-id}/multicast/forwarding
|
Get IGMP Memberships in CSV format
Get Igmp Memberships in CSV format.
|
GET /policy/api/v1/infra/tier-1s/{tier-1-id}/locale-services/{locale-services-id}/multicast/igmp-memberships?format=csv
|
Get IGMP Memberships
Get Igmp Memberships.
|
GET /policy/api/v1/infra/tier-1s/{tier-1-id}/locale-services/{locale-services-id}/multicast/igmp-memberships
|
List Policy NAT types.
List all NAT sections under the given Tier-1 ID.
For more details related to NAT section please refer to PolicyNAT schema.
|
GET /policy/api/v1/infra/tier-1s/{tier-1-id}/nat
GET /policy/api/v1/global-infra/tier-1s/{tier-1-id}/nat
GET /policy/api/v1/orgs/{org-id}/projects/{project-id}/infra/tier-1s/{tier-1-id}/nat
|
List NAT Rules
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.
Note:
IPSecVpnSession as Scope: Please note that old IPSecVpnSession policy path deprecated. If user specifiy old IPSecVpnSession path in the
scope property in the PATCH/PUT PoliycNatRule API, the path returned in the GET response payload will be a new path instead of the deprecated IPSecVpnSession path
Both old and new IPSecVpnSession path refer to same resource. there is no functional impact.
|
GET /policy/api/v1/infra/tier-1s/{tier-1-id}/nat/{nat-id}/nat-rules
GET /policy/api/v1/global-infra/tier-1s/{tier-1-id}/nat/{nat-id}/nat-rules
GET /policy/api/v1/orgs/{org-id}/projects/{project-id}/infra/tier-1s/{tier-1-id}/nat/{nat-id}/nat-rules
|
Delete NAT Rule
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.
|
DELETE /policy/api/v1/infra/tier-1s/{tier-1-id}/nat/{nat-id}/nat-rules/{nat-rule-id}
DELETE /policy/api/v1/orgs/{org-id}/projects/{project-id}/infra/tier-1s/{tier-1-id}/nat/{nat-id}/nat-rules/{nat-rule-id}
|
Get NAT Rule
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.
Note:
IPSecVpnSession as Scope: Please note that old IPSecVpnSession policy path deprecated. If user specifiy old IPSecVpnSession path in the
scope property in the PATCH/PUT PoliycNatRule API, the path returned in the GET response payload will be a new path instead of the deprecated IPSecVpnSession path
Both old and new IPSecVpnSession path refer to same resource. there is no functional impact.
|
GET /policy/api/v1/infra/tier-1s/{tier-1-id}/nat/{nat-id}/nat-rules/{nat-rule-id}
GET /policy/api/v1/global-infra/tier-1s/{tier-1-id}/nat/{nat-id}/nat-rules/{nat-rule-id}
GET /policy/api/v1/orgs/{org-id}/projects/{project-id}/infra/tier-1s/{tier-1-id}/nat/{nat-id}/nat-rules/{nat-rule-id}
|
Create or update a 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.
Note:
IPSecVpnSession as Scope: Please note that old IPSecVpnSession policy path deprecated. If user specifiy old IPSecVpnSession path in the
scope property, the path returned in the GET response payload will be a new path instead of the deprecated IPSecVpnSession path
Both old and new IPSecVpnSession path refer to same resource. there is no functional impact.
|
PATCH /policy/api/v1/infra/tier-1s/{tier-1-id}/nat/{nat-id}/nat-rules/{nat-rule-id}
PATCH /policy/api/v1/orgs/{org-id}/projects/{project-id}/infra/tier-1s/{tier-1-id}/nat/{nat-id}/nat-rules/{nat-rule-id}
|
Create or update NAT Rule
Create or 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.
Note:
IPSecVpnSession as Scope: Please note that old IPSecVpnSession policy path deprecated. If user specifiy old IPSecVpnSession path in the
scope property in the PUT API, the path returned in the GET/PUT response payload will be a new path instead of the deprecated IPSecVpnSession path
Both old and new IPSecVpnSession path refer to same resource. there is no functional impact.
|
PUT /policy/api/v1/infra/tier-1s/{tier-1-id}/nat/{nat-id}/nat-rules/{nat-rule-id}
PUT /policy/api/v1/orgs/{org-id}/projects/{project-id}/infra/tier-1s/{tier-1-id}/nat/{nat-id}/nat-rules/{nat-rule-id}
|
Get NAT Rule Statistics
Get NAT Rule Statistics 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.
|
GET /policy/api/v1/infra/tier-1s/{tier-1-id}/nat/{nat-id}/nat-rules/{nat-rule-id}/statistics
GET /policy/api/v1/global-infra/tier-1s/{tier-1-id}/nat/{nat-id}/nat-rules/{nat-rule-id}/statistics
GET /policy/api/v1/orgs/{org-id}/projects/{project-id}/infra/tier-1s/{tier-1-id}/nat/{nat-id}/nat-rules/{nat-rule-id}/statistics
|
List NAT Rules Statistics
List NAT Rules Statistics from Tier-1 denoted by Tier-1 ID.
|
GET /policy/api/v1/infra/tier-1s/{tier-1-id}/nat/statistics
GET /policy/api/v1/global-infra/tier-1s/{tier-1-id}/nat/statistics
GET /policy/api/v1/orgs/{org-id}/projects/{project-id}/infra/tier-1s/{tier-1-id}/nat/statistics
|
Paginated list of all fixed segments (identified as /policy/api/v1/infra/tier-1s//segments/) under Tier-1 instance.
Paginated list of all fixed segments (identified as /policy/api/v1/infra/tier-1s//segments/) under Tier-1 instance.
This API call does not return flexible segments (identified as /policy/api/v1/infra/segments/) connected to the Tier-1.
To return all segments connected as a downlink to a Tier-1 one possibility is to use the search API with: https://{{nsx-mgr}}/policy/api/v1/search?query=resource_type:Segment%20AND%20connectivity_path:“/infra/tier-1s/
Extended Segment: Please note that old vpn path deprecated. If user specify old l2vpn path in the
"l2_extension" object in the PUT/PATCH API payload, the path returned in the GET response payload may include the new path
instead of the deprecated l2vpn path. Both old and new l2vpn path refer to same resource. there is no functional impact.
Also note that l2vpn path included in the error messages returned from validation may include the new VPN path
instead of the deprecated l2vpn path. Both new path and old vpn path refer to same resource.
|
GET /policy/api/v1/infra/tier-1s/{tier-1-id}/segments
GET /policy/api/v1/global-infra/tier-1s/{tier-1-id}/segments
GET /policy/api/v1/orgs/{org-id}/projects/{project-id}/infra/tier-1s/{tier-1-id}/segments
|
Delete segment
Delete segment
|
DELETE /policy/api/v1/infra/tier-1s/{tier-1-id}/segments/{segment-id}
DELETE /policy/api/v1/orgs/{org-id}/projects/{project-id}/infra/tier-1s/{tier-1-id}/segments/{segment-id}
|
Force delete segment
Force delete bypasses validations during segment deletion. This may result in an inconsistent connectivity.
|
DELETE /policy/api/v1/infra/tier-1s/{tier-1-id}/segments/{segment-id}?force=true
DELETE /policy/api/v1/orgs/{org-id}/projects/{project-id}/infra/tier-1s/{tier-1-id}/segments/{segment-id}?force=true
|
Read segment
Read segment
Note:
Extended Segment: Please note that old vpn path deprecated. If user specify old l2vpn path in the
"l2_extension" object in the PUT/PATCH API payload, the path returned in the GET response payload may include the new path
instead of the deprecated l2vpn path. Both old and new l2vpn path refer to same resource. there is no functional impact.
Also note that l2vpn path included in the error messages returned from validation may include the new VPN path
instead of the deprecated l2vpn path. Both new path and old vpn path refer to same resource.
|
GET /policy/api/v1/infra/tier-1s/{tier-1-id}/segments/{segment-id}
GET /policy/api/v1/global-infra/tier-1s/{tier-1-id}/segments/{segment-id}
GET /policy/api/v1/orgs/{org-id}/projects/{project-id}/infra/tier-1s/{tier-1-id}/segments/{segment-id}
|
Create or update a segment
If segment with the segment-id is not already present, create a new segment.
If it already exists, update the segment with specified attributes.
Note:
Extended Segment: Please note that old vpn path deprecated. If user specify old l2vpn path in the
"l2_extension" object in the PATCH API payload, the path returned in the GET response payload may include the new path
instead of the deprecated l2vpn path. Both old and new l2vpn path refer to same resource. there is no functional impact.
Also note that l2vpn path included in the Alarm, GPRR, error messages returned from validation may include the new VPN path
instead of the deprecated l2vpn path. Both new path and old vpn path refer to same resource.
|
PATCH /policy/api/v1/infra/tier-1s/{tier-1-id}/segments/{segment-id}
PATCH /policy/api/v1/orgs/{org-id}/projects/{project-id}/infra/tier-1s/{tier-1-id}/segments/{segment-id}
|
Create or update a segment
If segment with the segment-id is not already present, create a new segment.
If it already exists, replace the segment with this object.
Note:
Extended Segment: Please note that old vpn path deprecated. If user specify old l2vpn path in the
"l2_extension" object in the PUT API payload, the path returned in the PUT/GET response payload may include the new path
instead of the deprecated l2vpn path. Both old and new l2vpn path refer to same resource. there is no functional impact.
Also note that l2vpn path included in the Alarm, GPRR, error messages returned from validation may include the new VPN path
instead of the deprecated l2vpn path. Both new path and old vpn path refer to same resource.
|
PUT /policy/api/v1/infra/tier-1s/{tier-1-id}/segments/{segment-id}
PUT /policy/api/v1/orgs/{org-id}/projects/{project-id}/infra/tier-1s/{tier-1-id}/segments/{segment-id}
|
Get downlink port Address Resolution Protocol Proxies for tier-1 segment
Returns ARP proxy table for downlink port on connected to the segment
|
GET /policy/api/v1/infra/tier-1s/{tier-1-id}/segments/{segment-id}/arp-proxy
GET /policy/api/v1/global-infra/tier-1s/{tier-1-id}/segments/{segment-id}/arp-proxy
GET /policy/api/v1/orgs/{org-id}/projects/{project-id}/infra/tier-1s/{tier-1-id}/segments/{segment-id}/arp-proxy
|
Get downlink port Address Resolution Protocol Proxies for tier-1 segment in CSV
Returns ARP proxy table for downlink port on connected to the segment in CSV
|
GET /policy/api/v1/infra/tier-1s/{tier-1-id}/segments/{segment-id}/arp-proxy?format=csv
GET /policy/api/v1/global-infra/tier-1s/{tier-1-id}/segments/{segment-id}/arp-proxy?format=csv
GET /policy/api/v1/orgs/{org-id}/projects/{project-id}/infra/tier-1s/{tier-1-id}/segments/{segment-id}/arp-proxy?format=csv
|
Get ARP table from segment interface (downlink) in CSV format
Returns ARP table (IPv4) or Neighbor Discovery table (IPv6) in CSV format for the
interface (downlink) attaching segment to tier1 gateway, on a edge
node specified in edge_path parameter.
The edge_path parameter is mandatory.
|
GET /policy/api/v1/infra/tier-1s/{tier-1-id}/segments/{segment-id}/arp-table?format=csv
GET /policy/api/v1/global-infra/tier-1s/{tier-1-id}/segments/{segment-id}/arp-table?format=csv
GET /policy/api/v1/orgs/{org-id}/projects/{project-id}/infra/tier-1s/{tier-1-id}/segments/{segment-id}/arp-table?format=csv
|
Get ARP table from segment interface (downlink)
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.
|
GET /policy/api/v1/infra/tier-1s/{tier-1-id}/segments/{segment-id}/arp-table
GET /policy/api/v1/global-infra/tier-1s/{tier-1-id}/segments/{segment-id}/arp-table
GET /policy/api/v1/orgs/{org-id}/projects/{project-id}/infra/tier-1s/{tier-1-id}/segments/{segment-id}/arp-table
|
Get Tier-1 segment bridge end point statistics using segment ID and profile path.
Get detailed information on Tier-1 segment bridge end point statistics using segment ID and profile path.
|
GET /policy/api/v1/infra/tier-1s/{tier-1-id}/segments/{segment-id}/bep-statistics
GET /policy/api/v1/global-infra/tier-1s/{tier-1-id}/segments/{segment-id}/bep-statistics
|
Get Tier-1 segment bridge end point status using segment ID and profile path.
Get detailed information on Tier-1 segment bridge end point status using segment ID and profile path.
|
GET /policy/api/v1/infra/tier-1s/{tier-1-id}/segments/{segment-id}/bep-status
GET /policy/api/v1/global-infra/tier-1s/{tier-1-id}/segments/{segment-id}/bep-status
|
List all DHCP static bindings
Paginated list of all DHCP static binding instances
|
GET /policy/api/v1/infra/tier-1s/{tier-1-id}/segments/{segment-id}/dhcp-static-binding-configs
GET /policy/api/v1/global-infra/tier-1s/{tier-1-id}/segments/{segment-id}/dhcp-static-binding-configs
GET /policy/api/v1/orgs/{org-id}/projects/{project-id}/infra/tier-1s/{tier-1-id}/segments/{segment-id}/dhcp-static-binding-configs
|
Delete DHCP static binding
Delete DHCP static binding
|
DELETE /policy/api/v1/infra/tier-1s/{tier-1-id}/segments/{segment-id}/dhcp-static-binding-configs/{binding-id}
DELETE /policy/api/v1/orgs/{org-id}/projects/{project-id}/infra/tier-1s/{tier-1-id}/segments/{segment-id}/dhcp-static-binding-configs/{binding-id}
|
Read DHCP static binding
Read DHCP static binding
|
GET /policy/api/v1/infra/tier-1s/{tier-1-id}/segments/{segment-id}/dhcp-static-binding-configs/{binding-id}
GET /policy/api/v1/global-infra/tier-1s/{tier-1-id}/segments/{segment-id}/dhcp-static-binding-configs/{binding-id}
GET /policy/api/v1/orgs/{org-id}/projects/{project-id}/infra/tier-1s/{tier-1-id}/segments/{segment-id}/dhcp-static-binding-configs/{binding-id}
|
Create or update DHCP static binding
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.
|
PATCH /policy/api/v1/infra/tier-1s/{tier-1-id}/segments/{segment-id}/dhcp-static-binding-configs/{binding-id}
PATCH /policy/api/v1/orgs/{org-id}/projects/{project-id}/infra/tier-1s/{tier-1-id}/segments/{segment-id}/dhcp-static-binding-configs/{binding-id}
|
Create or update DHCP static binding
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.
|
PUT /policy/api/v1/infra/tier-1s/{tier-1-id}/segments/{segment-id}/dhcp-static-binding-configs/{binding-id}
PUT /policy/api/v1/orgs/{org-id}/projects/{project-id}/infra/tier-1s/{tier-1-id}/segments/{segment-id}/dhcp-static-binding-configs/{binding-id}
|
Read DHCP static binding state
Read DHCP static binding state
|
GET /policy/api/v1/infra/tier-1s/{tier-1-id}/segments/{segment-id}/dhcp-static-bindings/{binding-id}/state
GET /policy/api/v1/global-infra/tier-1s/{tier-1-id}/segments/{segment-id}/dhcp-static-bindings/{binding-id}/state
GET /policy/api/v1/orgs/{org-id}/projects/{project-id}/infra/tier-1s/{tier-1-id}/segments/{segment-id}/dhcp-static-bindings/{binding-id}/state
|
List all effective profiles for segment
List all effective profiles for this segment on given enforcement point.
|
GET /policy/api/v1/infra/tier-1s/{tier-1-id}/segments/{segment-id}/effective-profiles
GET /policy/api/v1/global-infra/tier-1s/{tier-1-id}/segments/{segment-id}/effective-profiles
GET /policy/api/v1/orgs/{org-id}/projects/{project-id}/infra/tier-1s/{tier-1-id}/segments/{segment-id}/effective-profiles
|
Get ARP table for downlink router port on tier-1 router
Get ARP table for downlink router port on tier-1 router.
|
GET /policy/api/v1/infra/tier-1s/{tier-1-id}/segments/{segment-id}/gateway-interface-arp-table
(Deprecated)
GET /policy/api/v1/global-infra/tier-1s/{tier-1-id}/segments/{segment-id}/gateway-interface-arp-table
(Deprecated)
GET /policy/api/v1/orgs/{org-id}/projects/{project-id}/infra/tier-1s/{tier-1-id}/segments/{segment-id}/gateway-interface-arp-table
(Deprecated)
|
Get ARP table for downlink router port on tier-1 router in CSV
Get ARP table for downlink router port on tier-1 router in CSV.
|
GET /policy/api/v1/infra/tier-1s/{tier-1-id}/segments/{segment-id}/gateway-interface-arp-table?format=csv
(Deprecated)
GET /policy/api/v1/global-infra/tier-1s/{tier-1-id}/segments/{segment-id}/gateway-interface-arp-table?format=csv
(Deprecated)
GET /policy/api/v1/orgs/{org-id}/projects/{project-id}/infra/tier-1s/{tier-1-id}/segments/{segment-id}/gateway-interface-arp-table?format=csv
(Deprecated)
|
Get DAD state for downlink router port on tier-1 router
Segment ID is the ID of the segment that is connected to the the tier-1
|
GET /policy/api/v1/infra/tier-1s/{tier-1-id}/segments/{segment-id}/gateway-interface-dad-state
GET /policy/api/v1/global-infra/tier-1s/{tier-1-id}/segments/{segment-id}/gateway-interface-dad-state
GET /policy/api/v1/orgs/{org-id}/projects/{project-id}/infra/tier-1s/{tier-1-id}/segments/{segment-id}/gateway-interface-dad-state
|
Get statistics for downlink router port on tier-1 router
Segment ID is the ID of the segment that is connected to the the tier-1
|
GET /policy/api/v1/infra/tier-1s/{tier-1-id}/segments/{segment-id}/gateway-interface-statistics
GET /policy/api/v1/global-infra/tier-1s/{tier-1-id}/segments/{segment-id}/gateway-interface-statistics
GET /policy/api/v1/orgs/{org-id}/projects/{project-id}/infra/tier-1s/{tier-1-id}/segments/{segment-id}/gateway-interface-statistics
|
Get statistics for downlink router port on tier-1 router
Segment ID is the ID of the segment that is connected to the the tier-1
|
GET /policy/api/v1/infra/tier-1s/{tier-1-id}/segments/{segment-id}/gateway-interface-statistics/summary
GET /policy/api/v1/global-infra/tier-1s/{tier-1-id}/segments/{segment-id}/gateway-interface-statistics/summary
GET /policy/api/v1/orgs/{org-id}/projects/{project-id}/infra/tier-1s/{tier-1-id}/segments/{segment-id}/gateway-interface-statistics/summary
|
Get Tier-1 segment MAC table
Returns MAC table for a segment
|
GET /policy/api/v1/infra/tier-1s/{tier-1-id}/segments/{segment-id}/mac-table
GET /policy/api/v1/global-infra/tier-1s/{tier-1-id}/segments/{segment-id}/mac-table
GET /policy/api/v1/orgs/{org-id}/projects/{project-id}/infra/tier-1s/{tier-1-id}/segments/{segment-id}/mac-table
|
Get Tier-1 segment MAC table in CSV
Returns MAC table for a segment
|
GET /policy/api/v1/infra/tier-1s/{tier-1-id}/segments/{segment-id}/mac-table?format=csv
GET /policy/api/v1/global-infra/tier-1s/{tier-1-id}/segments/{segment-id}/mac-table?format=csv
GET /policy/api/v1/orgs/{org-id}/projects/{project-id}/infra/tier-1s/{tier-1-id}/segments/{segment-id}/mac-table?format=csv
|
List Tier-1 segment ports
List all the ports for a Tier-1 segment.
|
GET /policy/api/v1/infra/tier-1s/{tier-1-id}/segments/{segment-id}/ports
GET /policy/api/v1/global-infra/tier-1s/{tier-1-id}/segments/{segment-id}/ports
GET /policy/api/v1/orgs/{org-id}/projects/{project-id}/infra/tier-1s/{tier-1-id}/segments/{segment-id}/ports
|
Delete a Tier-1 segment port. Please note that this operation will not delete the
segment port from vCenter Server if the port was connected to a Virtual Machine.
Please connect Virtual Machine to another network for the segment port to be deleted
from vCenter Server.
Delete a Tier-1 segment port by giving ID.
|
DELETE /policy/api/v1/infra/tier-1s/{tier-1-id}/segments/{segment-id}/ports/{port-id}
DELETE /policy/api/v1/global-infra/tier-1s/{tier-1-id}/segments/{segment-id}/ports/{port-id}
DELETE /policy/api/v1/orgs/{org-id}/projects/{project-id}/infra/tier-1s/{tier-1-id}/segments/{segment-id}/ports/{port-id}
|
Get Tier-1 segment port by ID
Get detail information on a Tier-1 segment port by giving ID.
|
GET /policy/api/v1/infra/tier-1s/{tier-1-id}/segments/{segment-id}/ports/{port-id}
GET /policy/api/v1/global-infra/tier-1s/{tier-1-id}/segments/{segment-id}/ports/{port-id}
GET /policy/api/v1/orgs/{org-id}/projects/{project-id}/infra/tier-1s/{tier-1-id}/segments/{segment-id}/ports/{port-id}
|
Patch a Tier-1 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.
|
PATCH /policy/api/v1/infra/tier-1s/{tier-1-id}/segments/{segment-id}/ports/{port-id}
PATCH /policy/api/v1/global-infra/tier-1s/{tier-1-id}/segments/{segment-id}/ports/{port-id}
PATCH /policy/api/v1/orgs/{org-id}/projects/{project-id}/infra/tier-1s/{tier-1-id}/segments/{segment-id}/ports/{port-id}
|
Create or update a Tier-1 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.
|
PUT /policy/api/v1/infra/tier-1s/{tier-1-id}/segments/{segment-id}/ports/{port-id}
PUT /policy/api/v1/global-infra/tier-1s/{tier-1-id}/segments/{segment-id}/ports/{port-id}
PUT /policy/api/v1/orgs/{org-id}/projects/{project-id}/infra/tier-1s/{tier-1-id}/segments/{segment-id}/ports/{port-id}
|
List all effective profiles for tier-1 segment port
List all effective profiles for this segment port on given enforcement point.
|
GET /policy/api/v1/infra/tier-1s/{tier-1-id}/segments/{segment-id}/ports/{port-id}/effective-profiles
GET /policy/api/v1/global-infra/tier-1s/{tier-1-id}/segments/{segment-id}/ports/{port-id}/effective-profiles
GET /policy/api/v1/orgs/{org-id}/projects/{project-id}/infra/tier-1s/{tier-1-id}/segments/{segment-id}/ports/{port-id}/effective-profiles
|
Get tier-1 segment port MAC table in CSV
Returns MAC table for a segment port
|
GET /policy/api/v1/infra/tier-1s/{tier-1-id}/segments/{segment-id}/ports/{port-id}/mac-table?format=csv
GET /policy/api/v1/global-infra/tier-1s/{tier-1-id}/segments/{segment-id}/ports/{port-id}/mac-table?format=csv
GET /policy/api/v1/orgs/{org-id}/projects/{project-id}/infra/tier-1s/{tier-1-id}/segments/{segment-id}/ports/{port-id}/mac-table?format=csv
|
Get MAC table for tier-1 segment port
Returns MAC table for a segment port
|
GET /policy/api/v1/infra/tier-1s/{tier-1-id}/segments/{segment-id}/ports/{port-id}/mac-table
GET /policy/api/v1/global-infra/tier-1s/{tier-1-id}/segments/{segment-id}/ports/{port-id}/mac-table
GET /policy/api/v1/orgs/{org-id}/projects/{project-id}/infra/tier-1s/{tier-1-id}/segments/{segment-id}/ports/{port-id}/mac-table
|
List Port Discovery Profile Binding Maps
API will list all Port Discovery Profile Binding Maps in current port id.
|
GET /policy/api/v1/infra/tier-1s/{tier-1-id}/segments/{segment-id}/ports/{port-id}/port-discovery-profile-binding-maps
GET /policy/api/v1/global-infra/tier-1s/{tier-1-id}/segments/{segment-id}/ports/{port-id}/port-discovery-profile-binding-maps
GET /policy/api/v1/orgs/{org-id}/projects/{project-id}/infra/tier-1s/{tier-1-id}/segments/{segment-id}/ports/{port-id}/port-discovery-profile-binding-maps
|
Delete Port Discovery Profile Binding Profile
API will delete Port Discovery Profile Binding Profile
|
DELETE /policy/api/v1/infra/tier-1s/{tier-1-id}/segments/{segment-id}/ports/{port-id}/port-discovery-profile-binding-maps/{port-discovery-profile-binding-map-id}
DELETE /policy/api/v1/global-infra/tier-1s/{tier-1-id}/segments/{segment-id}/ports/{port-id}/port-discovery-profile-binding-maps/{port-discovery-profile-binding-map-id}
DELETE /policy/api/v1/orgs/{org-id}/projects/{project-id}/infra/tier-1s/{tier-1-id}/segments/{segment-id}/ports/{port-id}/port-discovery-profile-binding-maps/{port-discovery-profile-binding-map-id}
|
Get Port Discovery Profile Binding Map
API will get Port Discovery Profile Binding Map
|
GET /policy/api/v1/infra/tier-1s/{tier-1-id}/segments/{segment-id}/ports/{port-id}/port-discovery-profile-binding-maps/{port-discovery-profile-binding-map-id}
GET /policy/api/v1/global-infra/tier-1s/{tier-1-id}/segments/{segment-id}/ports/{port-id}/port-discovery-profile-binding-maps/{port-discovery-profile-binding-map-id}
GET /policy/api/v1/orgs/{org-id}/projects/{project-id}/infra/tier-1s/{tier-1-id}/segments/{segment-id}/ports/{port-id}/port-discovery-profile-binding-maps/{port-discovery-profile-binding-map-id}
|
Create Port Discovery Profile Binding Map
API will create Port Discovery Profile Binding Map. For objects with no binding maps, default profile is applied.
|
PATCH /policy/api/v1/infra/tier-1s/{tier-1-id}/segments/{segment-id}/ports/{port-id}/port-discovery-profile-binding-maps/{port-discovery-profile-binding-map-id}
PATCH /policy/api/v1/global-infra/tier-1s/{tier-1-id}/segments/{segment-id}/ports/{port-id}/port-discovery-profile-binding-maps/{port-discovery-profile-binding-map-id}
PATCH /policy/api/v1/orgs/{org-id}/projects/{project-id}/infra/tier-1s/{tier-1-id}/segments/{segment-id}/ports/{port-id}/port-discovery-profile-binding-maps/{port-discovery-profile-binding-map-id}
|
Update Port Discovery Profile Binding Map
API will update Port Discovery Profile Binding Map. For objects with no binding maps, default profile is applied.
|
PUT /policy/api/v1/infra/tier-1s/{tier-1-id}/segments/{segment-id}/ports/{port-id}/port-discovery-profile-binding-maps/{port-discovery-profile-binding-map-id}
PUT /policy/api/v1/global-infra/tier-1s/{tier-1-id}/segments/{segment-id}/ports/{port-id}/port-discovery-profile-binding-maps/{port-discovery-profile-binding-map-id}
PUT /policy/api/v1/orgs/{org-id}/projects/{project-id}/infra/tier-1s/{tier-1-id}/segments/{segment-id}/ports/{port-id}/port-discovery-profile-binding-maps/{port-discovery-profile-binding-map-id}
|
List Port Monitoring Profile Binding Maps
API will list all Port Monitoring Profile Binding Maps in current port id.
|
GET /policy/api/v1/infra/tier-1s/{tier-1-id}/segments/{segment-id}/ports/{port-id}/port-monitoring-profile-binding-maps
|
Delete Port Monitoring Profile Binding Profile
API will delete Port Monitoring Profile Binding Profile.
|
DELETE /policy/api/v1/infra/tier-1s/{tier-1-id}/segments/{segment-id}/ports/{port-id}/port-monitoring-profile-binding-maps/{port-monitoring-profile-binding-map-id}
|
Get Port Monitoring Profile Binding Map
API will get Port Monitoring Profile Binding Map.
|
GET /policy/api/v1/infra/tier-1s/{tier-1-id}/segments/{segment-id}/ports/{port-id}/port-monitoring-profile-binding-maps/{port-monitoring-profile-binding-map-id}
|
Create Port Monitoring Profile Binding Map
API will create Port Monitoring Profile Binding Map.
|
PATCH /policy/api/v1/infra/tier-1s/{tier-1-id}/segments/{segment-id}/ports/{port-id}/port-monitoring-profile-binding-maps/{port-monitoring-profile-binding-map-id}
|
Update Port Monitoring Profile Binding Map
API will update Port Monitoring Profile Binding Map.
|
PUT /policy/api/v1/infra/tier-1s/{tier-1-id}/segments/{segment-id}/ports/{port-id}/port-monitoring-profile-binding-maps/{port-monitoring-profile-binding-map-id}
|
Get mirror stack status for Port Monitoring Profile Binding Map
API will get mirror stack status by Port Monitoring Profile Binding Map.
|
GET /policy/api/v1/infra/tier-1s/{tier-1-id}/segments/{segment-id}/ports/{port-id}/port-monitoring-profile-binding-maps/{port-monitoring-profile-binding-map-id}/mirror-stack-status
|
List Port QoS Profile Binding Maps
API will list all Port QoS Profile Binding Maps in current port id.
|
GET /policy/api/v1/infra/tier-1s/{tier-1-id}/segments/{segment-id}/ports/{port-id}/port-qos-profile-binding-maps
GET /policy/api/v1/global-infra/tier-1s/{tier-1-id}/segments/{segment-id}/ports/{port-id}/port-qos-profile-binding-maps
GET /policy/api/v1/orgs/{org-id}/projects/{project-id}/infra/tier-1s/{tier-1-id}/segments/{segment-id}/ports/{port-id}/port-qos-profile-binding-maps
|
Delete Port QoS Profile Binding Profile
API will delete Port QoS Profile Binding Profile.
|
DELETE /policy/api/v1/infra/tier-1s/{tier-1-id}/segments/{segment-id}/ports/{port-id}/port-qos-profile-binding-maps/{port-qos-profile-binding-map-id}
DELETE /policy/api/v1/global-infra/tier-1s/{tier-1-id}/segments/{segment-id}/ports/{port-id}/port-qos-profile-binding-maps/{port-qos-profile-binding-map-id}
DELETE /policy/api/v1/orgs/{org-id}/projects/{project-id}/infra/tier-1s/{tier-1-id}/segments/{segment-id}/ports/{port-id}/port-qos-profile-binding-maps/{port-qos-profile-binding-map-id}
|
Get Port QoS Profile Binding Map
API will get Port QoS Profile Binding Map.
|
GET /policy/api/v1/infra/tier-1s/{tier-1-id}/segments/{segment-id}/ports/{port-id}/port-qos-profile-binding-maps/{port-qos-profile-binding-map-id}
GET /policy/api/v1/global-infra/tier-1s/{tier-1-id}/segments/{segment-id}/ports/{port-id}/port-qos-profile-binding-maps/{port-qos-profile-binding-map-id}
GET /policy/api/v1/orgs/{org-id}/projects/{project-id}/infra/tier-1s/{tier-1-id}/segments/{segment-id}/ports/{port-id}/port-qos-profile-binding-maps/{port-qos-profile-binding-map-id}
|
Create Port QoS Profile Binding Map
API will create Port QoS Profile Binding Map. For objects with no binding maps, default profile is applied.
|
PATCH /policy/api/v1/infra/tier-1s/{tier-1-id}/segments/{segment-id}/ports/{port-id}/port-qos-profile-binding-maps/{port-qos-profile-binding-map-id}
PATCH /policy/api/v1/global-infra/tier-1s/{tier-1-id}/segments/{segment-id}/ports/{port-id}/port-qos-profile-binding-maps/{port-qos-profile-binding-map-id}
PATCH /policy/api/v1/orgs/{org-id}/projects/{project-id}/infra/tier-1s/{tier-1-id}/segments/{segment-id}/ports/{port-id}/port-qos-profile-binding-maps/{port-qos-profile-binding-map-id}
|
Update Port QoS Profile Binding Map
API will update Port QoS Profile Binding Map. For objects with no binding maps, default profile is applied.
|
PUT /policy/api/v1/infra/tier-1s/{tier-1-id}/segments/{segment-id}/ports/{port-id}/port-qos-profile-binding-maps/{port-qos-profile-binding-map-id}
PUT /policy/api/v1/global-infra/tier-1s/{tier-1-id}/segments/{segment-id}/ports/{port-id}/port-qos-profile-binding-maps/{port-qos-profile-binding-map-id}
PUT /policy/api/v1/orgs/{org-id}/projects/{project-id}/infra/tier-1s/{tier-1-id}/segments/{segment-id}/ports/{port-id}/port-qos-profile-binding-maps/{port-qos-profile-binding-map-id}
|
List port security profile binding maps
API will list all port security profile binding maps.
|
GET /policy/api/v1/infra/tier-1s/{tier-1-id}/segments/{segment-id}/ports/{port-id}/port-security-profile-binding-maps
GET /policy/api/v1/global-infra/tier-1s/{tier-1-id}/segments/{segment-id}/ports/{port-id}/port-security-profile-binding-maps
GET /policy/api/v1/orgs/{org-id}/projects/{project-id}/infra/tier-1s/{tier-1-id}/segments/{segment-id}/ports/{port-id}/port-security-profile-binding-maps
|
Delete the port security profile binding map
API will delete the port security profile binding map.
|
DELETE /policy/api/v1/infra/tier-1s/{tier-1-id}/segments/{segment-id}/ports/{port-id}/port-security-profile-binding-maps/{port-security-profile-binding-map-id}
DELETE /policy/api/v1/global-infra/tier-1s/{tier-1-id}/segments/{segment-id}/ports/{port-id}/port-security-profile-binding-maps/{port-security-profile-binding-map-id}
DELETE /policy/api/v1/orgs/{org-id}/projects/{project-id}/infra/tier-1s/{tier-1-id}/segments/{segment-id}/ports/{port-id}/port-security-profile-binding-maps/{port-security-profile-binding-map-id}
|
Get port security profile binding map
API will return details of the port security profile binding map. If the
security profile binding map does not exist, it will return 404.
|
GET /policy/api/v1/infra/tier-1s/{tier-1-id}/segments/{segment-id}/ports/{port-id}/port-security-profile-binding-maps/{port-security-profile-binding-map-id}
GET /policy/api/v1/global-infra/tier-1s/{tier-1-id}/segments/{segment-id}/ports/{port-id}/port-security-profile-binding-maps/{port-security-profile-binding-map-id}
GET /policy/api/v1/orgs/{org-id}/projects/{project-id}/infra/tier-1s/{tier-1-id}/segments/{segment-id}/ports/{port-id}/port-security-profile-binding-maps/{port-security-profile-binding-map-id}
|
Patch port security profile binding map
Create a new port security profile binding map if the given security profile
binding map does not exist. Otherwise, patch the existing port security
profile binding map.
For objects with no binding maps, default profile is applied.
|
PATCH /policy/api/v1/infra/tier-1s/{tier-1-id}/segments/{segment-id}/ports/{port-id}/port-security-profile-binding-maps/{port-security-profile-binding-map-id}
PATCH /policy/api/v1/global-infra/tier-1s/{tier-1-id}/segments/{segment-id}/ports/{port-id}/port-security-profile-binding-maps/{port-security-profile-binding-map-id}
PATCH /policy/api/v1/orgs/{org-id}/projects/{project-id}/infra/tier-1s/{tier-1-id}/segments/{segment-id}/ports/{port-id}/port-security-profile-binding-maps/{port-security-profile-binding-map-id}
|
Create or replace the port security profile binding map
API will create or replace the port security profile binding map.
For objects with no binding maps, default profile is applied.
|
PUT /policy/api/v1/infra/tier-1s/{tier-1-id}/segments/{segment-id}/ports/{port-id}/port-security-profile-binding-maps/{port-security-profile-binding-map-id}
PUT /policy/api/v1/global-infra/tier-1s/{tier-1-id}/segments/{segment-id}/ports/{port-id}/port-security-profile-binding-maps/{port-security-profile-binding-map-id}
PUT /policy/api/v1/orgs/{org-id}/projects/{project-id}/infra/tier-1s/{tier-1-id}/segments/{segment-id}/ports/{port-id}/port-security-profile-binding-maps/{port-security-profile-binding-map-id}
|
Get tier-1 segment port state
Returns tier-1 segment port state on enforcement point
|
GET /policy/api/v1/infra/tier-1s/{tier-1-id}/segments/{segment-id}/ports/{port-id}/state
GET /policy/api/v1/global-infra/tier-1s/{tier-1-id}/segments/{segment-id}/ports/{port-id}/state
GET /policy/api/v1/orgs/{org-id}/projects/{project-id}/infra/tier-1s/{tier-1-id}/segments/{segment-id}/ports/{port-id}/state
|
List Segment Discovery Profile Binding Maps
API will list all Segment Discovery Profile Binding Maps in current segment id.
|
GET /policy/api/v1/infra/tier-1s/{tier-1-id}/segments/{segment-id}/segment-discovery-profile-binding-maps
GET /policy/api/v1/global-infra/tier-1s/{tier-1-id}/segments/{segment-id}/segment-discovery-profile-binding-maps
GET /policy/api/v1/orgs/{org-id}/projects/{project-id}/infra/tier-1s/{tier-1-id}/segments/{segment-id}/segment-discovery-profile-binding-maps
|
Delete Segment Discovery Profile Binding Profile
API will delete Segment Discovery Profile Binding Profile
|
DELETE /policy/api/v1/infra/tier-1s/{tier-1-id}/segments/{segment-id}/segment-discovery-profile-binding-maps/{segment-discovery-profile-binding-map-id}
DELETE /policy/api/v1/orgs/{org-id}/projects/{project-id}/infra/tier-1s/{tier-1-id}/segments/{segment-id}/segment-discovery-profile-binding-maps/{segment-discovery-profile-binding-map-id}
|
Get Segment Discovery Profile Binding Map
API will get Segment Discovery Profile Binding Map
|
GET /policy/api/v1/infra/tier-1s/{tier-1-id}/segments/{segment-id}/segment-discovery-profile-binding-maps/{segment-discovery-profile-binding-map-id}
GET /policy/api/v1/global-infra/tier-1s/{tier-1-id}/segments/{segment-id}/segment-discovery-profile-binding-maps/{segment-discovery-profile-binding-map-id}
GET /policy/api/v1/orgs/{org-id}/projects/{project-id}/infra/tier-1s/{tier-1-id}/segments/{segment-id}/segment-discovery-profile-binding-maps/{segment-discovery-profile-binding-map-id}
|
Create Segment Discovery Profile Binding Map
API will create Segment Discovery Profile Binding Map. For objects with no binding maps, default profile is applied.
|
PATCH /policy/api/v1/infra/tier-1s/{tier-1-id}/segments/{segment-id}/segment-discovery-profile-binding-maps/{segment-discovery-profile-binding-map-id}
PATCH /policy/api/v1/orgs/{org-id}/projects/{project-id}/infra/tier-1s/{tier-1-id}/segments/{segment-id}/segment-discovery-profile-binding-maps/{segment-discovery-profile-binding-map-id}
|
Update Segment Discovery Profile Binding Map
API will update Segment Discovery Profile Binding Map. For objects with no binding maps, default profile is applied.
|
PUT /policy/api/v1/infra/tier-1s/{tier-1-id}/segments/{segment-id}/segment-discovery-profile-binding-maps/{segment-discovery-profile-binding-map-id}
PUT /policy/api/v1/orgs/{org-id}/projects/{project-id}/infra/tier-1s/{tier-1-id}/segments/{segment-id}/segment-discovery-profile-binding-maps/{segment-discovery-profile-binding-map-id}
|
List Segment Monitoring Profile Binding Maps
API will list all Segment Monitoring Profile Binding Maps in current segment id.
|
GET /policy/api/v1/infra/tier-1s/{tier-1-id}/segments/{segment-id}/segment-monitoring-profile-binding-maps
|
Delete Segment Monitoring Profile Binding Profile
API will delete Segment Monitoring Profile Binding Profile.
|
DELETE /policy/api/v1/infra/tier-1s/{tier-1-id}/segments/{segment-id}/segment-monitoring-profile-binding-maps/{segment-monitoring-profile-binding-map-id}
|
Get Segment Monitoring Profile Binding Map
API will get Segment Monitoring Profile Binding Map.
|
GET /policy/api/v1/infra/tier-1s/{tier-1-id}/segments/{segment-id}/segment-monitoring-profile-binding-maps/{segment-monitoring-profile-binding-map-id}
|
Create Segment Monitoring Profile Binding Map
API will create segment monitoring profile binding map.
|
PATCH /policy/api/v1/infra/tier-1s/{tier-1-id}/segments/{segment-id}/segment-monitoring-profile-binding-maps/{segment-monitoring-profile-binding-map-id}
|
Update Segment Monitoring Profile Binding Map
API will update Segment Monitoring Profile Binding Map.
|
PUT /policy/api/v1/infra/tier-1s/{tier-1-id}/segments/{segment-id}/segment-monitoring-profile-binding-maps/{segment-monitoring-profile-binding-map-id}
|
Get mirror stack status for Segment Monitoring Profile Binding Map
API will get mirror stack status by Segment Monitoring Profile Binding Map.
|
GET /policy/api/v1/infra/tier-1s/{tier-1-id}/segments/{segment-id}/segment-monitoring-profile-binding-maps/{segment-monitoring-profile-binding-map-id}/mirror-stack-status
|
List Segment QoS Profile Binding Maps
API will list all Segment QoS Profile Binding Maps in current segment id.
|
GET /policy/api/v1/infra/tier-1s/{tier-1-id}/segments/{segment-id}/segment-qos-profile-binding-maps
GET /policy/api/v1/global-infra/tier-1s/{tier-1-id}/segments/{segment-id}/segment-qos-profile-binding-maps
GET /policy/api/v1/orgs/{org-id}/projects/{project-id}/infra/tier-1s/{tier-1-id}/segments/{segment-id}/segment-qos-profile-binding-maps
|
Delete Segment QoS Profile Binding Profile
API will delete Segment QoS Profile Binding Profile.
|
DELETE /policy/api/v1/infra/tier-1s/{tier-1-id}/segments/{segment-id}/segment-qos-profile-binding-maps/{segment-qos-profile-binding-map-id}
DELETE /policy/api/v1/orgs/{org-id}/projects/{project-id}/infra/tier-1s/{tier-1-id}/segments/{segment-id}/segment-qos-profile-binding-maps/{segment-qos-profile-binding-map-id}
|
Get Segment QoS Profile Binding Map
API will get Segment QoS Profile Binding Map.
|
GET /policy/api/v1/infra/tier-1s/{tier-1-id}/segments/{segment-id}/segment-qos-profile-binding-maps/{segment-qos-profile-binding-map-id}
GET /policy/api/v1/global-infra/tier-1s/{tier-1-id}/segments/{segment-id}/segment-qos-profile-binding-maps/{segment-qos-profile-binding-map-id}
GET /policy/api/v1/orgs/{org-id}/projects/{project-id}/infra/tier-1s/{tier-1-id}/segments/{segment-id}/segment-qos-profile-binding-maps/{segment-qos-profile-binding-map-id}
|
Create Segment QoS Profile Binding Map
API will create segment QoS profile binding map. For objects with no binding maps, default profile is applied.
|
PATCH /policy/api/v1/infra/tier-1s/{tier-1-id}/segments/{segment-id}/segment-qos-profile-binding-maps/{segment-qos-profile-binding-map-id}
PATCH /policy/api/v1/orgs/{org-id}/projects/{project-id}/infra/tier-1s/{tier-1-id}/segments/{segment-id}/segment-qos-profile-binding-maps/{segment-qos-profile-binding-map-id}
|
Update Segment QoS Profile Binding Map
API will update Segment QoS Profile Binding Map. For objects with no binding maps, default profile is applied.
|
PUT /policy/api/v1/infra/tier-1s/{tier-1-id}/segments/{segment-id}/segment-qos-profile-binding-maps/{segment-qos-profile-binding-map-id}
PUT /policy/api/v1/orgs/{org-id}/projects/{project-id}/infra/tier-1s/{tier-1-id}/segments/{segment-id}/segment-qos-profile-binding-maps/{segment-qos-profile-binding-map-id}
|
List segment security profile binding maps
API will list all segment security profile binding maps.
|
GET /policy/api/v1/infra/tier-1s/{tier-1-id}/segments/{segment-id}/segment-security-profile-binding-maps
GET /policy/api/v1/global-infra/tier-1s/{tier-1-id}/segments/{segment-id}/segment-security-profile-binding-maps
GET /policy/api/v1/orgs/{org-id}/projects/{project-id}/infra/tier-1s/{tier-1-id}/segments/{segment-id}/segment-security-profile-binding-maps
|
Delete segment security profile binding map
API will delete segment security profile binding map.
|
DELETE /policy/api/v1/infra/tier-1s/{tier-1-id}/segments/{segment-id}/segment-security-profile-binding-maps/{segment-security-profile-binding-map-id}
DELETE /policy/api/v1/orgs/{org-id}/projects/{project-id}/infra/tier-1s/{tier-1-id}/segments/{segment-id}/segment-security-profile-binding-maps/{segment-security-profile-binding-map-id}
|
Get segment security profile binding map
API will return details of the segment security profile binding map. If the
binding map does not exist, it will return 404.
|
GET /policy/api/v1/infra/tier-1s/{tier-1-id}/segments/{segment-id}/segment-security-profile-binding-maps/{segment-security-profile-binding-map-id}
GET /policy/api/v1/global-infra/tier-1s/{tier-1-id}/segments/{segment-id}/segment-security-profile-binding-maps/{segment-security-profile-binding-map-id}
GET /policy/api/v1/orgs/{org-id}/projects/{project-id}/infra/tier-1s/{tier-1-id}/segments/{segment-id}/segment-security-profile-binding-maps/{segment-security-profile-binding-map-id}
|
Patch 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.
|
PATCH /policy/api/v1/infra/tier-1s/{tier-1-id}/segments/{segment-id}/segment-security-profile-binding-maps/{segment-security-profile-binding-map-id}
PATCH /policy/api/v1/orgs/{org-id}/projects/{project-id}/infra/tier-1s/{tier-1-id}/segments/{segment-id}/segment-security-profile-binding-maps/{segment-security-profile-binding-map-id}
|
Create or replace 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.
|
PUT /policy/api/v1/infra/tier-1s/{tier-1-id}/segments/{segment-id}/segment-security-profile-binding-maps/{segment-security-profile-binding-map-id}
PUT /policy/api/v1/orgs/{org-id}/projects/{project-id}/infra/tier-1s/{tier-1-id}/segments/{segment-id}/segment-security-profile-binding-maps/{segment-security-profile-binding-map-id}
|
Delete static ARP config
Delete static ARP config
|
DELETE /policy/api/v1/infra/tier-1s/{tier-1-id}/segments/{segment-id}/static-arp
DELETE /policy/api/v1/orgs/{org-id}/projects/{project-id}/infra/tier-1s/{tier-1-id}/segments/{segment-id}/static-arp
|
Read static ARP config
Read static ARP config
|
GET /policy/api/v1/infra/tier-1s/{tier-1-id}/segments/{segment-id}/static-arp
GET /policy/api/v1/global-infra/tier-1s/{tier-1-id}/segments/{segment-id}/static-arp
GET /policy/api/v1/orgs/{org-id}/projects/{project-id}/infra/tier-1s/{tier-1-id}/segments/{segment-id}/static-arp
|
Create or update a 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.
|
PATCH /policy/api/v1/infra/tier-1s/{tier-1-id}/segments/{segment-id}/static-arp
PATCH /policy/api/v1/orgs/{org-id}/projects/{project-id}/infra/tier-1s/{tier-1-id}/segments/{segment-id}/static-arp
|
Create or update a 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.
|
PUT /policy/api/v1/infra/tier-1s/{tier-1-id}/segments/{segment-id}/static-arp
PUT /policy/api/v1/orgs/{org-id}/projects/{project-id}/infra/tier-1s/{tier-1-id}/segments/{segment-id}/static-arp
|
Get tier-1 segment TEP table in CSV
Returns TEP table for a segment in CSV
|
GET /policy/api/v1/infra/tier-1s/{tier-1-id}/segments/{segment-id}/tep-table?format=csv
GET /policy/api/v1/global-infra/tier-1s/{tier-1-id}/segments/{segment-id}/tep-table?format=csv
GET /policy/api/v1/orgs/{org-id}/projects/{project-id}/infra/tier-1s/{tier-1-id}/segments/{segment-id}/tep-table?format=csv
|
Get tier-1 segment TEP table
Returns TEP table for a segment
|
GET /policy/api/v1/infra/tier-1s/{tier-1-id}/segments/{segment-id}/tep-table
GET /policy/api/v1/global-infra/tier-1s/{tier-1-id}/segments/{segment-id}/tep-table
GET /policy/api/v1/orgs/{org-id}/projects/{project-id}/infra/tier-1s/{tier-1-id}/segments/{segment-id}/tep-table
|
Get tier-1 segment port statistics information
Get tier-1 segment port statistics information.
|
GET /policy/api/v1/infra/tier-1s/{tier-1-id}/segments/{segments-id}/ports/{port-id}/statistics
GET /policy/api/v1/global-infra/tier-1s/{tier-1-id}/segments/{segments-id}/ports/{port-id}/statistics
GET /policy/api/v1/orgs/{org-id}/projects/{project-id}/infra/tier-1s/{tier-1-id}/segments/{segments-id}/ports/{port-id}/statistics
|
Get segment port status information
Get tier1 segment port status information.
|
GET /policy/api/v1/infra/tier-1s/{tier-1-id}/segments/{segments-id}/ports/{port-id}/status
GET /policy/api/v1/global-infra/tier-1s/{tier-1-id}/segments/{segments-id}/ports/{port-id}/status
GET /policy/api/v1/orgs/{org-id}/projects/{project-id}/infra/tier-1s/{tier-1-id}/segments/{segments-id}/ports/{port-id}/status
|
Get segment state information
Get tier1 segment state information.
|
GET /policy/api/v1/infra/tier-1s/{tier-1-id}/segments/{segments-id}/state
GET /policy/api/v1/global-infra/tier-1s/{tier-1-id}/segments/{segments-id}/state
GET /policy/api/v1/orgs/{org-id}/projects/{project-id}/infra/tier-1s/{tier-1-id}/segments/{segments-id}/state
|
Get segment statistics information
Get tier1 segment statistics information.
|
GET /policy/api/v1/infra/tier-1s/{tier-1-id}/segments/{segments-id}/statistics
GET /policy/api/v1/global-infra/tier-1s/{tier-1-id}/segments/{segments-id}/statistics
GET /policy/api/v1/orgs/{org-id}/projects/{project-id}/infra/tier-1s/{tier-1-id}/segments/{segments-id}/statistics
|
Get tier-1 segments by configuration state
Returns all tier-1 segments with configuration state on the enforcement
point specified in the request
|
GET /policy/api/v1/infra/tier-1s/{tier-1-id}/segments/state
GET /policy/api/v1/global-infra/tier-1s/{tier-1-id}/segments/state
GET /policy/api/v1/orgs/{org-id}/projects/{project-id}/infra/tier-1s/{tier-1-id}/segments/state
|
Get Tier1 state
Returns
|
GET /policy/api/v1/infra/tier-1s/{tier-1-id}/state
GET /policy/api/v1/global-infra/tier-1s/{tier-1-id}/state
GET /policy/api/v1/orgs/{org-id}/projects/{project-id}/infra/tier-1s/{tier-1-id}/state
|
List Tier-1 Static Routes
Paginated list of all Tier-1 Static Routes
|
GET /policy/api/v1/infra/tier-1s/{tier-1-id}/static-routes
GET /policy/api/v1/global-infra/tier-1s/{tier-1-id}/static-routes
GET /policy/api/v1/orgs/{org-id}/projects/{project-id}/infra/tier-1s/{tier-1-id}/static-routes
|
Delete Tier-1 static routes
Delete Tier-1 static routes
|
DELETE /policy/api/v1/infra/tier-1s/{tier-1-id}/static-routes/{route-id}
DELETE /policy/api/v1/orgs/{org-id}/projects/{project-id}/infra/tier-1s/{tier-1-id}/static-routes/{route-id}
|
Read Tier-1 static routes
Read Tier-1 static routes
|
GET /policy/api/v1/infra/tier-1s/{tier-1-id}/static-routes/{route-id}
GET /policy/api/v1/global-infra/tier-1s/{tier-1-id}/static-routes/{route-id}
GET /policy/api/v1/orgs/{org-id}/projects/{project-id}/infra/tier-1s/{tier-1-id}/static-routes/{route-id}
|
Create or update a Tier-1 static routes
If static routes for route-id are not already present, create
static routes. If it already exists, update static routes for route-id.
|
PATCH /policy/api/v1/infra/tier-1s/{tier-1-id}/static-routes/{route-id}
PATCH /policy/api/v1/orgs/{org-id}/projects/{project-id}/infra/tier-1s/{tier-1-id}/static-routes/{route-id}
|
Create or update a Tier-1 static routes
If static routes for route-id are not already present, create
static routes. If it already exists, replace the static routes for route-id.
|
PUT /policy/api/v1/infra/tier-1s/{tier-1-id}/static-routes/{route-id}
PUT /policy/api/v1/orgs/{org-id}/projects/{project-id}/infra/tier-1s/{tier-1-id}/static-routes/{route-id}
|
Get ARP table from tier-1 router link interface in CSV format
Returns ARP table (IPv4) or Neighbor Discovery table (IPv6) in CSV format
for the tier-1 router link interface.
|
GET /policy/api/v1/infra/tier-1s/{tier-1-id}/tier-0-interface/arp-table?format=csv
GET /policy/api/v1/global-infra/tier-1s/{tier-1-id}/tier-0-interface/arp-table?format=csv
GET /policy/api/v1/orgs/{org-id}/projects/{project-id}/infra/tier-1s/{tier-1-id}/tier-0-interface/arp-table?format=csv
|
Get tier-1 router link arp information
Get tier-1 interface arp information.
|
GET /policy/api/v1/infra/tier-1s/{tier-1-id}/tier-0-interface/arp-table
GET /policy/api/v1/global-infra/tier-1s/{tier-1-id}/tier-0-interface/arp-table
GET /policy/api/v1/orgs/{org-id}/projects/{project-id}/infra/tier-1s/{tier-1-id}/tier-0-interface/arp-table
|
Get tier-1 router link statistics information
Get tier-0 interface statistics information.
|
GET /policy/api/v1/infra/tier-1s/{tier-1-id}/tier-0-interface/statistics
GET /policy/api/v1/global-infra/tier-1s/{tier-1-id}/tier-0-interface/statistics
GET /policy/api/v1/orgs/{org-id}/projects/{project-id}/infra/tier-1s/{tier-1-id}/tier-0-interface/statistics
|
Get tier-1 router link statistics summary information
Get tier-1 interface statistics summary information.
|
GET /policy/api/v1/infra/tier-1s/{tier-1-id}/tier-0-interface/statistics/summary
GET /policy/api/v1/global-infra/tier-1s/{tier-1-id}/tier-0-interface/statistics/summary
GET /policy/api/v1/orgs/{org-id}/projects/{project-id}/infra/tier-1s/{tier-1-id}/tier-0-interface/statistics/summary
|
Delete DHCP lease(s) specified by IP and MAC
Delete one or multiple DHCP lease(s) specified by IP and MAC under a Tier-1.
If there is a DHCP server running upon the given segment, or this segment
is using a DHCP server running in its connected Tier-1, the DHCP lease(s)
which match exactly the IP address and the MAC address will be deleted.
If no such lease matches, the deletion for this lease will be ignored.
The DHCP lease to be deleted will be removed by the system from both active
and standby node. The system will report error if the DHCP lease could not
be removed from both nodes. If the DHCP lease could not be removed on either
node, please check the DHCP server status. Once the DHCP server status is
UP, please invoke the deletion API again to ensure the lease gets deleted
from both nodes.
|
POST /policy/api/v1/infra/tier-1s/{tier1-id}/segments/{segment-id}?action=delete_dhcp_leases
POST /policy/api/v1/orgs/{org-id}/projects/{project-id}/infra/tier-1s/{tier1-id}/segments/{segment-id}?action=delete_dhcp_leases
|
List Policy Transport Zone Profiles
API will list all Policy Transport Zone Profiles.
|
GET /policy/api/v1/infra/transport-zone-profiles
GET /policy/api/v1/global-infra/transport-zone-profiles
|
Delete Policy Transport Zone Profile
API will delete Policy Transport Zone Profile.
|
DELETE /policy/api/v1/infra/transport-zone-profiles/{tz-profile-id}
|
Get Policy Transport Zone Profile
API will fetch Policy Transport Zone Profile.
|
GET /policy/api/v1/infra/transport-zone-profiles/{tz-profile-id}
GET /policy/api/v1/global-infra/transport-zone-profiles/{tz-profile-id}
|
Create Policy Transport Zone Profile
API will create Policy Transport Zone Profile.
|
PATCH /policy/api/v1/infra/transport-zone-profiles/{tz-profile-id}
|
Update Policy Transport Zone Profile
API will update Policy Transport Zone Profile.
|
PUT /policy/api/v1/infra/transport-zone-profiles/{tz-profile-id}
|
List Vni Pool Configuration
List all Vni Pool configuration.
|
GET /policy/api/v1/infra/vni-pools
|
Delete Vni Pool Configuration
Delete Vni Pool Configuration.
|
DELETE /policy/api/v1/infra/vni-pools/{vni-pool-id}
|
Read Vni Pool Configuration
Read Vni Pool Configuration.
|
GET /policy/api/v1/infra/vni-pools/{vni-pool-id}
|
Create or Update Vni Pool Configuration
Create a Vni Pool config if it is not already present,
otherwise update the Vni Pool configuration.
|
PATCH /policy/api/v1/infra/vni-pools/{vni-pool-id}
|
Create or Update Vni Pool Configuration
Create or update VniPool configuration.
|
PUT /policy/api/v1/infra/vni-pools/{vni-pool-id}
|