@itentialopensource/adapter-f5_bigiq

{ "openapi": "3.0.0", "info": { "title": "Itential", "contact": {}, "version": "1.0" }, "servers": [ { "url": "https://info", "variables": {} }, { "url": "https://mgmt", "variables": {} } ], "paths": { "/mgmt/cm/system/machineid-resolver": { "get": { "tags": [ "BIG-IP UUID Lookup" ], "summary": "Resolve machineId", "operationId": "getResolveMachineId", "parameters": [ { "name": "$filter", "in": "query", "description": "", "required": false, "style": "form", "explode": false, "schema": { "type": "string", "example": "('hostname'+eq+'BOS-vBIGIP01.termmarc.com')" } } ], "responses": { "200": { "description": "", "headers": {} } }, "deprecated": false, "servers": [ { "url": "https://mgmt", "variables": {} } ] } }, "/mgmt/cm/autodeploy/qkview/example": { "get": { "tags": [ "Qkview" ], "summary": "EXAMPLE - Qkview", "operationId": "getExampleQkview", "parameters": [], "responses": { "200": { "description": "", "headers": {} } }, "deprecated": false, "servers": [ { "url": "https://mgmt", "variables": {} } ] } }, "/mgmt/cm/autodeploy/qkview": { "get": { "tags": [ "Qkview" ], "summary": "Retrieve Qkview Tasks", "operationId": "RetrieveQkviewTasks", "parameters": [], "responses": { "200": { "description": "", "headers": {} } }, "deprecated": false, "servers": [ { "url": "https://mgmt", "variables": {} } ] }, "post": { "tags": [ "Qkview" ], "summary": "Generate a Qkview", "operationId": "GenerateaQkview", "parameters": [], "requestBody": { "description": "", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/GenerateaBIG-IQQkviewRequest" }, { "example": { "name": "test-bigiq-qkview.qkview" } } ] }, "example": { "name": "test-bigiq-qkview.qkview" } } }, "required": true }, "responses": { "200": { "description": "", "headers": {} } }, "deprecated": false, "servers": [ { "url": "https://mgmt", "variables": {} } ] } }, "/mgmt/cm/autodeploy/qkview/{BIGIQ-QKVIEW-TASK-ID}": { "get": { "tags": [ "Qkview" ], "summary": "Query BIG-IQ Qkview Task", "operationId": "QueryBIG-IQQkviewTask", "parameters": [ { "name": "BIGIQ-QKVIEW-TASK-ID", "in": "path", "description": "", "required": true, "style": "simple", "schema": { "type": "string" } } ], "responses": { "200": { "description": "", "headers": {} } }, "deprecated": false, "servers": [ { "url": "https://mgmt", "variables": {} } ] }, "delete": { "tags": [ "Qkview" ], "summary": "Delete BIG-IQ Qkview", "operationId": "DeleteBIG-IQQkview", "parameters": [ { "name": "BIGIQ-QKVIEW-TASK-ID", "in": "path", "description": "", "required": true, "style": "simple", "schema": { "type": "string" } } ], "responses": { "200": { "description": "", "headers": {} } }, "deprecated": false, "servers": [ { "url": "https://mgmt", "variables": {} } ] } }, "/mgmt/cm/device/ihealth/reports/example": { "get": { "tags": [ "BIG-IP iHealth" ], "summary": "EXAMPLE - BIG-IP iHealth Report", "operationId": "getExample-BIG-IPiHealthReport", "parameters": [], "responses": { "200": { "description": "", "headers": {} } }, "deprecated": false, "servers": [ { "url": "https://mgmt", "variables": {} } ] } }, "/mgmt/cm/device/ihealth/uploads/example": { "get": { "tags": [ "BIG-IP iHealth" ], "summary": "EXAMPLE - BIG-IP iHealth Uploads", "operationId": "getExample-BIG-IPiHealthUploads", "parameters": [], "responses": { "200": { "description": "", "headers": {} } }, "deprecated": false, "servers": [ { "url": "https://mgmt", "variables": {} } ] } }, "/mgmt/cm/device/ihealth/credentials/example": { "get": { "tags": [ "BIG-IP iHealth" ], "summary": "EXAMPLE - BIG-IP iHealth Credentials", "operationId": "getExample-BIG-IPiHealthCredentials", "parameters": [], "responses": { "200": { "description": "", "headers": {} } }, "deprecated": false, "servers": [ { "url": "https://mgmt", "variables": {} } ] } }, "/mgmt/cm/device/ihealth/config/example": { "get": { "tags": [ "BIG-IP iHealth" ], "summary": "EXAMPLE - BIG-IP iHealth Config", "operationId": "getExample-BIG-IPiHealthConfig", "parameters": [], "responses": { "200": { "description": "", "headers": {} } }, "deprecated": false, "servers": [ { "url": "https://mgmt", "variables": {} } ] } }, "/mgmt/cm/device/ihealth/reports": { "get": { "tags": [ "BIG-IP iHealth" ], "summary": "Retrieve BIG-IP iHealth Reports", "operationId": "RetrieveBIG-IPiHealthReports", "parameters": [], "responses": { "200": { "description": "", "headers": {} } }, "deprecated": false, "servers": [ { "url": "https://mgmt", "variables": {} } ] }, "post": { "tags": [ "BIG-IP iHealth" ], "summary": "Generate BIG-IP iHealth Report", "operationId": "GenerateBIG-IPiHealthReport", "parameters": [], "requestBody": { "description": "", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/GenerateBIG-IPiHealthReportRequest" }, { "example": { "name": "testing-api-uploads", "deviceReferences": [ { "link": "" } ], "credentialsReference": { "link": "" } } } ] }, "example": { "name": "testing-api-uploads", "deviceReferences": [ { "link": "" } ], "credentialsReference": { "link": "" } } } }, "required": true }, "responses": { "200": { "description": "", "headers": {} } }, "deprecated": false, "servers": [ { "url": "https://mgmt", "variables": {} } ] } }, "/mgmt/cm/device/ihealth/credentials": { "get": { "tags": [ "BIG-IP iHealth" ], "summary": "Retrieve BIG-IP iHealth Credentials", "operationId": "RetrieveBIG-IPiHealthCredentials", "parameters": [ { "name": "$filter", "in": "query", "description": "", "required": false, "style": "form", "explode": true, "schema": { "type": "string", "example": "displayName eq 'ihealth2-testing'" } } ], "responses": { "200": { "description": "", "headers": {} } }, "deprecated": false, "servers": [ { "url": "https://mgmt", "variables": {} } ] }, "post": { "tags": [ "BIG-IP iHealth" ], "summary": "Create Test BIG-IP iHealth Credentials", "operationId": "CreateTestBIG-IPiHealthCredentials", "parameters": [], "requestBody": { "description": "", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/CreateTestBIG-IPiHealthCredentialsRequest" }, { "example": { "displayName": "ihealth2-testing", "description": "Testing for Itential", "username": "", "password": "" } } ] }, "example": { "displayName": "ihealth2-testing", "description": "Testing for Itential", "username": "", "password": "" } } }, "required": true }, "responses": { "200": { "description": "", "headers": {} } }, "deprecated": false, "servers": [ { "url": "https://mgmt", "variables": {} } ] } }, "/mgmt/cm/device/ihealth/config": { "get": { "tags": [ "BIG-IP iHealth" ], "summary": "Retrieve BIG-IP iHealth Config", "operationId": "RetrieveBIG-IPiHealthConfig", "parameters": [], "responses": { "200": { "description": "", "headers": {} } }, "deprecated": false, "servers": [ { "url": "https://mgmt", "variables": {} } ] }, "put": { "tags": [ "BIG-IP iHealth" ], "summary": "Update BIG-IP iHealth Config", "operationId": "UpdateBIG-IPiHealthConfig", "parameters": [], "requestBody": { "description": "", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/UpdateBIG-IPiHealthConfigRequest" }, { "example": { "concurrentUploadCount": 5, "concurrentDownloadCount": 5, "iHealthEndpoint": "https://ihealth-api.f5networks.net/qkview-analyzer/api/", "iHealthAuthEndpoint": "https://identity.account.f5.com/oauth2/ausp95ykc80HOU7SQ357/v1/token" } } ] }, "example": { "concurrentUploadCount": 5, "concurrentDownloadCount": 5, "iHealthEndpoint": "https://ihealth-api.f5networks.net/qkview-analyzer/api/", "iHealthAuthEndpoint": "https://identity.account.f5.com/oauth2/ausp95ykc80HOU7SQ357/v1/token" } } }, "required": true }, "responses": { "200": { "description": "", "headers": {} } }, "deprecated": false, "servers": [ { "url": "https://mgmt", "variables": {} } ] } }, "/mgmt/cm/device/ihealth/uploads": { "get": { "tags": [ "BIG-IP iHealth" ], "summary": "Retrieve BIG-IP iHealth Uploads", "operationId": "RetrieveBIG-IPiHealthUploads", "parameters": [], "responses": { "200": { "description": "", "headers": {} } }, "deprecated": false, "servers": [ { "url": "https://mgmt", "variables": {} } ] }, "post": { "tags": [ "BIG-IP iHealth" ], "summary": "Create BIG-IP iHealth Upload Task", "operationId": "CreateBIG-IPiHealthUploadTask", "parameters": [], "requestBody": { "description": "", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/CreateBIG-IPiHealthUploadTaskRequest" }, { "example": { "name": "testing-api-uploads", "deviceReferences": [ { "link": "" } ], "credentialsReference": { "link": "" } } } ] }, "example": { "name": "testing-api-uploads", "deviceReferences": [ { "link": "" } ], "credentialsReference": { "link": "" } } } }, "required": true }, "responses": { "200": { "description": "", "headers": {} } }, "deprecated": false, "servers": [ { "url": "https://mgmt", "variables": {} } ] } }, "/mgmt/cm/device/ihealth/uploads/{iHealthUploadTaskId}": { "get": { "tags": [ "BIG-IP iHealth" ], "summary": "Query Upload Task Status", "operationId": "QueryUploadTaskStatus", "parameters": [ { "name": "iHealthUploadTaskId", "in": "path", "description": "", "required": true, "style": "simple", "schema": { "type": "string" } } ], "responses": { "200": { "description": "", "headers": {} } }, "deprecated": false, "servers": [ { "url": "https://mgmt", "variables": {} } ] } }, "/mgmt/cm/device/ihealth/credentials/{credentialsId}": { "patch": { "tags": [ "BIG-IP iHealth" ], "summary": "Modify Test BIG-IP iHealth Credentials", "operationId": "ModifyTestBIG-IPiHealthCredentials", "parameters": [ { "name": "credentialsId", "in": "path", "description": "", "required": true, "style": "simple", "schema": { "type": "string" } } ], "requestBody": { "description": "", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/ModifyTestBIG-IPiHealthCredentialsRequest" }, { "example": { "displayName": "ihealth2-testing", "description": "Testing for Itential", "username": "0oas5oa1j8C1vDEyV357", "encryptedPassword": "ttZNs4dlnYnR6afp8yrDuhqJmOCN5yNG3ou6NSJjYuu0o7UC0L93hiBFZc9bA+rUTOaATvZc8CBbj1zkIr4R0Q==" } } ] }, "example": { "displayName": "ihealth2-testing", "description": "Testing for Itential", "username": "0oas5oa1j8C1vDEyV357", "encryptedPassword": "ttZNs4dlnYnR6afp8yrDuhqJmOCN5yNG3ou6NSJjYuu0o7UC0L93hiBFZc9bA+rUTOaATvZc8CBbj1zkIr4R0Q==" } } }, "required": true }, "responses": { "200": { "description": "", "headers": {} } }, "deprecated": false, "servers": [ { "url": "https://mgmt", "variables": {} } ] }, "delete": { "tags": [ "BIG-IP iHealth" ], "summary": "Delete Test BIG-IP iHealth Credentials", "operationId": "DeleteTestBIG-IPiHealthCredentials", "parameters": [ { "name": "credentialsId", "in": "path", "description": "", "required": true, "style": "simple", "schema": { "type": "string" } } ], "responses": { "200": { "description": "", "headers": {} } }, "deprecated": false, "servers": [ { "url": "https://mgmt", "variables": {} } ] } }, "/info/system": { "get": { "tags": [ "BIG-IQ System/Cluster Status" ], "summary": "Verify Proper System Status", "operationId": "VerifyProperSystemStatus", "parameters": [], "responses": { "200": { "description": "", "headers": {} } }, "deprecated": false, "servers": [ { "url": "https://info", "variables": {} } ] } }, "/mgmt/shared/failover-state": { "get": { "tags": [ "BIG-IQ System/Cluster Status" ], "summary": "Verify Proper HA Status", "operationId": "VerifyProperHAStatus", "parameters": [], "responses": { "200": { "description": "", "headers": {} } }, "deprecated": false, "servers": [ { "url": "https://mgmt", "variables": {} } ] } }, "/mgmt/cm/system/backup-restore/example": { "get": { "tags": [ "Device Backups" ], "summary": "EXAMPLE - Backup/Restore Task", "operationId": "getExample-Backup/RestoreTask", "parameters": [ { "name": "Content-Type", "in": "header", "description": "", "required": true, "style": "simple", "schema": { "enum": [ "application/json" ], "type": "string", "example": "application/json" } } ], "responses": { "200": { "description": "", "headers": {} } }, "deprecated": false, "servers": [ { "url": "https://mgmt", "variables": {} } ] } }, "/mgmt/cm/system/backup-restore": { "get": { "tags": [ "Device Backups" ], "summary": "Retrieve all Backup Tasks", "operationId": "RetrieveallBackupTasks", "parameters": [ { "name": "Content-Type", "in": "header", "description": "", "required": true, "style": "simple", "schema": { "enum": [ "application/json" ], "type": "string", "example": "application/json" } } ], "responses": { "200": { "description": "", "headers": {} } }, "deprecated": false, "servers": [ { "url": "https://mgmt", "variables": {} } ] }, "post": { "tags": [ "Device Backups" ], "summary": "Generate Backup of Device", "operationId": "GenerateBackupofDevice", "parameters": [], "requestBody": { "description": "", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/GenerateBackupofDeviceRequest" }, { "example": { "name": "testing3-task.ucs", "includePrivateKeys": true, "isEncrypted": false, "deviceReference": { "link": "" }, "backupLifeTime": 1, "description": "Itential testing" } } ] }, "example": { "name": "testing3-task.ucs", "includePrivateKeys": true, "isEncrypted": false, "deviceReference": { "link": "" }, "backupLifeTime": 1, "description": "Itential testing" } } }, "required": true }, "responses": { "200": { "description": "", "headers": {} } }, "deprecated": false, "servers": [ { "url": "https://mgmt", "variables": {} } ] } }, "/mgmt/cm/system/backup-restore/{backupTaskId}": { "get": { "tags": [ "Device Backups" ], "summary": "Query Backup Task Status", "operationId": "QueryBackupTaskStatus", "parameters": [ { "name": "Content-Type", "in": "header", "description": "", "required": true, "style": "simple", "schema": { "enum": [ "application/json" ], "type": "string", "example": "application/json" } }, { "name": "backupTaskId", "in": "path", "description": "", "required": true, "style": "simple", "schema": { "type": "string" } } ], "responses": { "200": { "description": "", "headers": {} } }, "deprecated": false, "servers": [ { "url": "https://mgmt", "variables": {} } ] }, "delete": { "tags": [ "Device Backups" ], "summary": "Delete Backup File", "operationId": "DeleteBackupFile", "parameters": [ { "name": "Content-Type", "in": "header", "description": "", "required": true, "style": "simple", "schema": { "enum": [ "application/json" ], "type": "string", "example": "application/json" } }, { "name": "backupTaskId", "in": "path", "description": "", "required": true, "style": "simple", "schema": { "type": "string" } } ], "responses": { "200": { "description": "", "headers": {} } }, "deprecated": false, "servers": [ { "url": "https://mgmt", "variables": {} } ] } }, "/info/filedownload": { "post": { "tags": [ "Device Backups" ], "summary": "Generate Backup File Download Path Hash", "operationId": "GenerateBackupFileDownloadPathHash", "parameters": [], "requestBody": { "description": "", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/GenerateBackupFileDownloadPathHashRequest" }, { "example": { "path": "/mgmt/cm/system/backup-download/testing3-task.ucs", "supportsBlob": true, "downloadFilename": "testing3-task.ucs" } } ] }, "example": { "path": "/mgmt/cm/system/backup-download/testing3-task.ucs", "supportsBlob": true, "downloadFilename": "testing3-task.ucs" } } }, "required": true }, "responses": { "200": { "description": "", "headers": {} } }, "deprecated": false, "servers": [ { "url": "https://info", "variables": {} } ] } }, "/info/filedownload/{pathHash}": { "get": { "tags": [ "Device Backups" ], "summary": "Download Backup File using Path Hash", "operationId": "DownloadBackupFileusingPathHash", "parameters": [ { "name": "pathHash", "in": "path", "description": "", "required": true, "style": "simple", "schema": { "type": "string" } } ], "responses": { "200": { "description": "", "headers": {} } }, "deprecated": false, "servers": [ { "url": "https://info", "variables": {} } ] } }, "/mgmt/shared/user-scripts/example": { "get": { "tags": [ "BIG-IP TMSH Scripting" ], "summary": "EXAMPLE - BIG-IP scripts", "operationId": "getExample-BIG-IPscripts", "parameters": [], "responses": { "200": { "description": "", "headers": {} } }, "deprecated": false, "servers": [ { "url": "https://mgmt", "variables": {} } ] } }, "/mgmt/shared/user-scripts": { "get": { "tags": [ "BIG-IP TMSH Scripting" ], "summary": "Retrieve all BIG-IP scripts", "operationId": "RetrieveallBIG-IPscripts", "parameters": [], "responses": { "200": { "description": "", "headers": {} } }, "deprecated": false, "servers": [ { "url": "https://mgmt", "variables": {} } ] }, "post": { "tags": [ "BIG-IP TMSH Scripting" ], "summary": "Create a BIG-IP script", "operationId": "CreateaBIG-IPscript", "parameters": [], "requestBody": { "description": "", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/CreateaBIG-IPscriptRequest" }, { "example": { "name": "check service check date", "description": "returns the service check date from the license", "script": "tmsh show sys license | grep 'Service Check Date'" } } ] }, "example": { "name": "check service check date", "description": "returns the service check date from the license", "script": "tmsh show sys license | grep 'Service Check Date'" } } }, "required": true }, "responses": { "200": { "description": "", "headers": {} } }, "deprecated": false, "servers": [ { "url": "https://mgmt", "variables": {} } ] } }, "/mgmt/shared/user-script-execution": { "post": { "tags": [ "BIG-IP TMSH Scripting" ], "summary": "Execute a BIG-IP script", "operationId": "ExecuteaBIG-IPscript", "parameters": [], "requestBody": { "description": "", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/ExecuteaBIG-IPscriptRequest" }, { "example": { "name": "check service check date", "deviceReferences": [ { "link": "" } ], "timeout": 30, "scriptReference": { "link": "" } } } ] }, "example": { "name": "check service check date", "deviceReferences": [ { "link": "" } ], "timeout": 30, "scriptReference": { "link": "" } } } }, "required": true }, "responses": { "200": { "description": "", "headers": {} } }, "deprecated": false, "servers": [ { "url": "https://mgmt", "variables": {} } ] } }, "/mgmt/shared/user-script-execution/{scriptTaskId}": { "get": { "tags": [ "BIG-IP TMSH Scripting" ], "summary": "Query BIG-IP script status", "operationId": "QueryBIG-IPscriptstatus", "parameters": [ { "name": "scriptTaskId", "in": "path", "description": "", "required": true, "style": "simple", "schema": { "type": "string" } } ], "responses": { "200": { "description": "", "headers": {} } }, "deprecated": false, "servers": [ { "url": "https://mgmt", "variables": {} } ] } }, "/mgmt/cm/autodeploy/software-images": { "get": { "tags": [ "BIG-IP Software Image Management" ], "summary": "Retrieve all Software Images", "operationId": "RetrieveallSoftwareImages", "parameters": [ { "name": "$filter", "in": "query", "description": "", "required": false, "style": "form", "explode": true, "schema": { "type": "string", "example": "product eq 'BIG-IP'" } }, { "name": "$orderby", "in": "query", "description": "", "required": false, "style": "form", "explode": true, "schema": { "type": "string", "example": "filename asc" } } ], "responses": { "200": { "description": "", "headers": {} } }, "deprecated": false, "servers": [ { "url": "https://mgmt", "variables": {} } ] } }, "/mgmt/cm/device/upgrades": { "get": { "tags": [ "Device Upgrades" ], "summary": "Retrieve all upgrade tasks", "operationId": "RetrievaallUpgradeTasks", "parameters": [], "responses": { "200": { "description": "", "headers": {} } }, "deprecated": false, "servers": [ { "url": "https://mgmt", "variables": {} } ] }, "post": { "tags": [ "Device Upgrades" ], "summary": "Perform software upgrade", "operationId": "PerformSoftwareUpgrade", "parameters": [], "requestBody": { "description": "", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/NewRequestRequest" }, { "example": { "name": "mybackuptask", "softwareImageReference": { "link": "https://localhost/mgmt/cm/autodeploy/software-images/BIGIP-16.1.2.1-0.0.11.iso" }, "stopBeforeInstall": true, "stopBeforeReboot": true, "stopForBackups": true, "serialMode": true, "stopForAssessments": true, "selectByDevice": true, "deviceInput": [ { "deviceReference": { "link": "https://localhost/mgmt/shared/resolver/device-groups/cm-bigip-allBigIpDevices/devices/ba7382a4-7564-4647-b65d-17d6f2a73a16" }, "targetVolume": "HD1.2", "active": "HD1.1" } ], "stopToReview": true } } ] }, "example": { "name": "mybackuptask", "softwareImageReference": { "link": "https://localhost/mgmt/cm/autodeploy/software-images/BIGIP-16.1.2.1-0.0.11.iso" }, "stopBeforeInstall": true, "stopBeforeReboot": true, "stopForBackups": true, "serialMode": true, "stopForAssessments": true, "selectByDevice": true, "deviceInput": [ { "deviceReference": { "link": "https://localhost/mgmt/shared/resolver/device-groups/cm-bigip-allBigIpDevices/devices/ba7382a4-7564-4647-b65d-17d6f2a73a16" }, "targetVolume": "HD1.2", "active": "HD1.1" } ], "stopToReview": true } } }, "required": true }, "responses": { "200": { "description": "", "headers": {} } }, "deprecated": false, "servers": [ { "url": "https://mgmt", "variables": {} } ] } }, "/mgmt/shared/resolver/device-groups/cm-bigip-allBigIpDevices/devices": { "get": { "tags": [ "BIG-IP Software Image Management" ], "summary": "Retrieve all BIG-IPs and image slots", "operationId": "RetrieveallBIG-IPsandimageslots", "parameters": [ { "name": "$filter", "in": "query", "description": "", "required": false, "style": "form", "explode": true, "schema": { "type": "string", "example": "state eq 'ACTIVE'" } } ], "responses": { "200": { "description": "", "headers": {} } }, "deprecated": false, "servers": [ { "url": "https://mgmt", "variables": {} } ] } }, "/mgmt/shared/resolver/device-groups/cm-bigip-allDevices/devices": { "get": { "tags": [ "Device" ], "summary": "Retrieve BIG-IP devices", "operationId": "RetrieveBIG-IPdevices", "parameters": [ { "name": "$select", "in": "query", "description": "", "required": false, "style": "form", "explode": true, "schema": { "type": "string", "example": "hostname,managementAddress,machineId" } }, { "name": "$filter", "in": "query", "description": "", "required": false, "style": "form", "explode": true, "schema": { "type": "string", "example": "(managementAddress eq '10.1.1.7')" } } ], "responses": { "200": { "description": "", "headers": {} } }, "deprecated": false, "servers": [ { "url": "https://mgmt", "variables": {} } ] } }, "/mgmt/cm/global/tasks/device-import": { "get": { "tags": [ "Device Import" ], "summary": "Retrieve BIG-IP Device Import Tasks", "operationId": "RetrieveBIG-IPDeviceImportTasks", "parameters": [ { "name": "$filter", "in": "query", "description": "", "required": false, "style": "form", "explode": true, "schema": { "type": "string", "example": "deviceReference/link+eq+'*'" } } ], "responses": { "200": { "description": "", "headers": {} } }, "deprecated": false, "servers": [ { "url": "https://mgmt", "variables": {} } ] }, "post": { "tags": [ "Device Import" ], "summary": "Perform BIG-IP Device Import using machineId", "operationId": "PerformBIG-IPDeviceImportusingmachineId", "parameters": [], "requestBody": { "description": "", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/PerformBIG-IPDeviceImportusingmachineIdRequest" }, { "example": { "name": "rediscover_adc_core", "conflictPolicy": "USE_BIGIQ", "deviceReference": { "link": "https://localhost/mgmt/cm/system/machineid-resolver/" }, "failImportOnConflict": true, "moduleList": [ { "module": "adc_core" } ], "status": "STARTED" } } ] }, "example": { "name": "rediscover_adc_core", "conflictPolicy": "USE_BIGIQ", "deviceReference": { "link": "https://localhost/mgmt/cm/system/machineid-resolver/" }, "failImportOnConflict": true, "moduleList": [ { "module": "adc_core" } ], "status": "STARTED" } } }, "required": true }, "responses": { "200": { "description": "", "headers": {} } }, "deprecated": false, "servers": [ { "url": "https://mgmt", "variables": {} } ] } }, "/mgmt/cm/global/tasks/device-import/{deviceImportId}": { "patch": { "tags": [ "Device Import" ], "summary": "Perform BIG-IP Device Import using Import Task", "operationId": "PerformBIG-IPDeviceImportusingImportTask", "parameters": [ { "name": "deviceImportId", "in": "path", "description": "", "required": true, "style": "simple", "schema": { "type": "string" } } ], "requestBody": { "description": "", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/PerformBIG-IPDeviceImportusingImportTaskRequest" }, { "example": { "moduleList": [ { "module": "firewall" }, { "module": "security_shared" }, { "module": "adc_core" } ], "failOnConflict": true, "status": "STARTED" } } ] }, "example": { "moduleList": [ { "module": "firewall" }, { "module": "security_shared" }, { "module": "adc_core" } ], "failOnConflict": true, "status": "STARTED" } } }, "required": true }, "responses": { "200": { "description": "", "headers": {} } }, "deprecated": false, "servers": [ { "url": "https://mgmt", "variables": {} } ] }, "get": { "tags": [ "Device Import" ], "summary": "Monitor Import Task", "operationId": "MonitorImportTask", "parameters": [ { "name": "deviceImportId", "in": "path", "description": "", "required": true, "style": "simple", "schema": { "type": "string" } } ], "responses": { "200": { "description": "", "headers": {} } }, "deprecated": false, "servers": [ { "url": "https://mgmt", "variables": {} } ] } }, "/mgmt/shared/resolver/device-groups": { "get": { "tags": [ "Device" ], "summary": "Retrieve Device Groups", "operationId": "RetrieveDeviceGroups", "parameters": [ { "name": "$filter", "in": "query", "description": "", "required": false, "style": "form", "explode": true, "schema": { "type": "string", "example": "infrastructure eq 'false'" } }, { "name": "$orderby", "in": "query", "description": "", "required": false, "style": "form", "explode": true, "schema": { "type": "string", "example": "displayName asc, groupName asc" } }, { "name": "$select", "in": "query", "description": "", "required": false, "style": "form", "explode": true, "schema": { "type": "string", "example": "groupName,displayName" } } ], "responses": { "200": { "description": "", "headers": {} } }, "deprecated": false, "servers": [ { "url": "https://mgmt", "variables": {} } ] } }, "/mgmt/shared/resolver/device-groups/cm-bigip-allDevices/devices/{instance-uuid}/stats": { "get": { "tags": [ "Device" ], "summary": "Retrieve BIG-IP Health Summary", "operationId": "RetrieveBIG-IPHealthSummary", "parameters": [ { "name": "instance-uuid", "in": "path", "description": "", "required": true, "style": "simple", "schema": { "type": "string" } } ], "responses": { "200": { "description": "", "headers": {} } }, "deprecated": false, "servers": [ { "url": "https://mgmt", "variables": {} } ] } }, "/mgmt/shared/resolver/device-groups/cm-bigip-allBigIpDevices/devices/{uuid}": { "get": { "tags": [ "BIG-IP Device Reference Lookup" ], "summary": "Query Device by Device