{ "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 Reference", "operationId": "QueryDevicebyDeviceReference", "parameters": [ { "name": "uuid", "in": "path", "description": "", "required": true, "style": "simple", "schema": { "type": "string" } } ], "responses": { "200": { "description": "", "headers": {} } }, "deprecated": false, "servers": [ { "url": "https://mgmt", "variables": {} } ] } }, "/mgmt/cm/device/dsc-group": { "get": { "tags": [ "BIG-IP Device Clustering" ], "summary": "Query DSC Group", "operationId": "QueryDSCGroup", "parameters": [ { "name": "$filter", "in": "query", "description": "", "required": false, "style": "form", "explode": true, "schema": { "type": "string", "example": "devices eq '*'" } } ], "responses": { "200": { "description": "", "headers": {} } }, "deprecated": false, "servers": [ { "url": "https://mgmt", "variables": {} } ] } }, "/mgmt/cm/device/dsc-group/{groupId}": { "get": { "tags": [ "BIG-IP Device Clustering" ], "summary": "Query DSC Group by group id", "operationId": "QueryDSCGroupByGroupId", "parameters": [ { "name": "groupId", "in": "path", "description": "", "required": true, "style": "simple", "schema": { "type": "string" } } ], "responses": { "200": { "description": "", "headers": {} } }, "deprecated": false, "servers": [ { "url": "https://mgmt", "variables": {} } ] } }, "/mgmt/cm/autodeploy/qkview/{BIGIP-QKVIEW-TASK-ID}": { "get": { "tags": [ "Qkview" ], "summary": "Query BIGIP Qkview Task", "operationId": "QueryBIGIPQkviewTask", "parameters": [ { "name": "BIGIP-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 a BIGIP Qkview", "operationId": "DeleteaBIGIPQkview", "parameters": [ { "name": "BIGIP-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/tm/sys/license": { "get": { "tags": [ "Licensing" ], "summary": "Retrieve License Information", "operationId": "RetrieveLicenseInformation", "parameters": [], "responses": { "200": { "description": "", "headers": {} } }, "deprecated": false, "servers": [ { "url": "https://mgmt", "variables": {} } ] }, "post": { "tags": [ "Licensing" ], "summary": "Activate/Reactive License", "operationId": "Activate/ReactiveLicense", "parameters": [], "requestBody": { "description": "", "content": { "text/plain": { "schema": { "type": "string", "example": "{\n {\"command\": \"install\", \"registrationKey\": \"12345-12345-12345-12345-1234567\"}\n}" }, "example": "{\n {\"command\": \"install\", \"registrationKey\": \"12345-12345-12345-12345-1234567\"}\n}" } }, "required": true }, "responses": { "200": { "description": "", "headers": {} } }, "deprecated": false, "servers": [ { "url": "https://mgmt", "variables": {} } ] } }, "/mgmt/tm/sys/provision": { "get": { "tags": [ "Device Info" ], "summary": "Retrieve software provisioning (features)", "operationId": "Retrievesoftwareprovisioning(features)", "parameters": [], "responses": { "200": { "description": "", "headers": {} } }, "deprecated": false, "servers": [ { "url": "https://mgmt", "variables": {} } ] } }, "/mgmt/tm/util/bash": { "post": { "tags": [ "Device Info" ], "summary": "Run command as root user", "operationId": "RunCommandAsRootUser", "parameters": [], "requestBody": { "description": "", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/RetrieveMasterKeyRequest" }, { "example": { "command": "run", "utilCmdArgs": "-c 'f5mku -K'" } } ] }, "example": { "command": "run", "utilCmdArgs": "-c 'f5mku -K'" } } }, "required": true }, "responses": { "200": { "description": "", "headers": {} } }, "deprecated": false, "servers": [ { "url": "https://mgmt", "variables": {} } ] } }, "/mgmt/tm/sys/software/image": { "get": { "tags": [ "Software Management" ], "summary": "Retrieve all software images", "operationId": "Retrieveallsoftwareimages", "parameters": [], "responses": { "200": { "description": "", "headers": {} } }, "deprecated": false, "servers": [ { "url": "https://mgmt", "variables": {} } ] } }, "/mgmt/tm/sys/software/hotfix": { "get": { "tags": [ "Software Management" ], "summary": "Retrieve all hotfix images", "operationId": "Retrieveallhotfiximages", "parameters": [], "responses": { "200": { "description": "", "headers": {} } }, "deprecated": false, "servers": [ { "url": "https://mgmt", "variables": {} } ] } }, "/mgmt/tm/sys/crypto/cert": { "get": { "tags": [ "SSL Management" ], "summary": "Retrieve all LTM certificate objects", "operationId": "RetrieveallLTMcertificateobjects", "parameters": [], "responses": { "200": { "description": "", "headers": {} } }, "deprecated": false, "servers": [ { "url": "https://mgmt", "variables": {} } ] }, "post": { "tags": [ "SSL Management" ], "summary": "Create/Overwrite SSL Certificate from Upload", "operationId": "Create/OverwriteSSLCertificatefromUpload", "parameters": [], "requestBody": { "description": "", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/CreateOverwriteSSLCertificatefromUploadRequest" }, { "example": { "command": "install", "name": "mysslcertificate", "from-local-file": "/var/config/rest/downloads/mysslcertificate.crt" } } ] }, "example": { "command": "install", "name": "mysslcertificate", "from-local-file": "/var/config/rest/downloads/mysslcertificate.crt" } } }, "required": true }, "responses": { "200": { "description": "", "headers": {} } }, "deprecated": false, "servers": [ { "url": "https://mgmt", "variables": {} } ] } }, "/mgmt/tm/sys/crypto/key": { "get": { "tags": [ "SSL Management" ], "summary": "Retrieve all LTM private key objects", "operationId": "RetrieveallLTMprivatekeyobjects", "parameters": [], "responses": { "200": { "description": "", "headers": {} } }, "deprecated": false, "servers": [ { "url": "https://mgmt", "variables": {} } ] }, "post": { "tags": [ "SSL Management" ], "summary": "Create/Overwrite SSL Key from Upload", "operationId": "Create/OverwriteSSLKeyfromUpload", "parameters": [], "requestBody": { "description": "", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/CreateOverwriteSSLKeyfromUploadRequest" }, { "example": { "command": "install", "name": "mysslcertificate", "from-local-file": "/var/config/rest/downloads/mysslcertificate.key" } } ] }, "example": { "command": "install", "name": "mysslcertificate", "from-local-file": "/var/config/rest/downloads/mysslcertificate.key" } } }, "required": true }, "responses": { "200": { "description": "", "headers": {} } }, "deprecated": false, "servers": [ { "url": "https://mgmt", "variables": {} } ] } }, "/mgmt/tm/sys/file/ssl-cert": { "get": { "tags": [ "SSL Management" ], "summary": "Retrieve all certificate files", "operationId": "Retrieveallcertificatefiles", "parameters": [], "responses": { "200": { "description": "", "headers": {} } }, "deprecated": false, "servers": [ { "url": "https://mgmt", "variables": {} } ] } }, "/mgmt/tm/sys/file/ssl-key": { "get": { "tags": [ "SSL Management" ], "summary": "Retrieve all key files", "operationId": "Retrieveallkeyfiles", "parameters": [], "responses": { "200": { "description": "", "headers": {} } }, "deprecated": false, "servers": [ { "url": "https://mgmt", "variables": {} } ] } }, "/mgmt/tm/ltm/profile/client-ssl": { "get": { "tags": [ "SSL Management" ], "summary": "Retrieve all client SSL profiles", "operationId": "RetrieveallclientSSLprofiles", "parameters": [], "responses": { "200": { "description": "", "headers": {} } }, "deprecated": false, "servers": [ { "url": "https://mgmt", "variables": {} } ] }, "post": { "tags": [ "SSL Management" ], "summary": "Create Client SSL Profile", "operationId": "CreateClientSSLProfile", "parameters": [], "requestBody": { "description": "", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/CreateClientSSLProfileRequest" }, { "example": { "name": "myclientsslprofile", "defaultsFrom": "/Common/clientssl", "cert": "/Common/mysslcertificate", "key": "/Common/mysslcertificate", "usage": "Server" } } ] }, "example": { "name": "myclientsslprofile", "defaultsFrom": "/Common/clientssl", "cert": "/Common/mysslcertificate", "key": "/Common/mysslcertificate", "usage": "Server" } } }, "required": true }, "responses": { "200": { "description": "", "headers": {} } }, "deprecated": false, "servers": [ { "url": "https://mgmt", "variables": {} } ] } }, "/mgmt/tm/ltm/profile/client-ssl/example": { "get": { "tags": [ "SSL Management" ], "summary": "Client SSL Profile API Example", "operationId": "getClientSSLProfileAPIExample", "parameters": [], "responses": { "200": { "description": "", "headers": {} } }, "deprecated": false, "servers": [ { "url": "https://mgmt", "variables": {} } ] } }, "/mgmt/shared/file-transfer/uploads/mysslcertificate.crt": { "post": { "tags": [ "SSL Management" ], "summary": "Upload SSL Certificate", "operationId": "UploadSSLCertificate", "parameters": [ { "name": "Content-Type", "in": "header", "description": "", "required": true, "style": "simple", "schema": { "enum": [ "application/octet-stream" ], "type": "string", "example": "application/octet-stream" } }, { "name": "Content-Range", "in": "header", "description": "", "required": true, "style": "simple", "schema": { "type": "string", "example": "0-1760/1761" } } ], "requestBody": { "content": { "multipart/form-data": { "encoding": {}, "schema": { "required": [ "File" ], "type": "object", "properties": { "File": { "type": "string", "format": "binary" } } } } }, "required": false }, "responses": { "200": { "description": "", "headers": {} } }, "deprecated": false, "servers": [ { "url": "https://mgmt", "variables": {} } ] } }, "/mgmt/shared/file-transfer/uploads/mysslcertificate.key": { "post": { "tags": [ "SSL Management" ], "summary": "Upload SSL Key", "operationId": "UploadSSLKey", "parameters": [ { "name": "Content-Type", "in": "header", "description": "", "required": true, "style": "simple", "schema": { "enum": [ "application/octet-stream" ], "type": "string", "example": "application/octet-stream" } }, { "name": "Content-Range", "in": "header", "description": "", "required": true, "style": "simple", "schema": { "type": "string", "example": "0-2483/2484" } } ], "requestBody": { "content": { "multipart/form-data": { "encoding": {}, "schema": { "required": [ "File" ], "type": "object", "properties": { "File": { "type": "string", "format": "binary" } } } } }, "required": false }, "responses": { "200": { "description": "", "headers": {} } }, "deprecated": false, "servers": [ { "url": "https://mgmt", "variables": {} } ] } }, "/mgmt/tm/ltm/virtual/myvirtualserver/profiles": { "post": { "tags": [ "SSL Management" ], "summary": "Attach Client SSL Profile to Virtual Server", "operationId": "AttachClientSSLProfiletoVirtualServer", "parameters": [], "requestBody": { "description": "", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/AttachClientSSLProfiletoVirtualServerRequest" }, { "example": { "name": "myclientsslprofile" } } ] }, "example": { "name": "myclientsslprofile" } } }, "required": true }, "responses": { "200": { "description": "", "headers": {} } }, "deprecated": false, "servers": [ { "url": "https://mgmt", "variables": {} } ] } }, "/mgmt/tm/ltm/virtual/myvirtualserver/profiles/myclientsslprofile": { "delete": { "tags": [ "SSL Management" ], "summary": "Detach Client SSL Profile from Virtual Server", "operationId": "DetachClientSSLProfilefromVirtualServer", "parameters": [], "responses": { "200": { "description": "", "headers": {} } }, "deprecated": false, "servers": [ { "url": "https://mgmt", "variables": {} } ] } }, "/mgmt/tm/ltm/profile/client-ssl/myclientsslprofile": { "delete": { "tags": [ "SSL Management" ], "summary": "Delete Client SSL Profile", "operationId": "DeleteClientSSLProfile", "parameters": [], "responses": { "200": { "description": "", "headers": {} } }, "deprecated": false, "servers": [ { "url": "https://mgmt", "variables": {} } ] } }, "/mgmt/tm/sys/crypto/cert/mysslcertificate": { "delete": { "tags": [ "SSL Management" ], "summary": "Delete SSL Certificate", "operationId": "DeleteSSLCertificate", "parameters": [], "responses": { "200": { "description": "", "headers": {} } }, "deprecated": false, "servers": [ { "url": "https://mgmt", "variables": {} } ] } }, "/mgmt/tm/sys/crypto/key/mysslcertificate": { "delete": { "tags": [ "SSL Management" ], "summary": "Delete SSL Key", "operationId": "DeleteCryptoSSLKey", "parameters": [], "responses": { "200": { "description": "", "headers": {} } }, "deprecated": false, "servers": [ { "url": "https://mgmt", "variables": {} } ] } }, "/mgmt/tm/sys/license/example": { "get": { "tags": [ "Licensing" ], "summary": "Show BIG-IP License Example", "operationId": "ShowBIG-IPLicenseExample", "parameters": [], "responses": { "200": { "description": "", "headers": {} } }, "deprecated": false, "servers": [ { "url": "https://mgmt", "variables": {} } ] } }, "/mgmt/tm/sys/config": { "post": { "tags": [ "Configuration" ], "summary": "Save Configuration", "operationId": "SaveConfiguration", "parameters": [], "requestBody": { "description": "", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/SaveConfigurationRequest" }, { "example": { "command": "save" } } ] }, "example": { "command": "save" } } }, "required": true }, "responses": { "200": { "description": "", "headers": {} } }, "deprecated": false, "servers": [ { "url": "https://mgmt", "variables": {} } ] } } }, "components": { "schemas": { "GenerateaBIG-IQQkviewRequest": { "title": "GenerateaBIG-IQQkviewRequest", "required": [ "name" ], "type": "object", "properties": { "name": { "type": "string" } }, "example": { "name": "test-bigiq-qkview.qkview" } }, "CreateBIG-IPiHealthUploadTaskRequest": { "title": "CreateBIG-IPiHealthUploadTaskRequest", "required": [ "name", "deviceReferences", "credentialsReference" ], "type": "object", "properties": { "name": { "type": "string" }, "deviceReferences": { "type": "array", "items": { "$ref": "#/components/schemas/DeviceReference" }, "description": "" }, "credentialsReference": { "$ref": "#/components/schemas/CredentialsReference" } }, "example": { "name": "testing-api-uploads", "deviceReferences": [ { "link": "" } ], "credentialsReference": { "link": "" } } }, "DeviceReference": { "title": "DeviceReference", "required": [ "link" ], "type": "object", "properties": { "link": { "type": "string" } }, "example": { "link": "" } }, "CredentialsReference": { "title": "CredentialsReference", "required": [ "link" ], "type": "object", "properties": { "link": { "type": "string" } }, "example": { "link": "" } }, "GenerateBIG-IPiHealthReportRequest": { "title": "GenerateBIG-IPiHealthReportRequest", "required": [ "name", "deviceReferences", "credentialsReference" ], "type": "object", "properties": { "name": { "type": "string" }, "deviceReferences": { "type": "array", "items": { "$ref": "#/components/schemas/DeviceReference" }, "description": "" }, "credentialsReference": { "$ref": "#/components/schemas/CredentialsReference" } }, "example": { "name": "testing-api-uploads", "deviceReferences": [ { "link": "" } ], "credentialsReference": { "link": "" } } }, "UpdateBIG-IPiHealthConfigRequest": { "title": "UpdateBIG-IPiHealthConfigRequest", "required": [ "concurrentUploadCount", "concurrentDownloadCount", "iHealthEndpoint", "iHealthAuthEndpoint" ], "type": "object", "properties": { "concurrentUploadCount": { "type": "integer", "format": "int32" }, "concurrentDownloadCount": { "type": "integer", "format": "int32" }, "iHealthEndpoint": { "type": "string" }, "iHealthAuthEndpoint": { "type": "string" } }, "example": { "concurrentUploadCount": 5, "concurrentDownloadCount": 5, "iHealthEndpoint": "https://ihealth-api.f5networks.net/qkview-analyzer/api/", "iHealthAuthEndpoint": "https://identity.account.f5.com/oauth2/ausp95ykc80HOU7SQ357/v1/token" } }, "GenerateaniHealthDeviceReportRequest": { "title": "GenerateaniHealthDeviceReportRequest", "required": [ "name", "deviceReference" ], "type": "object", "properties": { "name": { "type": "string" }, "deviceReference": { "type": "string" } }, "example": { "name": "testing", "deviceReference": "" } }, "CreateTestBIG-IPiHealthCredentialsRequest": { "title": "CreateTestBIG-IPiHealthCredentialsRequest", "required": [ "displayName", "description", "username", "password" ], "type": "object", "properties": { "displayName": { "type": "string" }, "description": { "type": "string" }, "username": { "type": "string" }, "password": { "type": "string" } }, "example": { "displayName": "ihealth2-testing", "description": "Testing for Itential", "username": "", "password": "" } }, "ModifyTestBIG-IPiHealthCredentialsRequest": { "title": "ModifyTestBIG-IPiHealthCredentialsRequest", "required": [ "displayName", "description", "username", "encryptedPassword" ], "type": "object", "properties": { "displayName": { "type": "string" }, "description": { "type": "string" }, "username": { "type": "string" }, "encryptedPassword": { "type": "string" } }, "example": { "displayName": "ihealth2-testing", "description": "Testing for Itential", "username": "0oas5oa1j8C1vDEyV357", "encryptedPassword": "ttZNs4dlnYnR6afp8yrDuhqJmOCN5yNG3ou6NSJjYuu0o7UC0L93hiBFZc9bA+rUTOaATvZc8CBbj1zkIr4R0Q==" } }, "DeleteTestBIG-IPiHealthCredentialsRequest": { "title": "DeleteTestBIG-IPiHealthCredentialsRequest", "required": [ "displayName", "description", "username", "password" ], "type": "object", "properties": { "displayName": { "type": "string" }, "description": { "type": "string" }, "username": { "type": "string" }, "password": { "type": "string" } }, "example": { "displayName": "Greg's iHealth2 Credentials", "description": "Testing for Itential", "username": "0oas5oa1j8C1vDEyV357", "password": "SH327FpN86gKDtaAy54kEBaj2Dwuo2U-FKKwl8uU" } }, "GenerateBackupofDeviceRequest": { "title": "GenerateBackupofDeviceRequest", "required": [ "name", "includePrivateKeys", "isEncrypted", "deviceReference", "backupLifeTime", "description" ], "type": "object", "properties": { "name": { "type": "string" }, "includePrivateKeys": { "type": "boolean" }, "isEncrypted": { "type": "boolean" }, "deviceReference": { "$ref": "#/components/schemas/DeviceReference" }, "backupLifeTime": { "type": "integer", "format": "int32" }, "description": { "type": "string" } }, "example": { "name": "testing3-task.ucs", "includePrivateKeys": true, "isEncrypted": false, "deviceReference": { "link": "" }, "backupLifeTime": 1, "description": "Itential testing" } }, "GenerateBackupFileDownloadPathHashRequest": { "title": "GenerateBackupFileDownloadPathHashRequest", "required": [ "path", "supportsBlob", "downloadFilename" ], "type": "object", "properties": { "path": { "type": "string" }, "supportsBlob": { "type": "boolean" }, "downloadFilename": { "type": "string" } }, "example": { "path": "/mgmt/cm/system/backup-download/testing3-task.ucs", "supportsBlob": true, "downloadFilename": "testing3-task.ucs" } }, "CreateaBIG-IPscriptRequest": { "title": "CreateaBIG-IPscriptRequest", "required": [ "name", "description", "script" ], "type": "object", "properties": { "name": { "type": "string" }, "description": { "type": "string" }, "script": { "type": "string" } }, "example": { "name": "check service check date", "description": "returns the service check date from the license", "script": "tmsh show sys license | grep 'Service Check Date'" } }, "ExecuteaBIG-IPscriptRequest": { "title": "ExecuteaBIG-IPscriptRequest", "required": [ "name", "deviceReferences", "timeout", "scriptReference" ], "type": "object", "properties": { "name": { "type": "string" }, "deviceReferences": { "type": "array", "items": { "$ref": "#/components/schemas/DeviceReference" }, "description": "" }, "timeout": { "type": "integer", "format": "int32" }, "scriptReference": { "$ref": "#/components/schemas/ScriptReference" } }, "example": { "name": "check service check date", "deviceReferences": [ { "link": "" } ], "timeout": 30, "scriptReference": { "link": "" } } }, "ScriptReference": { "title": "ScriptReference", "required": [ "link" ], "type": "object", "properties": { "link": { "type": "string" } }, "example": { "link": "" } }, "PerformBIG-IPDeviceDiscoveryusingDiscoveryTaskRequest": { "title": "PerformBIG-IPDeviceDiscoveryusingDiscoveryTaskRequest", "required": [ "moduleList", "status" ], "type": "object", "properties": { "moduleList": { "type": "array", "items": { "$ref": "#/components/schemas/ModuleList" }, "description": "" }, "status": { "type": "string" } }, "example": { "moduleList": [ { "module": "firewall" }, { "module": "security_shared" }, { "module": "adc_core" } ], "status": "STARTED" } }, "ModuleList": { "title": "ModuleList", "required": [ "module" ], "type": "object", "properties": { "module": { "type": "string" } }, "example": { "module": "firewall" } }, "PerformBIG-IPDeviceDiscoveryusingmachineIdRequest": { "title": "PerformBIG-IPDeviceDiscoveryusingmachineIdRequest", "required": [ "deviceReference", "moduleList", "status" ], "type": "object", "properties": { "deviceReference": { "$ref": "#/components/schemas/DeviceReference" }, "moduleList": { "type": "array", "items": { "$ref": "#/components/schemas/ModuleList" }, "description": "" }, "status": { "type": "string" } }, "example": { "deviceReference": { "link": "https://localhost/mgmt/cm/system/machineid-resolver/" }, "moduleList": [ { "module": "adc_core" } ], "status": "STARTED" } }, "PerformBIG-IPDeviceImportusingImportTaskRequest": { "title": "PerformBIG-IPDeviceImportusingImportTaskRequest", "required": [ "moduleList", "failOnConflict", "status" ], "type": "object", "properties": { "moduleList": { "type": "array", "items": { "$ref": "#/components/schemas/ModuleList" }, "description": "" }, "failOnConflict": { "type": "boolean" }, "status": { "type": "string" } }, "example": { "moduleList": [ { "module": "firewall" }, { "module": "security_shared" }, { "module": "adc_core" } ], "failOnConflict": true, "status": "STARTED" } }, "PerformBIG-IPDeviceImportusingmachineIdRequest": { "title": "PerformBIG-IPDeviceImportusingmachineIdRequest", "required": [ "name", "conflictPolicy", "deviceReference", "failImportOnConflict", "moduleList", "status" ], "type": "object", "properties": { "name": { "type": "string" }, "conflictPolicy": { "type": "string" }, "deviceReference": { "$ref": "#/components/schemas/DeviceReference" }, "failImportOnConflict": { "type": "boolean" }, "moduleList": { "type": "array", "items": { "$ref": "#/components/schemas/ModuleList" }, "description": "" }, "status": { "type": "string" } }, "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" } }, "GenerateanauthtokenRequest": { "title": "GenerateanauthtokenRequest", "required": [ "username", "password", "provider" ], "type": "object", "properties": { "username": { "type": "string" }, "password": { "type": "string" }, "provider": { "type": "string" } }, "example": { "username": "admin", "password": "purple123", "provider": "tmos" } }, "LookupDeviceReferencebymachineIDRequest": { "title": "LookupDeviceReferencebymachineIDRequest", "required": [ "machineId" ], "type": "object", "properties": { "machineId": { "type": "string" } }, "example": { "machineId": "" } }, "LookupDeviceReferencebymanagementIPRequest": { "title": "LookupDeviceReferencebymanagementIPRequest", "required": [ "address" ], "type": "object", "properties": { "address": { "type": "string" } }, "example": { "address": "10.1.1.8" } }, "LookupDeviceReferencebyhostnameRequest": { "title": "LookupDeviceReferencebyhostnameRequest", "required": [ "hostname" ], "type": "object", "properties": { "hostname": { "type": "string" } }, "example": { "hostname": "BOS-vBIGIP01.termmarc.com" } }, "NewRequestRequest": { "title": "NewRequestRequest", "required": [ "name", "softwareImageReference", "stopBeforeInstall", "stopBeforeReboot", "stopForBackups", "serialMode", "stopForAssessments", "selectByDevice", "deviceInput", "stopToReview" ], "type": "object", "properties": { "name": { "type": "string" }, "softwareImageReference": { "$ref": "#/components/schemas/SoftwareImageReference" }, "stopBeforeInstall": { "type": "boolean" }, "stopBeforeReboot": { "type": "boolean" }, "stopForBackups": { "type": "boolean" }, "serialMode": { "type": "boolean" }, "stopForAssessments": { "type": "boolean" }, "selectByDevice": { "type": "boolean" }, "deviceInput": { "type": "array", "items": { "$ref": "#/components/schemas/DeviceInput" }, "description": "" }, "stopToReview": { "type": "boolean" } }, "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 } }, "SoftwareImageReference": { "title": "SoftwareImageReference", "required": [ "link" ], "type": "object", "properties": { "link": { "type": "string" } }, "example": { "link": "https://localhost/mgmt/cm/autodeploy/software-images/BIGIP-16.1.2.1-0.0.11.iso" } }, "DeviceInput": { "title": "DeviceInput", "required": [ "deviceReference", "targetVolume", "active" ], "type": "object", "properties": { "deviceReference": { "$ref": "#/components/schemas/DeviceReference" }, "targetVolume": { "type": "string" }, "active": { "type": "string" } }, "example": { "deviceReference": { "link": "https://localhost/mgmt/shared/resolver/device-groups/cm-bigip-allBigIpDevices/devices/ba7382a4-7564-4647-b65d-17d6f2a73a16" }, "targetVolume": "HD1.2", "active": "HD1.1" } }, "GenerateaQkviewRequest": { "title": "GenerateaQkviewRequest", "required": [ "name" ], "type": "object", "properties": { "name": { "type": "string" } }, "example": { "name": "testing.qkview" } }, "DeleteaQkviewRequest": { "title": "DeleteaQkviewRequest", "required": [ "name" ], "type": "object", "properties": { "name": { "type": "string" } }, "example": { "name": "testing.qkview" } }, "RetrieveMasterKeyRequest": { "title": "RetrieveMasterKeyRequest", "required": [ "command", "utilCmdArgs" ], "type": "object", "properties": { "command": { "type": "string" }, "utilCmdArgs": { "type": "string" } }, "example": { "command": "run", "utilCmdArgs": "-c 'f5mku -K'" } }, "RetrieverootcronfileRequest": { "title": "RetrieverootcronfileRequest", "required": [ "command", "utilCmdArgs" ], "type": "object", "properties": { "command": { "type": "string" }, "utilCmdArgs": { "type": "string" } }, "example": { "command": "run", "utilCmdArgs": "-c 'cat /var/spool/cron/root'" } }, "ViewusedavailablediskspaceRequest": { "title": "ViewusedavailablediskspaceRequest", "required": [ "command", "utilCmdArgs" ], "type": "object", "properties": { "command": { "type": "string" }, "utilCmdArgs": { "type": "string" } }, "example": { "command": "run", "utilCmdArgs": "-c 'vgdisplay --short'" } }, "CreateOverwriteSSLCertificatefromUploadRequest": { "title": "CreateOverwriteSSLCertificatefromUploadRequest", "required": [ "command", "name", "from-local-file" ], "type": "object", "properties": { "command": { "type": "string" }, "name": { "type": "string" }, "from-local-file": { "type": "string" } }, "example": { "command": "install", "name": "mysslcertificate", "from-local-file": "/var/config/rest/downloads/mysslcertificate.crt" } }, "CreateOverwriteSSLKeyfromUploadRequest": { "title": "CreateOverwriteSSLKeyfromUploadRequest", "required": [ "command", "name", "from-local-file" ], "type": "object", "properties": { "command": { "type": "string" }, "name": { "type": "string" }, "from-local-file": { "type": "string" } }, "example": { "command": "install", "name": "mysslcertificate", "from-local-file": "/var/config/rest/downloads/mysslcertificate.key" } }, "CreateClientSSLProfileRequest": { "title": "CreateClientSSLProfileRequest", "required": [ "name", "defaultsFrom", "cert", "key", "usage" ], "type": "object", "properties": { "name": { "type": "string" }, "defaultsFrom": { "type": "string" }, "cert": { "type": "string" }, "key": { "type": "string" }, "usage": { "type": "string" } }, "example": { "name": "myclientsslprofile", "defaultsFrom": "/Common/clientssl", "cert": "/Common/mysslcertificate", "key": "/Common/mysslcertificate", "usage": "Server" } }, "AttachClientSSLProfiletoVirtualServerRequest": { "title": "AttachClientSSLProfiletoVirtualServerRequest", "required": [ "name" ], "type": "object", "properties": { "name": { "type": "string" } }, "example": { "name": "myclientsslprofile" } }, "DetachClientSSLProfilefromVirtualServerRequest": { "title": "DetachClientSSLProfilefromVirtualServerRequest", "required": [ "name" ], "type": "object", "properties": { "name": { "type": "string" } }, "example": { "name": "myclientsslprofile" } }, "DeleteClientSSLProfileRequest": { "title": "DeleteClientSSLProfileRequest", "required": [ "name" ], "type": "object", "properties": { "name": { "type": "string" } }, "example": { "name": "myclientsslprofile" } }, "SaveConfigurationRequest": { "title": "SaveConfigurationRequest", "required": [ "command" ], "type": "object", "properties": { "command": { "type": "string" } }, "example": { "command": "save" } } } }, "tags": [ { "name": "BIG-IP UUID Lookup" }, { "name": "BIG-IP iHealth" }, { "name": "BIG-IQ System/Cluster Status" }, { "name": "Device Backups" }, { "name": "BIG-IP TMSH Scripting" }, { "name": "BIG-IP Software Image Management" }, { "name": "Device Import" }, { "name": "Device" }, { "name": "BIG-IP Device Reference Lookup" }, { "name": "BIG-IP Device Clustering" }, { "name": "Device Upgrades" }, { "name": "Qkview" }, { "name": "Device Info" }, { "name": "Software Management" }, { "name": "SSL Management" }, { "name": "Licensing" }, { "name": "Configuration" } ] }