Linux Patch Deployment Configuration

A Linux patch deployment configuration defines how a patch deployment will be performed.

Base URL

        https://<consoleFQDN:port>/st/console/api/v1.0/linux/patch/deploymentconfigurations

Supported Requests

Method URL Input Return

DELETE

https://<consoleFQDN:port>/st/console/api/v1.0/linux/patch/deploymentconfigurations/{patch deploy configuration Id}

 

Success code

GET

https://<consoleFQDN:port>/st/console/api/v1.0/linux/patch/deploymentconfigurations

URL Parameters

LinuxPatchDeployment
Configuration

https://<consoleFQDN:port>/st/console/api/v1.0/linux/patch/deploymentconfigurations/{patch deploy configuration Id}

 

LinuxPatchDeployment
Configuration

https://<consoleFQDN:port>/st/console/api/v1.0/linux/patch/deploymentconfigurations/{patch deploy configuration Id}/usedby

 

LinuxPatchDeploy
UsedBy

POST

https://<consoleFQDN:port>/st/console/api/v1.0/linux/patch/deploymentconfigurations

Request Body

LinuxPatchDeployment
Configuration

PUT

https://<consoleFQDN:port>/st/console/api/v1.0/linux/patch/deploymentconfigurations/{patch deploy configuration Id}

Request Body

Success code

Input Models

Name Type Description

createdByMe

Boolean

Returns only those items created by the user.

This parameter will be removed in a future release and should only be used in legacy requests.

name

String

Returns the items whose name matches the specified name.
Name Required? Type Default Value Description

description

No

String

None

Provides a description that explains the purpose of this deployment configuration.

options

Only for a PUT

LinuxPatch
DeploymentOptions

None

Specifies the options to use during the deployment.

name

Yes

String

None

Specifies the patch deployment configuration name.

path

No

String

None

The path that describes the location of the configuration within the Linux Patch Deployment Configurations list in the navigation pane.

Example with Sample Response

Create a Linux patch deployment configuration

POST Request

https://<consoleFQDN:port>/st/console/api/v1.0/linux/patch/deploymentconfigurations

{ "name": "Sample Linux Patch Deploy Config", "description": "Sample for demonstration purposes"}

Sample Response

Copy 
{
    "createdBy": "example\\joe.admin",
    "description": "Sample for demonstration purposes",
    "id": "41bc2c50-441f-4647-9d85-7058a5251b19",
    "isSystem": false,
    "links": {
        "self": {
            "href": "https://device-name.example.com:3121/st/console/api/v1.0/linux/patch/deploymentconfigurations/41bc2c50-441f-4647-9d85-7058a5251b19"
        },
        "usedby": {
            "href": "https://device-name.example.com:3121/st/console/api/v1.0/linux/patch/deploymentconfigurations/41bc2c50-441f-4647-9d85-7058a5251b19/usedby"
        }
    },
    "name": "Sample Linux Patch Deploy Config"
    "options": {
        "deploymentFilterType": "ALL",
        "shouldPostDeployReboot": false
    }
}

Other Request Examples

DELETE Request

https://<consoleFQDN:port>/st/console/api/v1.0/linux/patch/deploymentconfigurations/01234567-89AB-CDEF-0123-456789ABCDEF

GET Request

https://<consoleFQDN:port>/st/console/api/v1.0/linux/patch/deploymentconfigurations

GET Request

https://<consoleFQDN:port>/st/console/api/v1.0/linux/patch/deploymentconfigurations/01234567-89AB-CDEF-0123-456789ABCDEF

GET Request

https://<consoleFQDN:port>/st/console/api/v1.0/linux/patch/deploymentconfigurations/01234567-89AB-CDEF-0123-456789ABCDEF/usedby

GET Request

https://<consoleFQDN:port>/st/console/api/v1.0/linux/patch/deploymentconfigurations?name=Config-Test

PUT Request

Copy 
https://<consoleFQDN:port>/st/console/api/v1.0/linux/patch/deploymentconfigurations/0BA381B1-1D64-468A-9E64-80D39284D939

{
    "name": "New Name",
    "options": {
        "deploymentFilterType": "All",
        "shouldDeployOnlyExplicitVersion": false,
        "shouldPostDeployReboot": true
    }
)


Output Models

Name Type Description

createdBy

String

The name of the user who created the deployment configuration.

description

String

Provides a description that explains the purpose of this deployment configuration.

id

Guid

Unique identifier for the deployment configuration.

isSystem

Boolean

Indicates if this configuration is provided by the system.

links

Links

Links for the deployment configuration.

name

String

Specifies the patch deployment configuration name.

options

LinuxPatch
DeploymentOptions

Specifies the deployment options.

path

String

The path that describes the location of the configuration within the Linux Patch Deployment Configurations list in the navigation pane.
Name Type Description

deploymentFilterType

Enum

Deploy all found patches or deploy only specified patch groups

patchGroupIds

Int32[]

The patch groups to deploy when DeploymentFilterType is set to ByGroup

shouldDeployOnlyExplicitVersion

Boolean

Specifies if only the exact version of a patch should get deployed rather than the newest patch found.

shouldPostDeployReboot

Boolean

Specifies if a post-deploy reboot should occur when needed by the deployed patches.
Name Type Description

name

String

Specifies the name of the agent policy that uses the Linux patch deployment configuration.

usageType

Enum

The component type that uses the Linux patch deployment configuration.