{"type":"api","title":"Wireless Controller Provision Status","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":"wirelessControllerProvisionStatus","tags":["Wireless"],"summary":"Wireless Controller Provision Status","deprecated":false,"description":"Retrieves wireless controller's provision status","parameters":[{"name":"networkDeviceId","description":"Obtain the networkDeviceId value by using the API call GET: /dna/intent/api/v1/network-device/ip-address/${ipAddress}.","required":true,"schema":{"type":"string","default":"application/json"},"in":"path"}],"responses":{"200":{"description":"Request was successful and the result is contained in the response body.","content":{"application/json":{"schema":{"type":"object","properties":{"response":{"type":"object","properties":{"networkDeviceId":{"type":"string","description":"The unique identifier for the network device."},"deviceName":{"type":"string","description":"The name of the device."},"siteId":{"type":"string","description":"The physical site ID."},"siteNameHierarchy":{"type":"string","description":"The site name hierarchy."},"networkIntentProvisionStatus":{"type":"string","enum":["NOT_STARTED","SUCCESS","FAILED","CONFIGURING","ROLLBACK_SUCCESS","ROLLBACK_FAILURE","ABORTED","PENDING"],"description":"The provisioning status of the device for network intent provision."},"modelConfigProvisionStatus":{"type":"string","enum":["NOT_STARTED","SUCCESS","FAILED","CONFIGURING","ROLLBACK_SUCCESS","ROLLBACK_FAILURE","ABORTED","PENDING"],"description":"The provisioning status of the device for model config(feature template) provision."},"lastProvisionedTimeStamp":{"type":"string","description":"Epoch time of last provision.'null' if 'NOT_STARTED'"},"outOfSync":{"type":"boolean","description":"Indicates there is a design change since last provision resulting in out of sync of settings between intent and device configuation. Please note,this does not indicate compliance difference. Will be 'false' if device's provision status is 'NOT_STARTED'."}},"required":["networkDeviceId","deviceName","networkIntentProvisionStatus","modelConfigProvisionStatus","outOfSync"],"description":"Schema for Controller Provisioning Status"},"version":{"type":"string","description":"Version"}},"description":"","$$ref":"#/components/schemas/wirelessControllerProvisionStatusResponse"}}}},"400":{"description":"The client made a request that the server could not understand (for example, the request syntax is incorrect).","content":{}},"404":{"description":"The client made a request for a resource that does not exist.","content":{}},"500":{"description":"The server could not fulfill the request.","content":{}}},"x-rapi-id":"6386-daf1-4439-a4df","x-rapi-overview":"Retrieves wireless controller's provision status","x-rapi-domain":"Connectivity","x-rapi-subdomain":"Wireless","x-rapi-version":"1.0.0","x-rapi-internalPath":"/dna/intent/api/v1/wirelessControllers/${networkDeviceId}/provisionStatus","x-rapi-publicPath":"/dna/intent/api/v1/wirelessControllers/${networkDeviceId}/provisionStatus","x-rapi-registerInKONG":false,"x-rapi-banner":["Intent"],"x-rapi-deprecationMessage":"","__originalOperationId":"wirelessControllerProvisionStatus","method":"get","path":"/dna/intent/api/v1/wirelessControllers/{networkDeviceId}/provisionStatus"}}