{"type":"model","meta":{"id":"/apps/pubhub/media/crosswork-network-controller-7-2/76fd4bb9d069fd2530d7a02f0b3a4ca00eccfd35/aec5c4a2-bcff-3f98-bfdb-2d20859244c1","info":{"title":"Crosswork ClusterManager API","description":"ClusterManager provides API methods for managing Crosswork cluster. This includes getting cluster and node summary, getting cluster and node health information. It also provides APIs to collect showtech, rebalance cluster and set or get login banner.","version":"7.2.0","contact":{"name":"Crosswork Team, Cisco","email":"support@cisco.com"},"license":{"name":"Cisco Software License Agreement","url":"https://www.cisco.com/public/sw-license-agreement.html"}},"security":[{"bearerAuth":[]}],"x-parser-conf":{"overview":{"markdownPath":"reference/INFRA/CLUSTER/cluster-overview.md"}},"openapi":"3.0.1","servers":[{"url":"https://{cw_ip}:30603/crosswork/platform/v2","description":"Generated server url"}],"securitySchemes":{"api_key":{"description":"security definitions details","type":"apiKey","name":"Authorization","in":"header"},"bearerAuth":{"type":"http","scheme":"bearer","bearerFormat":"JWT","description":"JWT Authorization header using the Bearer scheme. Example: \"Authorization: Bearer {token}\""}}},"spec":{"description":"Response for collection job information request","type":"object","properties":{"Result":{"description":"ResultValue indicates the outcome of an operation","type":"string","enum":["NOOP","SUCCESS","FAILURE"],"default":"NOOP","$$ref":"#/components/schemas/clusterResultValue"},"Description":{"description":"Additional information regarding the response","type":"string","title":"Additional information regarding the response"},"CollectJobs":{"description":"Array of collection job objects","type":"array","items":{"description":"Details of collect job","type":"object","properties":{"Id":{"description":"Unique identifier for the collect job","type":"string","title":"Unique Collect Job Id"},"JobScope":{"description":"Scope of the collect job","type":"string"},"Type":{"description":"Type of collection job to be performed","type":"string","enum":["_","All","Logs","Metrics"],"default":"_","$$ref":"#/components/schemas/clusterCollectType"},"JobStatus":{"description":"Status of an asynchronous job","type":"string","enum":["JobUnknown","JobCreated","JobInProgress","JobCompleted","JobFailed"],"default":"JobUnknown","$$ref":"#/components/schemas/clusterjobStatus"},"User":{"description":"User who initiated the collect job","type":"string"},"CreationTime":{"description":"Timestamp when the collect job was created","type":"string"},"Description":{"description":"Additional information regarding the collect job","type":"string","title":"Additional information regarding the job"},"CompletionTime":{"description":"Timestamp when the collect job was completed","type":"string"},"IsPurged":{"description":"Indicates whether the collect job has been purged","type":"boolean"}},"$$ref":"#/components/schemas/CollectOpResultcollectJob"}}},"example":{"Result":"SUCCESS","Description":"","CollectJobs":[{"Id":"20250305124702","JobScope":"All","Type":"All","JobStatus":"JobInProgress","User":"admin","CreationTime":"2025-03-05T12:47:02Z","Description":"Job in progress. Progress completed: 97.4%","CompletionTime":"","IsPurged":false}]},"$$ref":"#/components/schemas/clusterCollectOpResult","title":"clusterCollectOpResult"}}