Link

This object represents the link between a source and destination domain in service chaining

Overview

acceptanceCriteria enum (ALL | SUBNETS_ONLY)
associatedDestinationID string filterable  
associatedDestinationName string
associatedDestinationType enum (ACLENTRY_LOCATION | ADDRESS_RANGE | ADDRESS_RANGE_STATE | ALARM | APPD_APPLICATION | APPD_EXTERNAL_APP_SERVICE | APPD_FLOW | APPD_FLOW_FORWARDING_POLICY | APPD_FLOW_SECURITY_POLICY | APPD_SERVICE | APPD_TIER | APPLICATION | AUTO_DISC_GATEWAY | AVATAR | BACK_HAUL_SERVICE_RESP | BGP_DAMPENING_MED_RESPONSE | BGP_NEIGHBOR | BGP_NEIGHBOR_MED_RESPONSE | BGP_PROFILE | BGP_PROFILE_MED_RESPONSE | BGPPEER | BOOTSTRAP | BOOTSTRAP_ACTIVATION | BRIDGEINTERFACE | BULKSTATISTICS | CERTIFICATE | CHILD_ENTITY_POLICY_CHANGE | CLOUD_MGMT_SYSTEM | CONTAINER | CONTAINER_DESCRIPTION | CONTAINER_INTERFACE | CONTAINER_RESYNC | CUSTOMER_VRF_SEQUENCENO | DC_CONFIG | DHCP_ALLOC_MESSAGE | DHCP_CONFIG_RESP | DHCP_OPTION | DISKSTATS | DOMAIN | DOMAIN_CONFIG | DOMAIN_CONFIG_RESP | DOMAIN_FLOATING_IP_ACL_TEMPLATE | DOMAIN_FLOATING_IP_ACL_TEMPLATE_ENTRY | DOMAIN_TEMPLATE | DSCP_FORWARDING_CLASS_MAPPING | DSCP_FORWARDING_CLASS_TABLE | EAM_VRS_METRICS | EGRESS_ACL | EGRESS_ACL_ENTRY | EGRESS_ACL_TEMPLATE | EGRESS_ACL_TEMPLATE_ENTRY | EGRESS_QOS_MR | EGRESS_QOS_PRIMITIVE | EGRESS_QOS_QUEUE_MR | ENDPOINT | ENTERPRISE | ENTERPRISE_CONFIG | ENTERPRISE_CONFIG_RESP | ENTERPRISE_NETWORK | ENTERPRISE_PERMISSION | ENTERPRISE_PROFILE | ENTERPRISE_SECURED_DATA | ENTERPRISE_SECURITY | ENTITY_METADATA_BINDING | ESI_SEQUENCENO | EVENT_LOG | EVPN_BGP_COMMUNITY_TAG_ENTRY | EVPN_BGP_COMMUNITY_TAG_SEQ_NO | EXPORTIMPORT | EXTERNAL_SERVICE | FETCH_HYPERVISOR_PROPERTIES | FLOATING_IP_ACL_TEMPLATE | FLOATING_IP_ACL_TEMPLATE_ENTRY | FLOATINGIP | FLOATINGIP_ACL | FLOATINGIP_ACL_ENTRY | GATEWAY | GATEWAY_CONFIG | GATEWAY_CONFIG_RESP | GATEWAY_SECURED_DATA | GATEWAY_SECURITY | GATEWAY_SECURITY_PROFILE_REQUEST | GATEWAY_SECURITY_PROFILE_RESPONSE | GATEWAY_SECURITY_REQUEST | GATEWAY_SECURITY_RESPONSE | GATEWAY_SERVICE_CONFIG | GATEWAY_SERVICE_CONFIG_RESP | GATEWAY_STATE | GATEWAY_TEMPLATE | GATEWAY_VPORT_CONFIG | GATEWAY_VPORT_CONFIG_RESP | GEO_VM_EVENT | GEO_VM_REQ | GEO_VM_RES | GROUP | GROUPKEY_ENCRYPTION_PROFILE | HEALTH_REQ | HOSTINTERFACE | HSC | IKE_CERTIFICATE | IKE_ENCRYPTION_PROFILE | IKE_ENCRYPTION_PROFILE_REQUEST | IKE_GATEWAY | IKE_GATEWAY_CONFIG | IKE_GATEWAY_CONNECTION | IKE_GATEWAY_CONNECTION_REQUEST | IKE_GATEWAY_PROFILE | IKE_PSK | IKE_SUBNET | INFRASTRUCTURE_CONFIG | INFRASTRUCTURE_GATEWAY_PROFILE | INFRASTRUCTURE_PORT_PROFILE | INFRASTRUCTURE_VSC_PROFILE | INGRESS_ACL | INGRESS_ACL_ENTRY | INGRESS_ACL_TEMPLATE | INGRESS_ACL_TEMPLATE_ENTRY | INGRESS_ADV_FWD | INGRESS_ADV_FWD_ENTRY | INGRESS_ADV_FWD_TEMPLATE | INGRESS_ADV_FWD_TEMPLATE_ENTRY | INGRESS_EXT_SERVICE | INGRESS_EXT_SERVICE_ENTRY | INGRESS_EXT_SERVICE_TEMPLATE | INGRESS_EXT_SERVICE_TEMPLATE_ENTRY | IP_BINDING | JOB | KEYSERVER_MEMBER | KEYSERVER_MONITOR | KEYSERVER_MONITOR_ENCRYPTED_SEED | KEYSERVER_MONITOR_SEED | KEYSERVER_MONITOR_SEK | KEYSERVER_NOTIFICATION | L2DOMAIN | L2DOMAIN_SHARED | L2DOMAIN_TEMPLATE | LDAP_CONFIG | LIBVIRT_INTERFACE | LICENSE | LICENSE_STATUS | LINK | LINKED_DOMAIN_RESP | LOCATION | MACRO_GROUP_MED | MC_CHANNEL_MAP | MC_LIST | MC_RANGE | METADATA | METADATA_TAG | MIRROR_DESTINATION | MONITORING_PORT | MULTI_NIC_VPORT | NATMAPENTRY | NETWORK_ELEMENT | NETWORK_LAYOUT | NETWORK_MACRO_GROUP | NETWORK_POLICY_GROUP | NEXT_HOP | NEXT_HOP_RESP | NODE_EXECUTION_ERROR | NS_REDUNDANT_PORT | NSG_INFO | NSG_NOTIFICATION | NSGATEWAY | NSGATEWAY_CONFIG | NSGATEWAY_TEMPLATE | NSPORT | NSPORT_STATIC_CONFIG | NSPORT_TEMPLATE | NSPORT_VLAN_CONFIG | NSREDUNDANT_GW_GRP | PAT_IP_ENTRY | PATCONFIG_CONFIG_RESP | PATMAPPER | PATNATPOOL | PERMISSION | PERMITTED_ACTION | POLICING_POLICY | POLICY_DECISION | POLICY_GROUP | POLICY_GROUP_TEMPLATE | PORT | PORT_MR | PORT_PUSH | PORT_RANGE_MED | PORT_TEMPLATE | PORT_VLAN_CONFIG | PORT_VLAN_CONFIG_RESPONSE | PORTMAPPING | PUBLIC_NETWORK | QOS_PRIMITIVE | RATE_LIMITER | RD_SEQUENCENO | REDUNDANT_GW_GRP | ROUTING_POL_MED_RESPONSE | ROUTING_POLICY | RTRD_ENTITY | RTRD_SEQUENCENO | SERVICE_GATEWAY_RESPONSE | SERVICE_VRF_SEQUENCENO | SERVICES_GATEWAY_RESPONSE | SHAPING_POLICY | SHARED_RESOURCE | SITE | SITE_REQ | SITE_RES | STATIC_ROUTE | STATIC_ROUTE_RESP | STATISTICS | STATS_COLLECTOR | STATS_POLICY | STATS_TCA | STATSSERVER | SUBNET | SUBNET_ENTRY | SUBNET_MAC_ENTRY | SUBNET_POOL_ENTRY | SUBNET_TEMPLATE | SYSTEM_CONFIG | SYSTEM_CONFIG_REQ | SYSTEM_CONFIG_RESP | SYSTEM_MONITORING | UNSUPPORTED | UPLINK_RD | USER | VCENTER_FETCH_CLUSTERS | VCENTER_FETCH_DATACENTERS | VIRTUAL_IP | VIRTUAL_MACHINE | VIRTUAL_MACHINE_REPORT | VLAN | VLAN_CONFIG_RESPONSE | VLAN_TEMPLATE | VM_DESCRIPTION | VM_INTERFACE | VM_RESYNC | VMWARE_ADD_CLUSTER_INSCOPE | VMWARE_RELOAD_CONFIG | VMWARE_REMOVE_CLUSTER_INSCOPE | VMWARE_VCENTER | VMWARE_VCENTER_CLUSTER | VMWARE_VCENTER_DATACENTER | VMWARE_VCENTER_EAM_CONFIG | VMWARE_VCENTER_HYPERVISOR | VMWARE_VCENTER_VRS_BASE_CONFIG | VMWARE_VCENTER_VRS_CONFIG | VMWARE_VRS_ADDRESS_RANGE | VMWARE_VRS_REDEPLOYMENT_POLICY | VNID_SEQUENCENO | VPN_CONNECT | VPORT | VPORT_GATEWAY_RESPONSE | VPORT_MEDIATION_REQUEST | VPORT_MIRROR | VPORT_TAG_BASE | VPORTTAG | VPORTTAGTEMPLATE | VPRN_LABEL_SEQUENCENO | VRS | VSC | VSD | VSD_COMPONENT | VSG_REDUNDANT_PORT | VSP | WAN_SERVICE | ZFB_AUTO_ASSIGNMENT | ZFB_AUTO_ASSIGNMENT_VALUE | ZFB_GLOBAL | ZFB_REQUEST | ZONE | ZONE_TEMPLATE) filterable  
associatedSourceID string filterable  
associatedSourceName string
associatedSourceType string filterable  
entityScope enum (ENTERPRISE | GLOBAL) autogenerated   filterable   orderable  
externalID string filterable   orderable   locally unique  
lastUpdatedBy string autogenerated  
readOnly boolean creation only  
type enum (BORDER_ROUTER | HUB_AND_SPOKE | OVERLAY_ADDRESS_TRANSLATION | SERVICE_CHAINING)

