Schedule Agent For Upgrade Rds Server

Schedule Agent For Upgrade Rds Server

All the listed privileges are required -

Privileges Description
MACHINE_MAINTENANCE Caller should have permission to this privilege, to perform this operation.
Request
URI
POST
https://{api_host}/rest/inventory/v1/rds-servers/action/schedule-agent-upgrade
COPY
Request Body
AgentUpgradeSpec of type(s) application/json
Required

Show optional properties

{
    "agent_installer_package_id": "2b6eaeb8-2e91-11ed-a261-0242ac120002",
    "end_time": 1652079610000,
    "machine_or_rds_server_ids": [
        {}
    ],
    "start_time": 1652079610000
}
{
    "agent_installer_package_id": "2b6eaeb8-2e91-11ed-a261-0242ac120002",
    "batch_size": 20,
    "custom_install_parameters": "ADDLOCAL=Core,USB",
    "end_time": 1652079610000,
    "failure_threshold": 10,
    "machine_or_rds_server_ids": [
        "0103796c-102b-4ed3-953f-3dfe3d23e0fe",
        "7cdd624f-37d1-46c1-ab96-695a5d13956f"
    ],
    "skip_for_logged_in_users": true,
    "start_time": 1652079610000
}
string
agent_installer_package_id
Required

ID of the agent installer package.

integer As int32 As int32
batch_size
Optional
Constraints: minimum: 1 maximum: 100 default: 20

Indicates the size of the batch to be considered for agent upgrade, in percentage.

string
custom_install_parameters
Optional

Indicates any parameters to be used by the agent for silent install.

integer As int64 As int64
end_time
Required

Agent upgrade end time.

integer As int32 As int32
failure_threshold
Optional
Constraints: minimum: 1 maximum: 100 default: 10

Indicates the threshold for tolerating failures, beyond which upgrades will be skipped, in percentage.

array of string
machine_or_rds_server_ids
Required

Machines or RDS servers on which the upgrade is to be scheduled.

boolean
skip_for_logged_in_users
Optional

Indicates whether to skip agent upgrade for logged in users.

integer As int64 As int64
start_time
Required

Agent upgrade start time.

Authentication
This operation uses the following authentication methods.
Responses
200

OK

