Replace an OnGuard Custom Script

put

https://clearpass-hostname/api/onguard-custom-script/{onguard_custom_script_id}

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

onguard_custom_script_id

string

required

Numeric ID of OnGuard Custom Script

Body Params

name

string

required

Name of Custom Script

description

string

Description of Custom Script

os_type

string

enum

required

OS Type of Custom Script

Allowed:

script_type

string

enum

required

Type of Custom Script

Allowed:

attributes

object

required

Attributes of Custom Script, allowed attributes - Path,Command,SHA256,ExecutionLevel,WaitTime,PassResults,SuccessMsg,FailureMsg,ProgressMsg,Description,DownloadURL,ValidateURLCert,ScriptExecutionTimeOut,SignerName (e.g. {"Path": "/home/aruba/scripts","SHA256": "cfd6...f7ca","ExecutionLevel": "User","Command": "runscript.sh","SignerName": "signer"})

output_format

string

enum

Output Format of Custom Script, applicable only for health collection scripts

Allowed:

output_details

object

Output Details of Custom Script, applicable only for health collection scripts (e.g. {"ExitCode":"Integer", "OutVar1":"Boolean", "OutVar2":"String"})

rule_eval_algo

string

enum

Rule Evaluation Algorithm for rules of Custom Script, applicable only for health collection scripts

Allowed:

rules

object

List of Rules for Custom Script, applicable only for health collection scripts (e.g. [{"match_type":"OR","health_status":"Healthy","condition":[{"type":"Script","name":"ExitCode","oper":"EQUALS","value":"0"}]}])

Responses

Language

Loading…

Response

Choose an example:

application/json

200OK

204No Content

304Not Modified

401Unauthorized

403Forbidden

404Not Found

406Not Acceptable

415Unsupported Media Type

422Unprocessable Entity