Contentless Linux Patch Deployment Configuration

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

Base URL

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

Supported Requests

Method	URL	Input	Return
DELETE	https://<consoleFQDN:port>/st/console/api/v1.0/linux/contentlesspatchdeploymentconfigurations /{patch deploy configuration Id}		Success code
GET	https://<consoleFQDN:port>/st/console/api/v1.0/linux/ contentlesspatchdeploymentconfigurations	URL Parameters	LinuxPatchDeployment Configuration
	https://<consoleFQDN:port>/st/console/api/v1.0/linux/ contentlesspatchdeploymentconfigurations /{patch deploy configuration Id}		LinuxPatchDeployment Configuration
	https://<consoleFQDN:port>/st/console/api/v1.0/linux/ contentlesspatchdeploymentconfigurations /{patch deploy configuration Id}/usedby		LinuxPatchDeploy UsedBy
POST	https://<consoleFQDN:port>/st/console/api/v1.0/linux/ contentlesspatchdeploymentconfigurations	Request Body	LinuxPatchDeployment Configuration
PUT	https://<consoleFQDN:port>/st/console/api/v1.0/linux/ contentlesspatchdeploymentconfigurations /{patch deploy configuration Id}	Request Body	Success code

Input Models

URL Parameters

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

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.

Request Body

Name	Required?	Type	Default Value	Description
description	No	String	None	Provides a description that explains the purpose of this deployment configuration.
deploymentFilterType	No	Enum	None	Deploy all found patches or deploy only specified patch groups
patchGroupIds	No	Int32[]	None	The patch groups to deploy when DeploymentFilterType is set to ByGroup
shouldDeployOnlyExplicitVersion	No	Boolean	None	Specifies if only the exact version of a patch should get deployed rather than the newest patch found
shouldPostDeployReboot	No	Boolean	None	Specifies if a post-deploy reboot should occur when needed by the deployed patches.
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 contentless Linux Patch Deployment Configurations list in the navigation pane.

Example with Sample Response

Create a contentless Linux patch deployment configuration

POST Request

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

{ "name": "Sample contentless 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/
                contentlesspatchdeploymentconfigurations/41bc2c50-441f-4647-9d85-7058a5251b19"
                },
                "usedby": {
                "href": "https://device-name.example.com:3121/st/console/api/v1.0/linux/
                contentlesspatchdeploymentconfigurations/41bc2c50-441f-4647-9d85-7058a5251b19/usedby"
                }
                },
                "name": "Sample contentless Linux Patch Deploy Config",


                "deploymentFilterType": "ALL",

                "shouldPostDeployReboot": false
            }

Other Request Examples

Update the name of a contentless Linux patch deployment configuration with ID 01234567-89AB-CDEF-0123-456789ABCDEF

PUT Request

Copy

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

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

Output Models

LinuxPatchDeploymentConfiguration

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.
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.
path	String	The path that describes the location of the configuration within the contentless Linux Patch Deployment Configurations list in the navigation pane.

LinuxPatchDeployUsedby

Name	Type	Description
name	String	Specifies the name of the agent policy that uses the contentless Linux patch deployment configuration.
usageType	Enum	The component type that uses the contentless Linux patch deployment configuration.

Contentless Linux Patch Deployment Configuration

Base URL

Supported Requests

Input Models

Example with Sample Response

Create a contentless Linux patch deployment configuration

POST Request

Sample Response

Other Request Examples

DELETE Request

GET Request

GET Request

GET Request

GET Request

GET Request

PUT Request

Output Models