API Resource

/links/id
delete get put

Parents

/domains/id/links
delete get post put

Children

get post
/links/id/metadatas
get post
/links/id/nexthopaddress
get post
/links/id/globalmetadatas
get post put
get post

Members

This object has no members.

Attributes documentation

acceptanceCriteria enum
Discussion

A route filtering criteria enum. Defaults to ALL.


Charateristics

Allowed values: ALL, SUBNETS_ONLY
Default value: ALL
SDK attribute: acceptanceCriteria

associatedDestinationID string filterable  
Discussion

This is the ID of the domain receiving the routes from the source. This can only be set for links of type OVERLAY_ADDRESS_TRANSLATION.


Charateristics

Format: free
SDK attribute: associatedDestinationID

associatedDestinationName string
Discussion

None


Charateristics

SDK attribute: associatedDestinationName

associatedDestinationType enum filterable  
Discussion

Type of the entity type for the source


Charateristics

Allowed values: ACLENTRY_LOCATION, ADDRESS_RANGE, ADDRESS_RANGE_STATE, ALARM, APPD_APPLICATION, APPD_EXTERNAL_APP_SERVICE, APPD_FLOW, APPD_FLOW_FORWARDING_POLICY, APPD_FLOW_SECURITY_POLICY, APPD_SERVICE, APPD_TIER, APPLICATION, AUTO_DISC_GATEWAY, AVATAR, BACK_HAUL_SERVICE_RESP, BGP_DAMPENING_MED_RESPONSE, BGP_NEIGHBOR, BGP_NEIGHBOR_MED_RESPONSE, BGP_PROFILE, BGP_PROFILE_MED_RESPONSE, BGPPEER, BOOTSTRAP, BOOTSTRAP_ACTIVATION, BRIDGEINTERFACE, BULKSTATISTICS, CERTIFICATE, CHILD_ENTITY_POLICY_CHANGE, CLOUD_MGMT_SYSTEM, CONTAINER, CONTAINER_DESCRIPTION, CONTAINER_INTERFACE, CONTAINER_RESYNC, CUSTOMER_VRF_SEQUENCENO, DC_CONFIG, DHCP_ALLOC_MESSAGE, DHCP_CONFIG_RESP, DHCP_OPTION, DISKSTATS, DOMAIN, DOMAIN_CONFIG, DOMAIN_CONFIG_RESP, DOMAIN_FLOATING_IP_ACL_TEMPLATE, DOMAIN_FLOATING_IP_ACL_TEMPLATE_ENTRY, DOMAIN_TEMPLATE, DSCP_FORWARDING_CLASS_MAPPING, DSCP_FORWARDING_CLASS_TABLE, EAM_VRS_METRICS, EGRESS_ACL, EGRESS_ACL_ENTRY, EGRESS_ACL_TEMPLATE, EGRESS_ACL_TEMPLATE_ENTRY, EGRESS_QOS_MR, EGRESS_QOS_PRIMITIVE, EGRESS_QOS_QUEUE_MR, ENDPOINT, ENTERPRISE, ENTERPRISE_CONFIG, ENTERPRISE_CONFIG_RESP, ENTERPRISE_NETWORK, ENTERPRISE_PERMISSION, ENTERPRISE_PROFILE, ENTERPRISE_SECURED_DATA, ENTERPRISE_SECURITY, ENTITY_METADATA_BINDING, ESI_SEQUENCENO, EVENT_LOG, EVPN_BGP_COMMUNITY_TAG_ENTRY, EVPN_BGP_COMMUNITY_TAG_SEQ_NO, EXPORTIMPORT, EXTERNAL_SERVICE, FETCH_HYPERVISOR_PROPERTIES, FLOATING_IP_ACL_TEMPLATE, FLOATING_IP_ACL_TEMPLATE_ENTRY, FLOATINGIP, FLOATINGIP_ACL, FLOATINGIP_ACL_ENTRY, GATEWAY, GATEWAY_CONFIG, GATEWAY_CONFIG_RESP, GATEWAY_SECURED_DATA, GATEWAY_SECURITY, GATEWAY_SECURITY_PROFILE_REQUEST, GATEWAY_SECURITY_PROFILE_RESPONSE, GATEWAY_SECURITY_REQUEST, GATEWAY_SECURITY_RESPONSE, GATEWAY_SERVICE_CONFIG, GATEWAY_SERVICE_CONFIG_RESP, GATEWAY_STATE, GATEWAY_TEMPLATE, GATEWAY_VPORT_CONFIG, GATEWAY_VPORT_CONFIG_RESP, GEO_VM_EVENT, GEO_VM_REQ, GEO_VM_RES, GROUP, GROUPKEY_ENCRYPTION_PROFILE, HEALTH_REQ, HOSTINTERFACE, HSC, IKE_CERTIFICATE, IKE_ENCRYPTION_PROFILE, IKE_ENCRYPTION_PROFILE_REQUEST, IKE_GATEWAY, IKE_GATEWAY_CONFIG, IKE_GATEWAY_CONNECTION, IKE_GATEWAY_CONNECTION_REQUEST, IKE_GATEWAY_PROFILE, IKE_PSK, IKE_SUBNET, INFRASTRUCTURE_CONFIG, INFRASTRUCTURE_GATEWAY_PROFILE, INFRASTRUCTURE_PORT_PROFILE, INFRASTRUCTURE_VSC_PROFILE, INGRESS_ACL, INGRESS_ACL_ENTRY, INGRESS_ACL_TEMPLATE, INGRESS_ACL_TEMPLATE_ENTRY, INGRESS_ADV_FWD, INGRESS_ADV_FWD_ENTRY, INGRESS_ADV_FWD_TEMPLATE, INGRESS_ADV_FWD_TEMPLATE_ENTRY, INGRESS_EXT_SERVICE, INGRESS_EXT_SERVICE_ENTRY, INGRESS_EXT_SERVICE_TEMPLATE, INGRESS_EXT_SERVICE_TEMPLATE_ENTRY, IP_BINDING, JOB, KEYSERVER_MEMBER, KEYSERVER_MONITOR, KEYSERVER_MONITOR_ENCRYPTED_SEED, KEYSERVER_MONITOR_SEED, KEYSERVER_MONITOR_SEK, KEYSERVER_NOTIFICATION, L2DOMAIN, L2DOMAIN_SHARED, L2DOMAIN_TEMPLATE, LDAP_CONFIG, LIBVIRT_INTERFACE, LICENSE, LICENSE_STATUS, LINK, LINKED_DOMAIN_RESP, LOCATION, MACRO_GROUP_MED, MC_CHANNEL_MAP, MC_LIST, MC_RANGE, METADATA, METADATA_TAG, MIRROR_DESTINATION, MONITORING_PORT, MULTI_NIC_VPORT, NATMAPENTRY, NETWORK_ELEMENT, NETWORK_LAYOUT, NETWORK_MACRO_GROUP, NETWORK_POLICY_GROUP, NEXT_HOP, NEXT_HOP_RESP, NODE_EXECUTION_ERROR, NS_REDUNDANT_PORT, NSG_INFO, NSG_NOTIFICATION, NSGATEWAY, NSGATEWAY_CONFIG, NSGATEWAY_TEMPLATE, NSPORT, NSPORT_STATIC_CONFIG, NSPORT_TEMPLATE, NSPORT_VLAN_CONFIG, NSREDUNDANT_GW_GRP, PAT_IP_ENTRY, PATCONFIG_CONFIG_RESP, PATMAPPER, PATNATPOOL, PERMISSION, PERMITTED_ACTION, POLICING_POLICY, POLICY_DECISION, POLICY_GROUP, POLICY_GROUP_TEMPLATE, PORT, PORT_MR, PORT_PUSH, PORT_RANGE_MED, PORT_TEMPLATE, PORT_VLAN_CONFIG, PORT_VLAN_CONFIG_RESPONSE, PORTMAPPING, PUBLIC_NETWORK, QOS_PRIMITIVE, RATE_LIMITER, RD_SEQUENCENO, REDUNDANT_GW_GRP, ROUTING_POL_MED_RESPONSE, ROUTING_POLICY, RTRD_ENTITY, RTRD_SEQUENCENO, SERVICE_GATEWAY_RESPONSE, SERVICE_VRF_SEQUENCENO, SERVICES_GATEWAY_RESPONSE, SHAPING_POLICY, SHARED_RESOURCE, SITE, SITE_REQ, SITE_RES, STATIC_ROUTE, STATIC_ROUTE_RESP, STATISTICS, STATS_COLLECTOR, STATS_POLICY, STATS_TCA, STATSSERVER, SUBNET, SUBNET_ENTRY, SUBNET_MAC_ENTRY, SUBNET_POOL_ENTRY, SUBNET_TEMPLATE, SYSTEM_CONFIG, SYSTEM_CONFIG_REQ, SYSTEM_CONFIG_RESP, SYSTEM_MONITORING, UNSUPPORTED, UPLINK_RD, USER, VCENTER_FETCH_CLUSTERS, VCENTER_FETCH_DATACENTERS, VIRTUAL_IP, VIRTUAL_MACHINE, VIRTUAL_MACHINE_REPORT, VLAN, VLAN_CONFIG_RESPONSE, VLAN_TEMPLATE, VM_DESCRIPTION, VM_INTERFACE, VM_RESYNC, VMWARE_ADD_CLUSTER_INSCOPE, VMWARE_RELOAD_CONFIG, VMWARE_REMOVE_CLUSTER_INSCOPE, VMWARE_VCENTER, VMWARE_VCENTER_CLUSTER, VMWARE_VCENTER_DATACENTER, VMWARE_VCENTER_EAM_CONFIG, VMWARE_VCENTER_HYPERVISOR, VMWARE_VCENTER_VRS_BASE_CONFIG, VMWARE_VCENTER_VRS_CONFIG, VMWARE_VRS_ADDRESS_RANGE, VMWARE_VRS_REDEPLOYMENT_POLICY, VNID_SEQUENCENO, VPN_CONNECT, VPORT, VPORT_GATEWAY_RESPONSE, VPORT_MEDIATION_REQUEST, VPORT_MIRROR, VPORT_TAG_BASE, VPORTTAG, VPORTTAGTEMPLATE, VPRN_LABEL_SEQUENCENO, VRS, VSC, VSD, VSD_COMPONENT, VSG_REDUNDANT_PORT, VSP, WAN_SERVICE, ZFB_AUTO_ASSIGNMENT, ZFB_AUTO_ASSIGNMENT_VALUE, ZFB_GLOBAL, ZFB_REQUEST, ZONE, ZONE_TEMPLATE
SDK attribute: associatedDestinationType

