{"type":"api","title":"Add anycast gateways","meta":{"id":"/apps/pubhub/media/cisco-catalyst-center-api-3-1-3/9b7bce247bccb0311419e593770ef07f9552d9e1/d41c7da7-f399-330a-bd19-886309e55849","info":{"title":"Intent API","description":"Cisco Catalyst Center Platform v. 3.1.3","version":"3.1.3"},"tags":[{"name":"Authentication","description":"Access Token Request"},{"name":"Sites","description":"Create sites, assign devices to them and get site health"},{"name":"Topology","description":"Get topology details and overall network health"},{"name":"Devices","description":"Manage network devices"},{"name":"Clients","description":"Get client (by MAC Address) health, status, and information"},{"name":"Users","description":"Obtain information about *Users* and associated connections and devices"},{"name":"Issues","description":"Obtain issue details, impacted hosts, and suggested actions for remediation"},{"name":"Site Design","description":"Design/provision NFV device to site/area/building/floor"},{"name":"Network Settings","description":"Manage Network Settings"},{"name":"Software Image Management (SWIM)","description":"Manage activation and distribution of software images"},{"name":"Device Onboarding (PnP)","description":"Zero-touch deployment of network devices"},{"name":"Configuration Templates","description":"Configure and manage CLI templates"},{"name":"Configuration Archive","description":"Export device configurations to an encrypted zip file"},{"name":"SDA","description":"(BETA) Configure and manage SDA wired fabric border devices"},{"name":"Sensors","description":"Manage sensor test templates"},{"name":"Wireless","description":"Configure and manage SSIDs, Wireless, and RF profiles in non-fabric wireless network"},{"name":"Command Runner","description":"Retrieve real-time device configuration and CLI keywords"},{"name":"Discovery","description":"Discover network devices and manage discovery jobs"},{"name":"Path Trace","description":"Network route and flow analysis"},{"name":"File","description":"Get configuration files by namespace and ID"},{"name":"Task","description":"Get information about asynchronous tasks"},{"name":"Tag","description":"Assign administrator-defined tags to network devices"},{"name":"Application Policy","description":"Create and manage applications, application sets, and application policies"},{"name":"Applications","description":"Intent API to get a list of applications for a specific site, a device, or a client device's MAC address"},{"name":"ITSM","description":"Provide the details of the various third party integrations that are supported"},{"name":"Event Management","description":"Event based notification to external handlers"},{"name":"Security Advisories","description":"Provides the details of advisories on the network and devices"},{"name":"Compliance","description":"Provides compliance status data on the devices"}],"x-parser-conf":{"expand":0,"labelConfig":{"endpoint":"summary"}},"openapi":"3.0.3","servers":[{"url":"/"}]},"spec":{"operationId":"addAnycastGateways","tags":["SDA"],"deprecated":false,"summary":"Add anycast gateways","description":"Adds anycast gateways based on user input.","parameters":[{"name":"Content-Type","description":"Request body content type.","required":true,"schema":{"type":"string","default":"application/json"},"in":"header"}],"requestBody":{"description":"request","content":{"application/json":{"schema":{"type":"array","items":{"type":"object","properties":{"fabricId":{"type":"string","description":"ID of the fabric this anycast gateway is to be assigned to."},"virtualNetworkName":{"type":"string","description":"Name of the layer 3 virtual network associated with the anycast gateway. the virtual network must have already been added to the site before creating an anycast gateway with it."},"ipPoolName":{"type":"string","description":"Name of the IP pool associated with the anycast gateway."},"tcpMssAdjustment":{"type":"integer","description":"TCP maximum segment size adjustment."},"vlanName":{"type":"string","description":"Name of the VLAN of the anycast gateway."},"vlanId":{"type":"integer","description":"ID of the VLAN of the anycast gateway. allowed VLAN range is 2-4093 except for reserved VLANs 1002-1005, 2046, and 4094. if deploying an anycast gateway on a fabric zone, this vlanId must match the vlanId of the corresponding anycast gateway on the fabric site."},"trafficType":{"type":"string","enum":["DATA","VOICE"],"description":"The type of traffic the anycast gateway serves."},"poolType":{"type":"string","enum":["EXTENDED_NODE","FABRIC_AP"],"description":"The pool type of the anycast gateway (required for & applicable only to INFRA_VN)."},"securityGroupName":{"type":"string","description":"Name of the associated Security Group (not applicable to INFRA_VN)."},"isCriticalPool":{"type":"boolean","description":"Enable/disable critical VLAN. if true, autoGenerateVlanName must also be true. (isCriticalPool is not applicable to INFRA_VN)."},"isLayer2FloodingEnabled":{"type":"boolean","description":"Enable/disable layer 2 flooding (not applicable to INFRA_VN)."},"layer2FloodingAddressAssignment":{"type":"string","enum":["SHARED","CUSTOM"],"description":"The source of the flooding address for layer 2 flooding. Layer 2 flooding must be enabled to configure this property. \"SHARED\" means that the anycast gateway will inherit the flooding address from the fabric. \"CUSTOM\" allows the anycast gateway to use a different flooding address (not applicable to INFRA_VN; defaults to \"SHARED\")."},"layer2FloodingAddress":{"type":"string","description":"The flooding address to use for layer 2 flooding. The IP address must be in the 239.0.0.0/8 range. This property is applicable only when the flooding address source is set to \"CUSTOM\"."},"isWirelessPool":{"type":"boolean","description":"Enable/disable fabric-enabled wireless (not applicable to INFRA_VN)."},"isWirelessFloodingEnabled":{"type":"boolean","description":"Enable/disable wireless flooding (not applicable to INFRA_VN; can only be true when isWirelessPool is true)."},"isResourceGuardEnabled":{"type":"boolean","description":"Enable/disable Resource Guard (not applicable to INFRA_VN)."},"isIpDirectedBroadcast":{"type":"boolean","description":"Enable/disable IP-directed broadcast (not applicable to INFRA_VN)."},"isIntraSubnetRoutingEnabled":{"type":"boolean","description":"Enable/disable Intra-Subnet Routing (not applicable to INFRA_VN)."},"isMultipleIpToMacAddresses":{"type":"boolean","description":"Enable/disable multiple IP-to-MAC Addresses (Wireless Bridged-Network Virtual Machine; not applicable to INFRA_VN)."},"isSupplicantBasedExtendedNodeOnboarding":{"type":"boolean","description":"Enable/disable Supplicant-Based Extended Node Onboarding (applicable only to INFRA_VN)."},"isGroupBasedPolicyEnforcementEnabled":{"type":"boolean","description":"Enable/disable Group-Based Policy Enforcement (defaults to false when using INFRA_VN; defaults to true for other VNs)."},"autoGenerateVlanName":{"type":"boolean","description":"This field cannot be true when vlanName is provided. the vlanName will be generated as \"{ipPoolGroupV4Cidr}-{virtualNetworkName}\" for non-critical VLANs. for critical VLANs with DATA trafficType, vlanName will be \"CRITICAL_VLAN\". for critical VLANs with VOICE trafficType, vlanName will be \"VOICE_VLAN\"."}},"required":["fabricId","virtualNetworkName","ipPoolName","trafficType","isCriticalPool","isLayer2FloodingEnabled","isWirelessPool","isIpDirectedBroadcast","isIntraSubnetRoutingEnabled","isMultipleIpToMacAddresses","autoGenerateVlanName"]},"description":"Anycast gateway post request body.","$$ref":"#/components/schemas/addAnycastGatewaysRequest"}}},"required":true},"responses":{"200":{"description":"","content":{"application/json":{"schema":{"type":"object","properties":{"response":{"type":"object","properties":{"taskId":{"type":"string","description":"ID of the task."},"url":{"type":"string","description":"Task status lookup url."}},"required":["taskId","url"],"description":"Response body."},"version":{"type":"string","description":"Version number."}},"required":["response","version"],"description":"Asynchronous response.","$$ref":"#/components/schemas/addAnycastGatewaysResponse"}}}},"202":{"description":"Request Accepted. Further tracking information available in response body.","content":{}},"400":{"description":"Request failed due to malformed request syntax.","content":{}},"404":{"description":"Request Failed because the resource does not exist.","content":{}},"500":{"description":"Request failed because of unknown failure on the server.","content":{}}},"x-rapi-id":"a6fa-2ce6-46ac-7ac5","x-rapi-overview":"Adds anycast gateways based on user input.","x-rapi-domain":"Connectivity","x-rapi-subdomain":"SDA","x-rapi-version":"1.0.0","x-rapi-internalPath":"/api/v1/sda-helper-service/sda-open-api/anycastGateways","x-rapi-publicPath":"/dna/intent/api/v1/sda/anycastGateways","x-rapi-registerInKONG":true,"x-rapi-banner":["Intent"],"x-rapi-deprecationMessage":"","x-rapi-rateLimiting":"50~MINUTE","__originalOperationId":"addAnycastGateways","method":"post","path":"/dna/intent/api/v1/sda/anycastGateways"}}