1. Operations
  2. appliance
  3. update
  4. policy

appliance update policy: set

Sets the automatic update checking and staging policy.

Request:

HTTP request

PUT https://{server}/rest/appliance/update/policy

Request Body Structure:

{
    "policy": {
        "auto_stage": true,
        "check_schedule": [
            {
                "day": "MONDAY",
                "hour": 1,
                "minute": 1
            },
            {
                "day": "MONDAY",
                "hour": 1,
                "minute": 1
            }
        ],
        "custom_URL": "string",
        "password": "secret string",
        "username": "string"
    }
}

Request Body Parameters:

Name Type Description
bold = required
policy config Info structure containing the policy for the appliance update.
policy.custom_URL string Current appliance update repository URL.

Optional. If unset then default URL is assumed.

policy.username string Username for the update repository

Optional. If unset username will not be used to login.

policy.password secret Password for the update repository

Optional. password If unset password will not be used to login.

policy.check_schedule time[] Schedule when the automatic check will be run.
policy.check_schedule[].day string weekday to check for updates.

Defines the set of days Value is one of:
MONDAY: Monday
TUESDAY: Tuesday
WEDNESDAY: Wednesday
THURSDAY: Thursday
FRIDAY: Friday
SATURDAY: Saturday
SUNDAY: Sunday
policy.check_schedule[].hour long Hour: 0-24
policy.check_schedule[].minute long Minute: 0-59
policy.auto_stage boolean Automatically stage the latest update if available.

Response:

HTTP Status Code: 200

None

Errors:

HTTP Status Code Type Description
500 error Generic error
401 unauthenticated session is not authenticated
403 unauthorized session is not authorized to perform this operation