associatedSourceID string filterable  
Discussion

The ID of the domain receiving the routes from another domain


Charateristics

Format: free
SDK attribute: associatedSourceID

associatedSourceName string
Discussion

None


Charateristics

Format: free
SDK attribute: associatedSourceName

associatedSourceType string filterable  
Discussion

This is the source object type for the associatedSourceID


Charateristics

Format: free
SDK attribute: associatedSourceType

entityScope enum autogenerated   filterable   orderable  
Discussion

Specify if scope of entity is Data center or Enterprise level


Charateristics

Allowed values: ENTERPRISE, GLOBAL
Format: free
SDK attribute: entityScope

externalID string filterable   orderable   locally unique  
Discussion

External object ID. Used for integration with third party systems


Charateristics

Format: free
SDK attribute: externalID

lastUpdatedBy string autogenerated  
Discussion

ID of the user who last updated the object.


Charateristics

Format: free
SDK attribute: lastUpdatedBy

readOnly boolean creation only  
Discussion

This is set to true if a link has been created in the opposite direction


Charateristics

SDK attribute: readOnly

type enum
Discussion

This is used to distinguish between different type of links: hub and spoke, ip address, VNS border router links.


Charateristics

Allowed values: BORDER_ROUTER, HUB_AND_SPOKE, OVERLAY_ADDRESS_TRANSLATION, SERVICE_CHAINING
SDK attribute: type