Returns AgentUpgradeTaskResponseInfo of type(s) */* 
"AgentUpgradeTaskResponseInfo Object"
array of object
details
Optional

List of BulkItemResponseInfo corresponding to each machine id in the action operation.

string
task_id
Optional

Unique ID representing the task.


400

Bad Request

Operation doesn't return any data structure

401

User is not authenticated

Operation doesn't return any data structure

403

Access to the resource is forbidden

Operation doesn't return any data structure

Code Samples
COPY
                    curl -X POST -H 'Authorization: <value>' -H 'Content-Type: application/json' -d '{"agent_installer_package_id:"string","end_time:"integer","machine_or_rds_server_ids":["string"],"start_time:"integer"}' https://{api_host}/rest/inventory/v1/rds-servers/action/schedule-agent-upgrade
On This Page
Inventory Operations
GET
List Agent Installer Packages
POST
Register Agent Installer Package
GET
Get Agent Installer Package
POST
Unregister Agent Installer Package
GET
List Application Icons
POST
Create Application Icon
GET
List Custom Application Icons
DELETE
Delete Application Icon
GET
Get Application Icon
GET
List Application Pools
POST
Create Application Pool
POST
Application Icon Bulk Associate
POST
Check Application Pool Name Availability
POST
Disable Application Pools
POST
Enable Application Pools
POST
Application Icon Bulk Remove Association
DELETE
Delete Application Pool
GET
Get Application Pool
PUT
Update Application Pool
POST
Add Custom Icon
POST
Remove Custom Icon
GET
List Category Folders
GET
List Desktop Pools
POST
Create Desktop Pool
POST
Check Desktop Pool Name Availability
POST
Disable Desktop Pools
POST
Disable Provisioning For Desktop Pools
POST
Enable Desktop Pools
POST
Enable Provisioning For Desktop Pools
POST
Validate Specified Names
GET
List User Policies Overrides
DELETE
Delete Desktop Pool
GET
Get Desktop Pool
PUT
Update Desktop Pool
POST
Add Machines
POST
Add Machines By Name
POST
Desktop Pool Apply Image
POST
Cancel Scheduled Push Image
POST
Desktop Pool Promote Pending Image
POST
Remove Machines
POST
Schedule Push Image
POST
Validate Installed Applications On Desktop Pool
GET
List Installed Applications On Desktop Pool
GET
List Policies On Desktop Pool
PUT
Updates Policies On Desktop Pool
DELETE
Delete Policy Overrides For Users
POST
Create Policy Overrides For Users
PUT
Update Policy Overrides For Users
GET
List Desktop Pool Tasks
GET
Get Desktop Pool Task
POST
Cancel Desktop Pool Task
POST
Pause Desktop Pool Task
POST
Resume Desktop Pool Task
GET
List Farms
POST
Create Farm
POST
Check Farm Name Availability
DELETE
Delete Farm
GET
Get Farm
PUT
Update Farm
POST
Add Rds Servers
POST
Farm Apply Image
POST
Cancel Scheduled Maintenance
POST
Farm Promote Pending Image
POST
Remove Rds Servers
POST
Schedule Maintenance
POST
Validate Installed Applications On Farm
GET
List App Volumes Applications On Farm
GET
List Installed Applications On Farm
GET
List Global Application Entitlements
POST
Create Global Application Entitlement
DELETE
Delete Global Application Entitlement
GET
Get Global Application Entitlement
PUT
Update Global Application Entitlement
GET
List Compatible Backup GA Es
GET
List Compatible Local Application Pools
DELETE
Remove Local Application Pools From GAE
GET
List Local Application Pools
POST
Add Local Application Pools To GAE
GET
List Global Desktop Entitlements
POST
Create Global Desktop Entitlement
DELETE
Delete Global Desktop Entitlement
GET
Get Global Desktop Entitlement
PUT
Update Global Desktop Entitlement
GET
List Compatible Backup GD Es
GET
List Compatible Local Desktop Pools
DELETE
Remove Local Desktop Pools From GDE
GET
List Local Desktop Pools
POST
Add Local Desktop Pools To GDE
GET
Query Global Sessions
POST
Disconnect Global Sessions
POST
Log Off Global Sessions
POST
Reset Global Sessions
POST
Restart Global Sessions
POST
Send Message To Global Sessions
DELETE
Delete Machines
GET
List Machines
POST
Archive Machines
POST
Cancel Agent Upgrades
POST
Check Machine Prefix Availability
POST
Enter Maintenance
POST
Exit Maintenance
POST
Rebuild Machines
POST
Recover Machines
POST
Recreate From Persistent Disk
POST
Reset Machines
POST
Restart Machines
POST
Schedule Agent For Upgrade
GET
List Agent Upgrade Tasks
GET
Get Agent Upgrade Task
GET
List Unentitled Machines
DELETE
Delete Machine
GET
Get Machine
POST
Assign Machine Aliases
POST
Assign Users
POST
Attach Persistent Disk
POST
Detach Persistent Disk
POST
Unassign Machine Aliases
POST
Unassign Users
GET
List Persistent Disks
POST
Create Persistent Disk
DELETE
Delete Persistent Disk
GET
Get Persistent Disk
PUT
Update Persistent Disk
GET
List Attachable Machines
GET
List Physical Machines
POST
Register Physical Machine
DELETE
Delete Physical Machine
GET
Get Physical Machine
GET
List RDS Servers
POST
Cancel Rds Server Agent Upgrades
POST
Check RDS Server Prefix Availability
POST
Recover RDS Servers
POST
Register RDS Server
POST
Schedule Agent For Upgrade Rds Server
GET
List Rds Server Agent Upgrade Tasks
GET
Get Rds Server Agent Upgrade Task
DELETE
Delete RDS Server
GET
Get RDS Server
PUT
Update RDS Server
GET
List Session Info
POST
Disconnect Sessions
POST
Log Off Sessions
POST
Reset Sessions
POST
Restart Sessions
POST
Send Message To Sessions
GET
Get Session Info
GET
List Application Pools V2
POST
Create Application Pool V2
GET
Get Application Pool V2
PUT
Update Application Pool V2
GET
List Desktop Pools V2
POST
Create Desktop Pool V2
GET
Get Desktop Pool V2
POST
Schedule Push Image V2
GET
List Farms V2
POST
Create Farm V2
GET
Get Farm V2
PUT
Update Farm V2
POST
Schedule Maintenance V2
GET
List Global Application Entitlements V2
GET
Get Global Application Entitlement V2
GET
List Global Desktop Entitlements V2
POST
Create Global Desktop Entitlement V2
GET
Get Global Desktop Entitlement V2
GET
List Machines V2
POST
Schedule Agent For Upgrade V2
GET
List Agent Upgrade Tasks V2
GET
Get Agent Upgrade Task V2
GET
Get Machine V2
GET
List Physical Machines V2
GET
Get Physical Machine V2
GET
List RDS Servers V2
DELETE
Delete RDS Server V2
GET
Get RDS Server V2
PUT
Update RDS Server V2
GET
List Session Info V2
GET
List Application Pools V3
POST
Create Application Pool V3
GET
Get Application Pool V3
PUT
Update Application Pool V3
GET
List Desktop Pools V3
GET
Get Desktop Pool V3
GET
List Farms V3
POST
Create Farm V3
GET
Get Farm V3
PUT
Update Farm V3
GET
List Global Application Entitlements V3
POST
Create Global Application Entitlement V3
DELETE
Delete Global Application Entitlement V3
GET
Get Global Application Entitlement V3
PUT
Update Global Application Entitlement V3
GET
List Global Desktop Entitlements V3
POST
Create Global Desktop Entitlement V3
DELETE
Delete Global Desktop Entitlement V3
GET
Get Global Desktop Entitlement V3
PUT
Update Global Desktop Entitlement V3
GET
List Machines V3
GET
Get Machine V3
DELETE
Delete Application Pools
GET
List Application Pools V4
GET
Get Application Pool V4
GET
List Desktop Pools V4
GET
Get Desktop Pool V4
GET
List Farms V4
GET
Get Farm V4
GET
List Global Application Entitlements V4
POST
Create Global Application Entitlement V4
DELETE
Delete Global Application Entitlement V4
GET
Get Global Application Entitlement V4
PUT
Update Global Application Entitlement V4
GET
List Global Desktop Entitlements V4
POST
Create Global Desktop Entitlement V4
DELETE
Delete Global Desktop Entitlement V4
GET
Get Global Desktop Entitlement V4
PUT
Update Global Desktop Entitlement V4
GET
List Machines V4
GET
Get Machine V4
DELETE
Delete Application Pools V5
GET
List Application Pools V5
POST
Create Application Pool V5
GET
Get Application Pool V5
PUT
Update Application Pool V5
GET
List Desktop Pools V5
GET
Get Desktop Pool V5
GET
List Farms V5
GET
Get Farm V5
GET
List Machines V5
GET
Get Machine V5
DELETE
Delete Application Pools V6
GET
List Application Pools V6
POST
Create Application Pool V6
GET
Get Application Pool V6
PUT
Update Application Pool V6
GET
List Desktop Pools V6
GET
Get Desktop Pool V6
GET
List Farms V6
POST
Create Farm V6
DELETE
Delete Farm V6
GET
Get Farm V6
PUT
Update Farm V6
GET
List Desktop Pools V7
POST
Create Desktop Pool V7
DELETE
Delete Desktop Pool V7
GET
Get Desktop Pool V7
PUT
Update Desktop Poolv7
GET
List Farms V7
POST
Create Farm V7
DELETE
Delete Farm V7
GET
Get Farm V7
PUT
Update Farm V7
GET
List Desktop Pools V8
POST
Create Desktop Pool V8
DELETE
Delete Desktop Pool V8
GET
Get Desktop Pool V8
PUT
Update Desktop Poolv8