openapi: 3.0.0 info: title: vSphere Automation REST Resources for appliance description: The folders within this collection represent the Rest API resources and the different operations that can be performed on each. These are individual requests. In many cases, each request will require input that would come from other requests. It is left up to the user to insert the correct data into the URL, query parameters and request bodies for the requests to work correctly. Refer to the ReST API Documentation for further help. contact: {} version: '1.0' servers: - url: http://example.com/rest variables: {} paths: /appliance/access/consolecli: get: tags: - Access summary: getConsoleCLIAccess description: get Console CLI Access operationId: getConsoleCLIAccess parameters: [] responses: '200': description: '' headers: {} content: {} deprecated: false put: tags: - Access summary: uodateConsoleCLIAccess description: uodate Console CLI Access operationId: uodateConsoleCLIAccess parameters: [] requestBody: description: '' content: application/json: schema: allOf: - $ref: '#/components/schemas/ConsoleCLI-disableRequest' - example: enabled: false example: enabled: false required: true responses: '200': description: '' headers: {} content: {} deprecated: false /appliance/access/dcui: get: tags: - Access summary: getDCUIAccess description: get DCUI Access operationId: getDCUIAccess parameters: [] responses: '200': description: '' headers: {} content: {} deprecated: false put: tags: - Access summary: uodateDCUIAccess description: uodate DCUI Access operationId: uodateDCUIAccess parameters: [] requestBody: description: '' content: application/json: schema: allOf: - $ref: '#/components/schemas/DCUI-disableRequest' - example: enabled: false example: enabled: false required: true responses: '200': description: '' headers: {} content: {} deprecated: false /appliance/access/shell: get: tags: - Access summary: getShellAccess description: get Shell Access operationId: getShellAccess parameters: [] responses: '200': description: '' headers: {} content: {} deprecated: false put: tags: - Access summary: uodateShellAccess description: uodate Shell Access operationId: uodateShellAccess parameters: [] requestBody: description: '' content: application/json: schema: allOf: - $ref: '#/components/schemas/Shell-disableRequest' - example: config: enabled: false timeout: 1 example: config: enabled: false timeout: 1 required: true responses: '200': description: '' headers: {} content: {} deprecated: false /appliance/access/ssh: get: tags: - Access summary: getSSHAccess description: get SSH Access operationId: getSSHAccess parameters: [] responses: '200': description: '' headers: {} content: {} deprecated: false put: tags: - Access summary: updateSSHAccess description: update SSH Access operationId: updateSSHAccess parameters: [] requestBody: description: '' content: application/json: schema: allOf: - $ref: '#/components/schemas/SSH-disableRequest' - example: enabled: false example: enabled: false required: true responses: '200': description: '' headers: {} content: {} deprecated: false /appliance/health/applmgmt: get: tags: - Health summary: getApplianceServicesHealth description: get Appliance services health operationId: getApplianceServicesHealth parameters: [] responses: '200': description: '' headers: {} content: {} deprecated: false /appliance/health/database-storage: get: tags: - Health summary: getDatabaseStorageHealth description: get Database storage health operationId: getDatabaseStorageHealth parameters: [] responses: '200': description: '' headers: {} content: {} deprecated: false /appliance/health/load: get: tags: - Health summary: getLoadHealth description: get Load Health operationId: getLoadHealth parameters: [] responses: '200': description: '' headers: {} content: {} deprecated: false /appliance/health/mem: get: tags: - Health summary: getMemoryHealth description: get Memory Health operationId: getMemoryHealth parameters: [] responses: '200': description: '' headers: {} content: {} deprecated: false /appliance/health/software-packages: get: tags: - Health summary: getSoftwarePackagesHealth description: get Software packages health operationId: getSoftwarePackagesHealth parameters: [] responses: '200': description: '' headers: {} content: {} deprecated: false /appliance/health/storage: get: tags: - Health summary: getStorageHealth description: get Storage health operationId: getStorageHealth parameters: [] responses: '200': description: '' headers: {} content: {} deprecated: false /appliance/health/swap: get: tags: - Health summary: getSwapHealth description: get Swap health operationId: getSwapHealth parameters: [] responses: '200': description: '' headers: {} content: {} deprecated: false /appliance/health/system: get: tags: - Health summary: getSystemHealth description: get System health operationId: getSystemHealth parameters: [] responses: '200': description: '' headers: {} content: {} deprecated: false /appliance/health/system/lastcheck: get: tags: - Health summary: getSystemLastcheckHealth description: get System lastcheck health operationId: getSystemLastcheckHealth parameters: [] responses: '200': description: '' headers: {} content: {} deprecated: false /appliance/monitoring: get: tags: - Monitoring summary: listMonitoring description: List Monitoring operationId: listMonitoring parameters: [] responses: '200': description: '' headers: {} content: {} deprecated: false /appliance/monitoring/{item}: get: tags: - Monitoring summary: getMonitoringDetails description: get Monitoring Details operationId: getMonitoringDetails parameters: - name: item in: path description: id of item required: true style: simple schema: type: string responses: '200': description: '' headers: {} content: {} deprecated: false /appliance/monitoring/query: get: tags: - Monitoring summary: queryMonitoringStats description: Query Monitoring stats operationId: queryMonitoringStats parameters: - name: item.interval in: query description: '' required: true style: form explode: true schema: type: string example: HOURS2 - name: item.end_time in: query description: '' required: true style: form explode: true schema: type: string example: 2017-02-10T22:13:05.651Z - name: item.names.1 in: query description: '' required: true style: form explode: true schema: type: string example: net.rx.activity.eth0 - name: item.names.2 in: query description: '' required: true style: form explode: true schema: type: string example: net.tx.activity.eth0 - name: item.start_time in: query description: '' required: true style: form explode: true schema: type: string example: 2017-02-06T22:13:05.651Z - name: item.function in: query description: '' required: true style: form explode: true schema: type: string example: COUNT responses: '200': description: '' headers: {} content: {} deprecated: false /appliance/techpreview/monitoring/snmp: get: tags: - Monitoring summary: getSNMPConfiguration description: Return an SNMP agent configuration. operationId: getSNMPConfiguration parameters: [] responses: '200': description: '' headers: {} content: {} deprecated: false post: tags: - Monitoring summary: setSNMPConfiguration description: Set SNMP configuration. operationId: setSNMPConfiguration parameters: [] requestBody: description: '' content: application/json: schema: allOf: - $ref: '#/components/schemas/SetSNMPconfigurationRequest' - example: config: authentication: none communities: - string - bstring engineid: string loglevel: string notraps: - string - bstring port: 1 privacy: AES128 remoteusers: - string - bstring syscontact: string syslocation: string targets: - string - bstring users: - string - bstring v3targets: - string - bstring example: config: authentication: none communities: - string - bstring engineid: string loglevel: string notraps: - string - bstring port: 1 privacy: AES128 remoteusers: - string - bstring syscontact: string syslocation: string targets: - string - bstring users: - string - bstring v3targets: - string - bstring required: true responses: '200': description: '' headers: {} content: {} deprecated: false /appliance/techpreview/monitoring/snmp/enable: post: tags: - Monitoring summary: enableSNMP description: Start a disabled SNMP agent. operationId: enableSNMP parameters: [] responses: '200': description: '' headers: {} content: {} deprecated: false /appliance/techpreview/monitoring/snmp/disable: post: tags: - Monitoring summary: disableSNMP description: Stop an enabled SNMP agent. operationId: disableSNMP parameters: [] responses: '200': description: '' headers: {} content: {} deprecated: false /appliance/techpreview/monitoring/snmp/stats: get: tags: - Monitoring summary: getSNMPStats description: Generate diagnostics report for snmp agent. operationId: getSNMPStats parameters: [] responses: '200': description: '' headers: {} content: {} deprecated: false /appliance/techpreview/monitoring/snmp/test: post: tags: - Monitoring summary: testSNMP description: Send a warmStart notification to all configured traps and inform destinations (see RFC 3418). operationId: testSNMP parameters: [] responses: '200': description: '' headers: {} content: {} deprecated: false /appliance/techpreview/monitoring/snmp/hash: post: tags: - Monitoring summary: generateSNMPHash description: Generate localized keys for secure SNMPv3 communications. operationId: generateSNMPHash parameters: [] requestBody: description: '' content: application/json: schema: allOf: - $ref: '#/components/schemas/GeneratehashRequest' - example: config: auth_hash: string priv_hash: string raw_secret: true example: config: auth_hash: string priv_hash: string raw_secret: true required: true responses: '200': description: '' headers: {} content: {} deprecated: false /appliance/techpreview/monitoring/snmp/reset: post: tags: - Monitoring summary: resetSNMPFactorySettings description: Restore settings to factory defaults. operationId: resetSNMPFactorySettings parameters: [] responses: '200': description: '' headers: {} content: {} deprecated: false /appliance/techpreview/monitoring/snmp/limits: get: tags: - Monitoring summary: getSNMPLimits description: Get SNMP limits information. operationId: getSNMPLimits parameters: [] responses: '200': description: '' headers: {} content: {} deprecated: false /appliance/networking/dns/domains: get: tags: - Network summary: getDNSSearchDomains description: DNS search domains operationId: getDNSSearchDomains parameters: [] responses: '200': description: '' headers: {} content: {} deprecated: false put: tags: - Network summary: setDNSSEARCHDomain description: Set DNS Search Domains operationId: setDNSSEARCHDomain parameters: [] requestBody: description: '' content: application/json: schema: allOf: - $ref: '#/components/schemas/DomainssetRequest' - example: domains: - vmware.com example: domains: - vmware.com required: true responses: '200': description: '' headers: {} content: {} deprecated: false post: tags: - Network summary: addDNSSearchDomain description: Add DNS Search Domain operationId: addDNSSearchDomain parameters: [] requestBody: description: '' content: application/json: schema: allOf: - $ref: '#/components/schemas/DomainsaddRequest' - example: domain: myvmware.com example: domain: myvmware.com required: true responses: '200': description: '' headers: {} content: {} deprecated: false /appliance/networking/dns/hostname: get: tags: - Network summary: getDomainName description: Get the Fully Qualified Doman Name. operationId: getDomainName parameters: [] responses: '200': description: '' headers: {} content: {} deprecated: false put: tags: - Network summary: setDomainName description: Set the Fully Qualified Domain Name. operationId: setDomainName parameters: [] requestBody: description: '' content: application/json: schema: allOf: - $ref: '#/components/schemas/Hostname-setRequest' - example: name: '{{appliance_hostname}}' example: name: '{{appliance_hostname}}' required: true responses: '200': description: '' headers: {} content: {} deprecated: false /appliance/networking/dns/hostname/test: post: tags: - Network summary: testDomainName description: Test the Fully Qualified Domain Name. operationId: testDomainName parameters: [] requestBody: description: '' content: application/json: schema: allOf: - $ref: '#/components/schemas/Hostname-testRequest' - example: name: '{{appliance_hostname}}' example: name: '{{appliance_hostname}}' required: true responses: '200': description: '' headers: {} content: {} deprecated: false /appliance/networking/dns/servers: get: tags: - Network summary: getDNSservers description: get DNS servers operationId: getDNSservers parameters: [] responses: '200': description: '' headers: {} content: {} deprecated: false post: tags: - Network summary: addDNSserver description: add DNS servers operationId: addDNSserver parameters: [] requestBody: description: '' content: application/json: schema: allOf: - $ref: '#/components/schemas/DNSservers-addRequest' - example: server: serverB example: server: serverB required: true responses: '200': description: '' headers: {} content: {} deprecated: false put: tags: - Network summary: updateDNSserver description: update DNS servers operationId: updateDNSserver parameters: [] requestBody: description: '' content: application/json: schema: allOf: - $ref: '#/components/schemas/DNSservers-setRequest' - example: config: mode: is_static servers: - serverA - serverB example: config: mode: is_static servers: - serverA - serverB required: true responses: '200': description: '' headers: {} content: {} deprecated: false /appliance/networking/dns/servers/test: post: tags: - Network summary: testDNSservers description: Test if dns servers are reachable. operationId: testDNSservers parameters: [] requestBody: description: '' content: application/json: schema: allOf: - $ref: '#/components/schemas/DNSservers-testRequest' - example: servers: - '{{appliance_dns_a}}' example: servers: - '{{appliance_dns_a}}' required: true responses: '200': description: '' headers: {} content: {} deprecated: false /appliance/networking/interfaces: get: tags: - Network summary: getInterfaces description: get Interfaces operationId: getInterfaces parameters: [] responses: '200': description: '' headers: {} content: {} deprecated: false /appliance/networking/interfaces/{interface}: get: tags: - Network summary: getInterfaceDetails description: Get information about a particular network interface. operationId: getInterfaceDetails parameters: - name: interface in: path description: id of interface required: true style: simple schema: type: string responses: '200': description: '' headers: {} content: {} deprecated: false /appliance/techpreview/networking/ipv4: get: tags: - Network summary: getIPv4 description: get IPv4 operationId: getIPv4 parameters: [] responses: '200': description: '' headers: {} content: {} deprecated: false post: tags: - Network summary: setIPv4 description: set IPv4 operationId: setIPv4 parameters: [] requestBody: description: '' content: application/json: schema: allOf: - $ref: '#/components/schemas/IPv4-setRequest' - example: config: - address: string default_gateway: string interface_name: string mode: dhcp prefix: 1 example: config: - address: string default_gateway: string interface_name: string mode: dhcp prefix: 1 required: true responses: '200': description: '' headers: {} content: {} deprecated: false /appliance/techpreview/networking/ipv4/get: post: tags: - Network summary: getIPv4Details description: set IPv4 operationId: getIPv4Details parameters: [] requestBody: description: '' content: application/json: schema: allOf: - $ref: '#/components/schemas/IPv4-detailsRequest' - example: interfaces: - nic0 example: interfaces: - nic0 required: true responses: '200': description: '' headers: {} content: {} deprecated: false /appliance/techpreview/networking/ipv4/renew: post: tags: - Network summary: renewIPv4 description: renew IPv4 operationId: renewIPv4 parameters: [] requestBody: description: '' content: application/json: schema: allOf: - $ref: '#/components/schemas/IPv4-renewRequest' - example: interfaces: - nic0 example: interfaces: - nic0 required: true responses: '200': description: '' headers: {} content: {} deprecated: false /appliance/techpreview/networking/ipv6: get: tags: - Network summary: getIPv6 description: Get IPv6 operationId: getIPv6 parameters: [] responses: '200': description: '' headers: {} content: {} deprecated: false post: tags: - Network summary: setIPv6 description: set IPv6 operationId: setIPv6 parameters: [] requestBody: description: '' content: application/json: schema: allOf: - $ref: '#/components/schemas/IPv6-setRequest' - example: config: - addresses: - address: string prefix: 1 - address: string prefix: 1 autoconf: true default_gateway: string dhcp: true interface_name: string example: config: - addresses: - address: string prefix: 1 - address: string prefix: 1 autoconf: true default_gateway: string dhcp: true interface_name: string required: true responses: '200': description: '' headers: {} content: {} deprecated: false /appliance/techpreview/networking/ipv6/get: post: tags: - Network summary: getIPv6Details description: get IPv6 Details operationId: getIPv6Details parameters: [] requestBody: description: '' content: application/json: schema: allOf: - $ref: '#/components/schemas/IPv6-detailsRequest' - example: interfaces: - nic0 example: interfaces: - nic0 required: true responses: '200': description: '' headers: {} content: {} deprecated: false /appliance/techpreview/ntp: get: tags: - Network summary: getNTPConfigurationStatus description: Get the NTP configuration status operationId: getNTPConfigurationStatus parameters: [] responses: '200': description: '' headers: {} content: {} deprecated: false /appliance/techpreview/ntp/test: post: tags: - Network summary: testNTPConfiguration description: test NTP configuration operationId: testNTPConfiguration parameters: [] requestBody: description: '' content: application/json: schema: allOf: - $ref: '#/components/schemas/NTP-testRequest' - example: servers: - string - string example: servers: - string - string required: true responses: '200': description: '' headers: {} content: {} deprecated: false /appliance/techpreview/ntp/server: post: tags: - Network summary: addNTPServer description: add NTP server operationId: addNTPServer parameters: [] requestBody: description: '' content: application/json: schema: allOf: - $ref: '#/components/schemas/NTP-addserverRequest' - example: servers: - string - string example: servers: - string - string required: true responses: '200': description: '' headers: {} content: {} deprecated: false put: tags: - Network summary: setNTPServers description: set NTP servers operationId: setNTPServers parameters: [] requestBody: description: '' content: application/json: schema: allOf: - $ref: '#/components/schemas/NTP-setserversRequest' - example: servers: - string - string example: servers: - string - string required: true responses: '200': description: '' headers: {} content: {} deprecated: false /appliance/techpreview/ntp/server/delete: post: tags: - Network summary: deleteNTPServer description: delete NTP server operationId: deleteNTPServer parameters: [] requestBody: description: '' content: application/json: schema: allOf: - $ref: '#/components/schemas/NTP-deleteserverRequest' - example: servers: - string - string example: servers: - string - string required: true responses: '200': description: '' headers: {} content: {} deprecated: false /appliance/techpreview/networking/proxy: get: tags: - Network summary: getProxyConfigurations description: Get proxy configurations operationId: getProxyConfigurations parameters: [] responses: '200': description: '' headers: {} content: {} deprecated: false put: tags: - Network summary: setProxyConfiguration description: set Proxy Configuration operationId: setProxyConfiguration parameters: [] requestBody: description: '' content: application/json: schema: allOf: - $ref: '#/components/schemas/Proxy-setRequest' - example: config: configlist: - password: secret string port: 1 protocol: ftp server: string username: string - password: secret string port: 1 protocol: ftp server: string username: string status: disabled example: config: configlist: - password: secret string port: 1 protocol: ftp server: string username: string - password: secret string port: 1 protocol: ftp server: string username: string status: disabled required: true responses: '200': description: '' headers: {} content: {} deprecated: false /appliance/techpreview/networking/proxy/test: post: tags: - Network summary: testProxyConfiguration description: '' operationId: testProxyConfiguration parameters: [] requestBody: description: '' content: application/json: schema: allOf: - $ref: '#/components/schemas/Proxy-testRequest' - example: config: password: secret string port: 1 protocol: ftp server: string testhost: string username: string example: config: password: secret string port: 1 protocol: ftp server: string testhost: string username: string required: true responses: '200': description: '' headers: {} content: {} deprecated: false /appliance/techpreview/networking/proxy/delete: post: tags: - Network summary: deleteProxyConfiguration description: Delete Proxy Configuration operationId: deleteProxyConfiguration parameters: [] requestBody: description: '' content: application/json: schema: allOf: - $ref: '#/components/schemas/Proxy-deleteRequest' - example: protocol: ftp example: protocol: ftp required: true responses: '200': description: '' headers: {} content: {} deprecated: false /appliance/techpreview/networking/routes: get: tags: - Network summary: listNetworkRoutes description: List Network Routes operationId: listNetworkRoutes parameters: [] responses: '200': description: '' headers: {} content: {} deprecated: false put: tags: - Network summary: setNetworkRoutes description: Set Network Routes operationId: setNetworkRoutes parameters: [] requestBody: description: '' content: application/json: schema: allOf: - $ref: '#/components/schemas/SetRequest' - example: routes: - destination: string gateway: string interface_name: string prefix: 1 - destination: string gateway: string interface_name: string prefix: 1 example: routes: - destination: string gateway: string interface_name: string prefix: 1 - destination: string gateway: string interface_name: string prefix: 1 required: true responses: '200': description: '' headers: {} content: {} deprecated: false post: tags: - Techpreview - Routes summary: addNetworkRoute description: add Network Routes operationId: addNetworkRoute parameters: [] requestBody: description: '' content: application/json: schema: allOf: - $ref: '#/components/schemas/Routes-addRequest' - example: route: destination: string gateway: string interface_name: string prefix: 1 example: route: destination: string gateway: string interface_name: string prefix: 1 required: true responses: '200': description: '' headers: {} content: {} deprecated: false /appliance/techpreview/networking/routes/test: post: tags: - Network summary: testNetworkRoutes description: test Network Routes operationId: testNetworkRoutes parameters: [] requestBody: description: '' content: application/json: schema: allOf: - $ref: '#/components/schemas/Routes-testRequest' - example: gateways: - string - string example: gateways: - string - string required: true responses: '200': description: '' headers: {} content: {} deprecated: false /appliance/techpreview/networking/routes/delete: post: tags: - Network summary: deleteNetworkRoutes description: Delete Network Routes operationId: deleteNetworkRoutes parameters: [] requestBody: description: '' content: application/json: schema: allOf: - $ref: '#/components/schemas/Routes-deleteRequest' - example: route: destination: string gateway: string interface_name: string prefix: 1 example: route: destination: string gateway: string interface_name: string prefix: 1 required: true responses: '200': description: '' headers: {} content: {} deprecated: false /appliance/recovery/backup/job: get: tags: - Recovery summary: getBackupJob description: get Backup job operationId: getBackupJob parameters: [] responses: '200': description: '' headers: {} content: {} deprecated: false post: tags: - Recovery summary: createBackupJob description: create Backup job operationId: createBackupJob parameters: [] requestBody: description: '' content: application/json: schema: allOf: - $ref: '#/components/schemas/Backupjob-createRequest' - example: piece: backup_password: string comment: string location: https://webdavserver/location location_password: secret_string location_type: HTTPS location_user: string parts: - string - string example: piece: backup_password: string comment: string location: https://webdavserver/location location_password: secret_string location_type: HTTPS location_user: string parts: - string - string required: true responses: '200': description: '' headers: {} content: {} deprecated: false /appliance/recovery/backup/validate: post: tags: - Recovery summary: validateBackupjJob description: validate Backup job operationId: validateBackupjJob parameters: [] requestBody: description: '' content: application/json: schema: allOf: - $ref: '#/components/schemas/Backupjob-validateRequest' - example: piece: backup_password: string comment: string location: https://webdavserver/location location_password: secret_string location_type: HTTPS location_user: string parts: - string - string example: piece: backup_password: string comment: string location: https://webdavserver/location location_password: secret_string location_type: HTTPS location_user: string parts: - string - string required: true responses: '200': description: '' headers: {} content: {} deprecated: false /appliance/recovery/backup/job/{jobid}/cancel: post: tags: - Recovery summary: cancelBackupJob description: cancel Backup job operationId: cancelBackupJob parameters: - name: jobid in: path description: id of the job required: true style: simple schema: type: string responses: '200': description: '' headers: {} content: {} deprecated: false /appliance/recovery/backup/job/{jobid}: get: tags: - Recovery summary: getBackupJobStatus description: '' operationId: getBackupJobStatus parameters: - name: jobid in: path description: id of the job required: true style: simple schema: type: string responses: '200': description: '' headers: {} content: {} deprecated: false /appliance/recovery/backup/job/details: get: tags: - Recovery summary: getBackupJobDetails description: Get Backup job details operationId: getBackupJobDetails parameters: [] responses: '200': description: '' headers: {} content: {} deprecated: false /appliance/recovery/backup/parts: get: tags: - Recovery summary: getBackupParts description: Get a list of the backup parts operationId: getBackupParts parameters: [] responses: '200': description: '' headers: {} content: {} deprecated: false /appliance/recovery/backup/parts/{partsid}: get: tags: - Recovery summary: getBackupPartSize description: Get size of the optional part operationId: getBackupPartSize parameters: - name: partsid in: path description: id of the part required: true style: simple schema: type: string responses: '200': description: '' headers: {} content: {} deprecated: false /appliance/recovery/backup/schedules: get: tags: - Recovery summary: getBackupSchedule description: get Backup schedule operationId: getBackupSchedule parameters: [] responses: '200': description: '' headers: {} content: {} deprecated: false /appliance/recovery/backup/schedules/{scheduleid}: post: tags: - Recovery summary: createBackupSchedule description: create Backup schedule operationId: createBackupSchedule parameters: - name: scheduleid in: path description: id of the schedule required: true style: simple schema: type: string requestBody: description: '' content: application/json: schema: allOf: - $ref: '#/components/schemas/Backupschedule-createRequest' - example: spec: recurrence_info: hour: 0 days: - MONDAY minute: 0 backup_password: string location: string retention_info: max_count: 0 parts: - string enable: true location_password: string location_user: string example: spec: recurrence_info: hour: 0 days: - MONDAY minute: 0 backup_password: string location: string retention_info: max_count: 0 parts: - string enable: true location_password: string location_user: string required: true responses: '200': description: '' headers: {} content: {} deprecated: false get: tags: - Recovery summary: getBackupScheduleDetails description: get Backup schedule Details operationId: getBackupScheduleDetails parameters: - name: scheduleid in: path description: id of the schedule required: true style: simple schema: type: string responses: '200': description: '' headers: {} content: {} deprecated: false delete: tags: - Recovery summary: deleteBackupSchedule description: '' operationId: deleteBackupSchedule parameters: - name: scheduleid in: path description: id of the schedule required: true style: simple schema: type: string responses: '200': description: '' headers: {} content: {} deprecated: false put: tags: - Recovery summary: updateBackupSchedule description: update Backup schedule operationId: updateBackupSchedule parameters: - name: scheduleid in: path description: id of the schedule required: true style: simple schema: type: string requestBody: description: '' content: application/json: schema: allOf: - $ref: '#/components/schemas/Backupschedule-updateRequest' - example: spec: recurrence_info: hour: 0 days: - MONDAY minute: 0 backup_password: string location: string retention_info: max_count: 0 parts: - string enable: true location_password: string location_user: string example: spec: recurrence_info: hour: 0 days: - MONDAY minute: 0 backup_password: string location: string retention_info: max_count: 0 parts: - string enable: true location_password: string location_user: string required: true responses: '200': description: '' headers: {} content: {} deprecated: false /appliance/recovery/restore/job: get: tags: - Recovery summary: getRestoreJob description: get Restore job operationId: getRestoreJob parameters: [] responses: '200': description: '' headers: {} content: {} deprecated: false post: tags: - Recovery summary: createRestoreJob description: create Restore job operationId: createRestoreJob parameters: [] requestBody: description: '' content: application/json: schema: allOf: - $ref: '#/components/schemas/Restorejob-createRequest' - example: piece: backup_password: secret string location: string location_password: secret string location_type: FTPS location_user: string example: piece: backup_password: secret string location: string location_password: secret string location_type: FTPS location_user: string required: true responses: '200': description: '' headers: {} content: {} deprecated: false /appliance/recovery/restore/job/cancel: post: tags: - Recovery summary: cancelRestoreJob description: cancel Restore job operationId: cancelRestoreJob parameters: [] responses: '200': description: '' headers: {} content: {} deprecated: false /appliance/system/storage: get: tags: - System summary: getSystemStorage description: get system Storage operationId: getSystemStorage parameters: [] responses: '200': description: '' headers: {} content: {} deprecated: false /appliance/system/storage/resize: post: tags: - System summary: resizeSystemStorage description: Resize all partitions to 100 percent of disk size operationId: resizeSystemStorage parameters: [] responses: '200': description: '' headers: {} content: {} deprecated: false /appliance/system/time: get: tags: - System summary: getSystemTime description: get System Time operationId: getSystemTime parameters: [] responses: '200': description: '' headers: {} content: {} deprecated: false /appliance/system/uptime: get: tags: - System summary: getSystemUptime description: get System Uptime operationId: getSystemUptime parameters: [] responses: '200': description: '' headers: {} content: {} deprecated: false /appliance/system/version: get: tags: - System summary: getSystemVersion description: get System Version operationId: getSystemVersion parameters: [] responses: '200': description: '' headers: {} content: {} deprecated: false /appliance/techpreview/shutdown: get: tags: - System summary: getSystemShutdownOperations description: Get System Shutdown operations operationId: getSystemShutdownOperations parameters: [] responses: '200': description: '' headers: {} content: {} deprecated: false /appliance/techpreview/shutdown/poweroff: post: tags: - System summary: startSystemShutdown description: start System Shutdown operationId: startSystemShutdown parameters: [] requestBody: description: '' content: application/json: schema: allOf: - $ref: '#/components/schemas/ShutdownRequest' - example: config: delay: 1 reason: string example: config: delay: 1 reason: string required: true responses: '200': description: '' headers: {} content: {} deprecated: false /appliance/techpreview/shutdown/cancel: post: tags: - System summary: cancelSystemShutdown description: Cancel System Shutdown operationId: cancelSystemShutdown parameters: [] responses: '200': description: '' headers: {} content: {} deprecated: false /appliance/techpreview/shutdown/restart: post: tags: - System summary: restartSystem description: Restart System operationId: restartSystem parameters: [] requestBody: description: '' content: application/json: schema: allOf: - $ref: '#/components/schemas/RestartRequest' - example: config: delay: 1 reason: string example: config: delay: 1 reason: string required: true responses: '200': description: '' headers: {} content: {} deprecated: false /appliance/techpreview/system/update: get: tags: - System summary: getSystemUpdateRepository description: Get update repository configuration. operationId: getSystemUpdateRepository parameters: [] responses: '200': description: '' headers: {} content: {} deprecated: false post: tags: - System summary: setSystemUpdateRepository description: Set update repository configuration. operationId: setSystemUpdateRepository parameters: [] requestBody: description: '' content: application/json: schema: allOf: - $ref: '#/components/schemas/System-updaterepositoryRequest' - example: config: check_updates: disabled current_URL: string day: Monday password: secret string time: string username: string example: config: check_updates: disabled current_URL: string day: Monday password: secret string time: string username: string required: true responses: '200': description: '' headers: {} content: {} deprecated: false /appliance/techpreview/timesync: get: tags: - System summary: getTimesync description: Get Timesync operationId: getTimesync parameters: [] responses: '200': description: '' headers: {} content: {} deprecated: false put: tags: - System summary: setTimesync description: set Timesync operationId: setTimesync parameters: [] requestBody: description: '' content: application/json: schema: allOf: - $ref: '#/components/schemas/Timesync-setRequest' - example: config: mode: host example: config: mode: host required: true responses: '200': description: '' headers: {} content: {} deprecated: false /appliance/update/pending: get: tags: - vCenter summary: checkvCenterServerUpdate description: Check vCenter Server Update - URL & CD-ROM operationId: checkvCenterServerUpdate parameters: - name: source_type in: query description: '' required: true style: form explode: true schema: type: string example: LOCAL_AND_ONLINE - name: Content-Type in: header description: '' required: true style: simple schema: type: string example: application/json responses: '200': description: '' headers: {} content: {} deprecated: false /appliance/update/pending/{version}: get: tags: - vCenter summary: getvCenterServerUpdateVersionDetails description: Get vCenter Server Update - Version Details operationId: getvCenterServerUpdateVersionDetails parameters: - name: version in: path description: version required: true style: simple schema: type: string responses: '200': description: '' headers: {} content: {} deprecated: false post: tags: - vCenter summary: createvCenterServerUpdate description: create vCenter Server Update operationId: createvCenterServerUpdate parameters: - name: action in: query description: action (e.g. stage) required: true style: form explode: true schema: type: string example: stage - name: version in: path description: version required: true style: simple schema: type: string responses: '200': description: '' headers: {} content: {} deprecated: false /appliance/update/policy: get: tags: - vCenter summary: getvCenterServerUpdatePolicy description: get vCenter Server Update Policy operationId: getvCenterServerUpdatePolicy parameters: [] responses: '200': description: '' headers: {} content: {} deprecated: false put: tags: - vCenter summary: updatevCenterServerUpdatePolicy description: '' operationId: updatevCenterServerUpdatePolicy parameters: [] responses: '200': description: '' headers: {} content: {} deprecated: false /appliance/update/staged: get: tags: - vCenter summary: getvCenterServerUpdateStagedUpdate description: get vCenter Server Staged Update operationId: getvCenterServerUpdateStagedUpdate parameters: [] responses: '200': description: '' headers: {} content: {} deprecated: false delete: tags: - vCenter summary: deletevCenterServerUpdateStagedUpdate description: '' operationId: deletevCenterServerUpdateStagedUpdate parameters: [] responses: '200': description: '' headers: {} content: {} deprecated: false /appliance/update: get: tags: - vCenter summary: getvCenterServerUpdateStatus description: get vCenter Server Update Status operationId: getvCenterServerUpdateStatus parameters: [] responses: '200': description: '' headers: {} content: {} deprecated: false /appliance/techpreview/networking/firewall/addr/inbound: get: tags: - Firewall summary: listInboundFirewallRules description: Get ordered list of inbound IP addresses that are allowed or denied by firewall. operationId: listInboundFirewallRules parameters: [] responses: '200': description: '' headers: {} content: {} deprecated: false post: tags: - Firewall summary: CreateInboundFirewallRule description: Create inbound firewall rule operationId: CreateInboundFirewallRule parameters: [] requestBody: description: '' content: application/json: schema: allOf: - $ref: '#/components/schemas/CreateruleRequest' - example: pos: 1 rule: address: string interface_name: '*' policy: allow prefix: 1 example: pos: 1 rule: address: string interface_name: '*' policy: allow prefix: 1 required: true responses: '200': description: '' headers: {} content: {} deprecated: false put: tags: - Firewall summary: replaceInboundFirewallRule description: '' operationId: replaceInboundFirewallRule parameters: [] requestBody: description: '' content: application/json: schema: allOf: - $ref: '#/components/schemas/ReplaceallrulesRequest' - example: rules: - address: string interface_name: '*' policy: deny prefix: 1 - address: string interface_name: '*' policy: allow prefix: 1 example: rules: - address: string interface_name: '*' policy: deny prefix: 1 - address: string interface_name: '*' policy: allow prefix: 1 required: true responses: '200': description: '' headers: {} content: {} deprecated: false /appliance/techpreview/networking/firewall/addr/inbound/delete: post: tags: - Firewall summary: deleteInboundFirewallRule description: Delete inbound firewall rules operationId: deleteInboundFirewallRule parameters: [] requestBody: description: '' content: application/json: schema: allOf: - $ref: '#/components/schemas/DeleteruleRequest' - example: config: all: true position: 1 example: config: all: true position: 1 required: true responses: '200': description: '' headers: {} content: {} deprecated: false /appliance/techpreview/services: get: tags: - Service summary: getServices description: Get Services operationId: getServices parameters: [] responses: '200': description: '' headers: {} content: {} deprecated: false /appliance/techpreview/services/status/get: post: tags: - Service summary: getServiceDetails description: get specific service details operationId: getServiceDetails parameters: [] requestBody: description: '' content: application/json: schema: allOf: - $ref: '#/components/schemas/Services-getspecificservicedetailsRequest' - example: name: string timeout: 0 example: name: string timeout: 0 required: true responses: '200': description: '' headers: {} content: {} deprecated: false /appliance/techpreview/services/control: post: tags: - Service summary: controlServices description: Control Services operationId: controlServices parameters: [] requestBody: description: '' content: application/json: schema: allOf: - $ref: '#/components/schemas/Services-controlRequest' - example: args: - string - string name: string timeout: 1 example: args: - string - string name: string timeout: 1 required: true responses: '200': description: '' headers: {} content: {} deprecated: false /appliance/techpreview/services/restart: post: tags: - Service summary: restartServices description: Restart Services operationId: restartServices parameters: [] requestBody: description: '' content: application/json: schema: allOf: - $ref: '#/components/schemas/Services-restartRequest' - example: name: string timeout: 0 example: name: string timeout: 0 required: true responses: '200': description: '' headers: {} content: {} deprecated: false /appliance/techpreview/services/stop: post: tags: - Service summary: stopServices description: stop Services operationId: stopServices parameters: [] requestBody: description: '' content: application/json: schema: allOf: - $ref: '#/components/schemas/Services-stopRequest' - example: name: string timeout: 0 example: name: string timeout: 0 required: true responses: '200': description: '' headers: {} content: {} deprecated: false /appliance/techpreview/local-accounts/user: get: tags: - Local Accounts summary: getLocalAccounts description: Get Local accounts operationId: getLocalAccounts parameters: [] responses: '200': description: '' headers: {} content: {} deprecated: false post: tags: - Local Accounts summary: createLocalaccounts description: Create Local accounts operationId: createLocalaccounts parameters: [] requestBody: description: '' content: application/json: schema: allOf: - $ref: '#/components/schemas/Localaccounts-createRequest' - example: config: email: string@domain.com fullname: string password: secretstring role: admin username: test example: config: email: string@domain.com fullname: string password: secretstring role: admin username: test required: true responses: '200': description: '' headers: {} content: {} deprecated: false put: tags: - Local Accounts summary: updateLocalAccounts description: update Local accounts operationId: updateLocalAccounts parameters: [] requestBody: description: '' content: application/json: schema: allOf: - $ref: '#/components/schemas/Localaccounts-updateRequest' - example: config: email: string@domain.com fullname: new string role: admin status: enabled username: test example: config: email: string@domain.com fullname: new string role: admin status: enabled username: test required: true responses: '200': description: '' headers: {} content: {} deprecated: false /appliance/techpreview/local-accounts/user/{localUser}: get: tags: - Local Accounts summary: getLocalAccountsDetails description: Get Local accounts Details operationId: getLocalAccountsDetails parameters: - name: localUser in: path description: the local user account required: true style: simple schema: type: string responses: '200': description: '' headers: {} content: {} deprecated: false /appliance/techpreview/local-accounts/user/test: delete: tags: - Local Accounts summary: removeLocalAccounts description: Remove Local accounts operationId: removeLocalAccounts parameters: [] responses: '200': description: '' headers: {} content: {} deprecated: false /appliance/vmon/service: get: tags: - Vmon summary: getVmonServices description: Get Vmon Services operationId: getVmonServices parameters: [] responses: '200': description: '' headers: {} content: {} deprecated: false /appliance/vmon/service/{service}: get: tags: - Vmon summary: GetVmonServiceDetails description: Get details about specific vmon service operationId: GetVmonServiceDetails parameters: - name: service in: path description: the service required: true style: simple schema: type: string responses: '200': description: '' headers: {} content: {} deprecated: false patch: tags: - Vmon summary: UpdateVmonservice description: Update specific Vmon service operationId: UpdateVmonservice parameters: - name: service in: path description: the service required: true style: simple schema: type: string requestBody: description: '' content: application/json: schema: allOf: - $ref: '#/components/schemas/UpdatespecificserviceRequest' - example: spec: startup_type: AUTOMATIC example: spec: startup_type: AUTOMATIC required: true responses: '200': description: '' headers: {} content: {} deprecated: false /appliance/vmon/service/{service}/restart: post: tags: - Vmon summary: restartVmonService description: Restart specific Vmon service operationId: restartVmonService parameters: - name: service in: path description: the service required: true style: simple schema: type: string responses: '200': description: '' headers: {} content: {} deprecated: false /appliance/vmon/service/{service}/start: post: tags: - Vmon summary: startVmonservice description: Start Specific Vmon service operationId: startVmonservice parameters: - name: service in: path description: the service required: true style: simple schema: type: string responses: '200': description: '' headers: {} content: {} deprecated: false /appliance/vmon/service/{service}/stop: post: tags: - Vmon summary: stopVmonService description: Stop specific Vmon service operationId: stopVmonService parameters: - name: service in: path description: the service required: true style: simple schema: type: string responses: '200': description: '' headers: {} content: {} deprecated: false components: schemas: ConsoleCLI-disableRequest: title: ConsoleCLI-disableRequest required: - enabled type: object properties: enabled: type: boolean example: enabled: false ConsoleCLI-enableRequest: title: ConsoleCLI-enableRequest required: - enabled type: object properties: enabled: type: boolean example: enabled: true DCUI-disableRequest: title: DCUI-disableRequest required: - enabled type: object properties: enabled: type: boolean example: enabled: false DCUI-enableRequest: title: DCUI-enableRequest required: - enabled type: object properties: enabled: type: boolean example: enabled: true Shell-disableRequest: title: Shell-disableRequest required: - config type: object properties: config: allOf: - $ref: '#/components/schemas/Config' - example: enabled: false timeout: 1 example: config: enabled: false timeout: 1 Config: title: Config required: - enabled - timeout type: object properties: enabled: type: boolean timeout: type: integer format: int32 example: enabled: false timeout: 1 Shell-enableRequest: title: Shell-enableRequest required: - config type: object properties: config: allOf: - $ref: '#/components/schemas/Config' - example: enabled: false timeout: 1 example: config: enabled: true timeout: 3600 SSH-disableRequest: title: SSH-disableRequest required: - enabled type: object properties: enabled: type: boolean example: enabled: false SSH-enableRequest: title: SSH-enableRequest required: - enabled type: object properties: enabled: type: boolean example: enabled: true DomainssetRequest: title: DomainssetRequest required: - domains type: object properties: domains: type: array items: type: string description: '' example: domains: - vmware.com DomainsaddRequest: title: DomainsaddRequest required: - domain type: object properties: domain: type: string example: domain: myvmware.com Hostname-testRequest: title: Hostname-testRequest required: - name type: object properties: name: type: string example: name: '{{appliance_hostname}}' Hostname-setRequest: title: Hostname-setRequest required: - name type: object properties: name: type: string example: name: '{{appliance_hostname}}' DNSservers-addRequest: title: DNSservers-addRequest required: - server type: object properties: server: type: string example: server: serverB DNSservers-setRequest: title: DNSservers-setRequest required: - config type: object properties: config: allOf: - $ref: '#/components/schemas/Config2' - example: mode: is_static servers: - serverA - serverB example: config: mode: is_static servers: - serverA - serverB Config2: title: Config2 required: - mode - servers type: object properties: mode: type: string servers: type: array items: type: string description: '' example: mode: is_static servers: - serverA - serverB DNSservers-testRequest: title: DNSservers-testRequest required: - servers type: object properties: servers: type: array items: type: string description: '' example: servers: - '{{appliance_dns_a}}' Backupjob-validateRequest: title: Backupjob-validateRequest required: - piece type: object properties: piece: allOf: - $ref: '#/components/schemas/Piece' - example: backup_password: string comment: string location: https://webdavserver/location location_password: secret_string location_type: HTTPS location_user: string parts: - string - string example: piece: backup_password: string comment: string location: https://webdavserver/location location_password: secret_string location_type: HTTPS location_user: string parts: - string - string Piece: title: Piece required: - backup_password - comment - location - location_password - location_type - location_user - parts type: object properties: backup_password: type: string comment: type: string location: type: string location_password: type: string location_type: type: string location_user: type: string parts: type: array items: type: string description: '' example: backup_password: string comment: string location: https://webdavserver/location location_password: secret_string location_type: HTTPS location_user: string parts: - string - string Backupjob-createRequest: title: Backupjob-createRequest required: - piece type: object properties: piece: allOf: - $ref: '#/components/schemas/Piece' - example: backup_password: string comment: string location: https://webdavserver/location location_password: secret_string location_type: HTTPS location_user: string parts: - string - string example: piece: backup_password: string comment: string location: https://webdavserver/location location_password: secret_string location_type: HTTPS location_user: string parts: - string - string Backupschedule-createRequest: title: Backupschedule-createRequest required: - spec type: object properties: spec: allOf: - $ref: '#/components/schemas/Spec' - example: recurrence_info: hour: 0 days: - MONDAY minute: 0 backup_password: string location: string retention_info: max_count: 0 parts: - string enable: true location_password: string location_user: string example: spec: recurrence_info: hour: 0 days: - MONDAY minute: 0 backup_password: string location: string retention_info: max_count: 0 parts: - string enable: true location_password: string location_user: string Spec: title: Spec required: - recurrence_info - backup_password - location - retention_info - parts - enable - location_password - location_user type: object properties: recurrence_info: allOf: - $ref: '#/components/schemas/RecurrenceInfo' - example: hour: 0 days: - MONDAY minute: 0 backup_password: type: string location: type: string retention_info: allOf: - $ref: '#/components/schemas/RetentionInfo' - example: max_count: 0 parts: type: array items: type: string description: '' enable: type: boolean location_password: type: string location_user: type: string example: recurrence_info: hour: 0 days: - MONDAY minute: 0 backup_password: string location: string retention_info: max_count: 0 parts: - string enable: true location_password: string location_user: string RecurrenceInfo: title: RecurrenceInfo required: - hour - days - minute type: object properties: hour: type: integer format: int32 days: type: array items: type: string description: '' minute: type: integer format: int32 example: hour: 0 days: - MONDAY minute: 0 RetentionInfo: title: RetentionInfo required: - max_count type: object properties: max_count: type: integer format: int32 example: max_count: 0 Backupschedule-runRequest: title: Backupschedule-runRequest required: - comment type: object properties: comment: type: string example: comment: string Backupschedule-updateRequest: title: Backupschedule-updateRequest required: - spec type: object properties: spec: allOf: - $ref: '#/components/schemas/Spec' - example: recurrence_info: hour: 0 days: - MONDAY minute: 0 backup_password: string location: string retention_info: max_count: 0 parts: - string enable: true location_password: string location_user: string example: spec: recurrence_info: hour: 0 days: - MONDAY minute: 0 backup_password: string location: string retention_info: max_count: 0 parts: - string enable: true location_password: string location_user: string Restorejob-createRequest: title: Restorejob-createRequest required: - piece type: object properties: piece: allOf: - $ref: '#/components/schemas/Piece2' - example: backup_password: secret string location: string location_password: secret string location_type: FTPS location_user: string example: piece: backup_password: secret string location: string location_password: secret string location_type: FTPS location_user: string Piece2: title: Piece2 required: - backup_password - location - location_password - location_type - location_user type: object properties: backup_password: type: string location: type: string location_password: type: string location_type: type: string location_user: type: string example: backup_password: secret string location: string location_password: secret string location_type: FTPS location_user: string vCenterServerUpdate-InstallRequest: title: vCenterServerUpdate-InstallRequest required: - user_data type: object properties: user_data: type: array items: $ref: '#/components/schemas/UserDatum' description: '' example: user_data: - value: '{{**sso-password}}' key: vmdir.password UserDatum: title: UserDatum required: - value - key type: object properties: value: type: string key: type: string example: value: '{{**sso-password}}' key: vmdir.password vCenterServerUpdate-StageandInstallRequest: title: vCenterServerUpdate-StageandInstallRequest required: - user_data type: object properties: user_data: type: array items: $ref: '#/components/schemas/UserDatum' description: '' example: user_data: - value: '{{**sso-password}}' key: vmdir.password vCenterServerUpdate-ValidateRequest: title: vCenterServerUpdate-ValidateRequest required: - user_data type: object properties: user_data: type: array items: $ref: '#/components/schemas/UserDatum' description: '' example: user_data: - value: '{{**sso-password}}' key: vmdir.password CreateruleRequest: title: CreateruleRequest required: - pos - rule type: object properties: pos: type: integer format: int32 rule: allOf: - $ref: '#/components/schemas/Rule' - example: address: string interface_name: '*' policy: allow prefix: 1 example: pos: 1 rule: address: string interface_name: '*' policy: allow prefix: 1 Rule: title: Rule required: - address - interface_name - policy - prefix type: object properties: address: type: string interface_name: type: string policy: type: string prefix: type: integer format: int32 example: address: string interface_name: '*' policy: allow prefix: 1 DeleteruleRequest: title: DeleteruleRequest required: - config type: object properties: config: allOf: - $ref: '#/components/schemas/Config3' - example: all: true position: 1 example: config: all: true position: 1 Config3: title: Config3 required: - all - position type: object properties: all: type: boolean position: type: integer format: int32 example: all: true position: 1 ReplaceallrulesRequest: title: ReplaceallrulesRequest required: - rules type: object properties: rules: type: array items: $ref: '#/components/schemas/Rule' description: '' example: rules: - address: string interface_name: '*' policy: deny prefix: 1 - address: string interface_name: '*' policy: allow prefix: 1 IPv4-detailsRequest: title: IPv4-detailsRequest required: - interfaces type: object properties: interfaces: type: array items: type: string description: '' example: interfaces: - nic0 IPv4-renewRequest: title: IPv4-renewRequest required: - interfaces type: object properties: interfaces: type: array items: type: string description: '' example: interfaces: - nic0 IPv4-setRequest: title: IPv4-setRequest required: - config type: object properties: config: type: array items: $ref: '#/components/schemas/Config4' description: '' example: config: - address: string default_gateway: string interface_name: string mode: dhcp prefix: 1 Config4: title: Config4 required: - address - default_gateway - interface_name - mode - prefix type: object properties: address: type: string default_gateway: type: string interface_name: type: string mode: type: string prefix: type: integer format: int32 example: address: string default_gateway: string interface_name: string mode: dhcp prefix: 1 IPv6-detailsRequest: title: IPv6-detailsRequest required: - interfaces type: object properties: interfaces: type: array items: type: string description: '' example: interfaces: - nic0 IPv6-setRequest: title: IPv6-setRequest required: - config type: object properties: config: type: array items: $ref: '#/components/schemas/Config5' description: '' example: config: - addresses: - address: string prefix: 1 - address: string prefix: 1 autoconf: true default_gateway: string dhcp: true interface_name: string Config5: title: Config5 required: - addresses - autoconf - default_gateway - dhcp - interface_name type: object properties: addresses: type: array items: $ref: '#/components/schemas/Address' description: '' autoconf: type: boolean default_gateway: type: string dhcp: type: boolean interface_name: type: string example: addresses: - address: string prefix: 1 - address: string prefix: 1 autoconf: true default_gateway: string dhcp: true interface_name: string Address: title: Address required: - address - prefix type: object properties: address: type: string prefix: type: integer format: int32 example: address: string prefix: 1 GeneratehashRequest: title: GeneratehashRequest required: - config type: object properties: config: allOf: - $ref: '#/components/schemas/Config6' - example: auth_hash: string priv_hash: string raw_secret: true example: config: auth_hash: string priv_hash: string raw_secret: true Config6: title: Config6 required: - auth_hash - priv_hash - raw_secret type: object properties: auth_hash: type: string priv_hash: type: string raw_secret: type: boolean example: auth_hash: string priv_hash: string raw_secret: true SetSNMPconfigurationRequest: title: SetSNMPconfigurationRequest required: - config type: object properties: config: allOf: - $ref: '#/components/schemas/Config7' - example: authentication: none communities: - string - bstring engineid: string loglevel: string notraps: - string - bstring port: 1 privacy: AES128 remoteusers: - string - bstring syscontact: string syslocation: string targets: - string - bstring users: - string - bstring v3targets: - string - bstring example: config: authentication: none communities: - string - bstring engineid: string loglevel: string notraps: - string - bstring port: 1 privacy: AES128 remoteusers: - string - bstring syscontact: string syslocation: string targets: - string - bstring users: - string - bstring v3targets: - string - bstring Config7: title: Config7 required: - authentication - communities - engineid - loglevel - notraps - port - privacy - remoteusers - syscontact - syslocation - targets - users - v3targets type: object properties: authentication: type: string communities: type: array items: type: string description: '' engineid: type: string loglevel: type: string notraps: type: array items: type: string description: '' port: type: integer format: int32 privacy: type: string remoteusers: type: array items: type: string description: '' syscontact: type: string syslocation: type: string targets: type: array items: type: string description: '' users: type: array items: type: string description: '' v3targets: type: array items: type: string description: '' example: authentication: none communities: - string - bstring engineid: string loglevel: string notraps: - string - bstring port: 1 privacy: AES128 remoteusers: - string - bstring syscontact: string syslocation: string targets: - string - bstring users: - string - bstring v3targets: - string - bstring NTP-testRequest: title: NTP-testRequest required: - servers type: object properties: servers: type: array items: type: string description: '' example: servers: - string - string NTP-addserverRequest: title: NTP-addserverRequest required: - servers type: object properties: servers: type: array items: type: string description: '' example: servers: - string - string NTP-deleteserverRequest: title: NTP-deleteserverRequest required: - servers type: object properties: servers: type: array items: type: string description: '' example: servers: - string - string NTP-setserversRequest: title: NTP-setserversRequest required: - servers type: object properties: servers: type: array items: type: string description: '' example: servers: - string - string ShutdownRequest: title: ShutdownRequest required: - config type: object properties: config: allOf: - $ref: '#/components/schemas/Config8' - example: delay: 1 reason: string example: config: delay: 1 reason: string Config8: title: Config8 required: - delay - reason type: object properties: delay: type: integer format: int32 reason: type: string example: delay: 1 reason: string RestartRequest: title: RestartRequest required: - config type: object properties: config: allOf: - $ref: '#/components/schemas/Config8' - example: delay: 1 reason: string example: config: delay: 1 reason: string Proxy-setRequest: title: Proxy-setRequest required: - config type: object properties: config: allOf: - $ref: '#/components/schemas/Config10' - example: configlist: - password: secret string port: 1 protocol: ftp server: string username: string - password: secret string port: 1 protocol: ftp server: string username: string status: disabled example: config: configlist: - password: secret string port: 1 protocol: ftp server: string username: string - password: secret string port: 1 protocol: ftp server: string username: string status: disabled Config10: title: Config10 required: - configlist - status type: object properties: configlist: type: array items: $ref: '#/components/schemas/Configlist' description: '' status: type: string example: configlist: - password: secret string port: 1 protocol: ftp server: string username: string - password: secret string port: 1 protocol: ftp server: string username: string status: disabled Configlist: title: Configlist required: - password - port - protocol - server - username type: object properties: password: type: string port: type: integer format: int32 protocol: type: string server: type: string username: type: string example: password: secret string port: 1 protocol: ftp server: string username: string Proxy-testRequest: title: Proxy-testRequest required: - config type: object properties: config: allOf: - $ref: '#/components/schemas/Config11' - example: password: secret string port: 1 protocol: ftp server: string testhost: string username: string example: config: password: secret string port: 1 protocol: ftp server: string testhost: string username: string Config11: title: Config11 required: - password - port - protocol - server - testhost - username type: object properties: password: type: string port: type: integer format: int32 protocol: type: string server: type: string testhost: type: string username: type: string example: password: secret string port: 1 protocol: ftp server: string testhost: string username: string Proxy-deleteRequest: title: Proxy-deleteRequest required: - protocol type: object properties: protocol: type: string example: protocol: ftp SetRequest: title: SetRequest required: - routes type: object properties: routes: type: array items: $ref: '#/components/schemas/Route' description: '' example: routes: - destination: string gateway: string interface_name: string prefix: 1 - destination: string gateway: string interface_name: string prefix: 1 Route: title: Route required: - destination - gateway - interface_name - prefix type: object properties: destination: type: string gateway: type: string interface_name: type: string prefix: type: integer format: int32 example: destination: string gateway: string interface_name: string prefix: 1 Routes-addRequest: title: Routes-addRequest required: - route type: object properties: route: allOf: - $ref: '#/components/schemas/Route' - example: destination: string gateway: string interface_name: string prefix: 1 example: route: destination: string gateway: string interface_name: string prefix: 1 Routes-testRequest: title: Routes-testRequest required: - gateways type: object properties: gateways: type: array items: type: string description: '' example: gateways: - string - string Routes-deleteRequest: title: Routes-deleteRequest required: - route type: object properties: route: allOf: - $ref: '#/components/schemas/Route' - example: destination: string gateway: string interface_name: string prefix: 1 example: route: destination: string gateway: string interface_name: string prefix: 1 Services-getspecificservicedetailsRequest: title: Services-getspecificservicedetailsRequest required: - name - timeout type: object properties: name: type: string timeout: type: integer format: int32 example: name: string timeout: 0 Services-controlRequest: title: Services-controlRequest required: - args - name - timeout type: object properties: args: type: array items: type: string description: '' name: type: string timeout: type: integer format: int32 example: args: - string - string name: string timeout: 1 Services-restartRequest: title: Services-restartRequest required: - name - timeout type: object properties: name: type: string timeout: type: integer format: int32 example: name: string timeout: 0 Services-stopRequest: title: Services-stopRequest required: - name - timeout type: object properties: name: type: string timeout: type: integer format: int32 example: name: string timeout: 0 System-updaterepositoryRequest: title: System-updaterepositoryRequest required: - config type: object properties: config: allOf: - $ref: '#/components/schemas/Config12' - example: check_updates: disabled current_URL: string day: Monday password: secret string time: string username: string example: config: check_updates: disabled current_URL: string day: Monday password: secret string time: string username: string Config12: title: Config12 required: - check_updates - current_URL - day - password - time - username type: object properties: check_updates: type: string current_URL: type: string day: type: string password: type: string time: type: string username: type: string example: check_updates: disabled current_URL: string day: Monday password: secret string time: string username: string Timesync-setRequest: title: Timesync-setRequest required: - config type: object properties: config: allOf: - $ref: '#/components/schemas/Config13' - example: mode: host example: config: mode: host Config13: title: Config13 required: - mode type: object properties: mode: type: string example: mode: host Localaccounts-createRequest: title: Localaccounts-createRequest required: - config type: object properties: config: allOf: - $ref: '#/components/schemas/Config14' - example: email: string@domain.com fullname: string password: secretstring role: admin username: test example: config: email: string@domain.com fullname: string password: secretstring role: admin username: test Config14: title: Config14 required: - email - fullname - password - role - username type: object properties: email: type: string fullname: type: string password: type: string role: type: string username: type: string example: email: string@domain.com fullname: string password: secretstring role: admin username: test Localaccounts-updateRequest: title: Localaccounts-updateRequest required: - config type: object properties: config: allOf: - $ref: '#/components/schemas/Config15' - example: email: string@domain.com fullname: new string role: admin status: enabled username: test example: config: email: string@domain.com fullname: new string role: admin status: enabled username: test Config15: title: Config15 required: - email - fullname - role - status - username type: object properties: email: type: string fullname: type: string role: type: string status: type: string username: type: string example: email: string@domain.com fullname: new string role: admin status: enabled username: test UpdatespecificserviceRequest: title: UpdatespecificserviceRequest required: - spec type: object properties: spec: allOf: - $ref: '#/components/schemas/Spec2' - example: startup_type: AUTOMATIC example: spec: startup_type: AUTOMATIC Spec2: title: Spec2 required: - startup_type type: object properties: startup_type: type: string example: startup_type: AUTOMATIC securitySchemes: httpBasic: type: http scheme: basic security: - httpBasic: [] tags: - name: Access - name: Health - name: Monitoring - name: Network - name: Recovery - name: System - name: vCenter - name: Firewall - name: Service - name: Local Accounts - name: Vmon - name: Techpreview - Routes description: ''