{"type":"model","meta":{"id":"/apps/pubhub/media/cisco-catalyst-center-api-2-3-7-9/b3d6cc9fb9f506b3bc9099912aa8a6f9d87e0f0a/6a3cd7ca-617e-374c-a10b-740a529a993e","info":{"title":"Intent API","description":"Cisco Catalyst Center Platform v. 2.3.7.9","version":"2.3.7.9"},"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.1","servers":[{"url":"/"}]},"spec":{"type":"object","properties":{"ipconfig":{"type":"array","items":{"type":"object","properties":{"interface":{"type":"string","enum":["enterprise","management"],"description":"Enterprise or Management interface"},"vip":{"type":"boolean","description":"Is this interface an Virtual IP address or not. This is true for Global DR VIP"},"ip":{"type":"string","description":"This floating virtual IP address automatically moves to and operates on the site that is currently acting as your network's active site. If the interface is enterprise, then this address manages traffic between your disaster recovery system and your Enterprise network. If the interface is management, then this address manages traffic between your disaster recovery system and your Management network. "}}},"description":"Disaster Recovery Global Virtual IP Address"},"site":{"type":"string","enum":["main","recovery"],"description":"Site of the disaster recovery system. "},"main":{"type":"object","properties":{"ipconfig":{"type":"array","items":{"type":"object","properties":{"interface":{"type":"string","enum":["enterprise","management"],"description":"Enterprise or Management interface"},"vip":{"type":"boolean","description":"Is this interface an Virtual IP address or not. This is true for cluster level."},"ip":{"type":"string","description":"This floating virtual IP address automatically moves to and operates on the site that is currently acting as your network's active site. If the interface is enterprise, then this address manages traffic between your disaster recovery system and your Enterprise network. If the interface is management, then this address manages traffic between your disaster recovery system and your Management network."}}},"description":"Disaster Recovery Cluster Virtual IP Address"},"state":{"type":"string","enum":["Unregistered","Registering","Registered","RegisterFailed","Configuring","Active","ConfigureFailed","FailingOver","StandbyReady","FailoverFailed","Standby","Isolating","Isolated","IsolateFailed","Pausing","Paused","PauseFailed","ActiveStandAlone","StandbyStandAlone","Partitioned","Deregistering","DeregisterFailed","Up","Down"],"description":"State of the Main Site. "},"nodes":{"type":"array","items":{"type":"object","properties":{"hostname":{"type":"string","description":"Hostname of the node"},"state":{"type":"string","enum":["up","down","unknown"],"description":"State of the node"},"ipaddresses":{"type":"array","items":{"type":"object","properties":{"interface":{"type":"string","enum":["enterprise","management"],"description":"Enterprise or Management interface"},"vip":{"type":"boolean","description":"Is this interface a Virtual IP address or not. This is false for node level."},"ip":{"type":"string","description":"Node IP address"}}},"description":"Node Level IP Addresses"}}},"description":"Main Node Details. Node Details are displayed only when summary request parameter is false."}},"description":"Main is the first site you configure when setting up your disaster recovery system."},"recovery":{"type":"object","properties":{"ipconfig":{"type":"array","items":{"type":"object","properties":{"interface":{"type":"string","enum":["enterprise","management"],"description":"Enterprise or Management interface"},"vip":{"type":"boolean","description":"Is this interface an Virtual IP address or not. This is true for cluster level."},"ip":{"type":"string","description":"This floating virtual IP address automatically moves to and operates on the site that is currently acting as your network's active site. If the interface is enterprise, then this address manages traffic between your disaster recovery system and your Enterprise network. If the interface is management, then this address manages traffic between your disaster recovery system and your Management network."}}},"description":"Disaster Recovery Cluster Virtual IP Address"},"state":{"type":"string","enum":["Unregistered","Registering","Registered","RegisterFailed","Configuring","Active","ConfigureFailed","FailingOver","StandbyReady","FailoverFailed","Standby","Isolating","Isolated","IsolateFailed","Pausing","Paused","PauseFailed","ActiveStandAlone","StandbyStandAlone","Partitioned","Deregistering","DeregisterFailed","Up","Down"],"description":"State of the Recovery site"},"nodes":{"type":"array","items":{"type":"object","properties":{"hostname":{"type":"string","description":"Hostname of the node"},"state":{"type":"string","enum":["up","down","unknown"],"description":"State of the node"},"ipconfig":{"type":"array","items":{"type":"object","properties":{"interface":{"type":"string","enum":["enterprise","management"],"description":"Enterprise or Management interface"},"vip":{"type":"boolean","description":"Is this interface a Virtual IP Address or not. This is false for node level."},"ip":{"type":"string","description":"Node IP Address"}}},"description":"Node Level IP Addresses"}}},"description":"Recovery Node Details. Node Details are displayed only when summary request parameter is false."}},"description":"The second site you configure when setting up your disaster recovery system. "},"witness":{"type":"object","properties":{"ipconfig":{"type":"array","items":{"type":"object","properties":{"interface":{"type":"string","description":"Enterprise or Management interface"},"vip":{"type":"boolean","description":"Is this interface an Virtual IP address or not. This is false for witness."},"ip":{"type":"string","description":"In case of witness, this is only an IP. "}}},"description":"Disaster Recovery Cluster Virtual IP Address"},"state":{"type":"string","enum":["Unregistered","Registering","Registered","RegisterFailed","Up","Down","Pausing","PauseFailed","Paused","Deregistering","DeregisterFailed"],"description":"State of the Witness Site"},"nodes":{"type":"array","items":{"type":"object","properties":{"hostname":{"type":"string","description":"Hostname of the witness node"},"state":{"type":"string","enum":["up","down","unknown"],"description":"State of the node"},"ipconfig":{"type":"array","items":{"type":"object","properties":{"interface":{"type":"string","description":"Enterprise or Management interface"},"vip":{"type":"boolean","description":"Is this interface an Virtual IP address or not. This is false for Witness "},"ip":{"type":"string","description":"In case of witness, this is only an IP"}}},"description":"Node Level IP Addresses"}}},"description":"Witness Node Details. Node Details are displayed only when summary request parameter is false."}},"description":"The third site you configure when setting up your disaster recovery system. "},"state":{"type":"string","enum":["Unconfigured","Registering","Registered","Deregistering","Deregistered","Configuring","ConfigureFailed","Up","FailingOver","FailoverFailed","Pausing","Paused","PauseFailed","Down"],"description":"State of the Disaster Recovery System."},"ipsec-tunnel":{"type":"array","items":{"type":"object","properties":{"side_a":{"type":"string","description":"A Side of the IPSec Tunnel"},"side_b":{"type":"string","description":"Other Side of the IPSec Tunnel "},"status":{"type":"string","enum":["up","down"],"description":"Status of this IPSec Tunnel"}}},"description":"IPSec Tunnel Status between main, recovery and witness"}},"description":"","$$ref":"#/components/schemas/DisasterRecoveryStatusResponse","title":"DisasterRecoveryStatusResponse"}}