Summary
Send a gNOI set package command.
Description
Send a set package command over gRPC gNOI to a host and return the results.
Route
POST /automationgateway/gnoi/set_package/execute
Roles
admin
Parameters
DetailsExampleSchema
Name |
Type |
Required |
Description |
contents |
string |
no |
Byte-string/uploaded content |
hash |
object |
no |
- |
host |
string |
yes |
A host from the gRPC inventory |
package |
object |
yes |
- |
Copied to Clipboard
{
"host": "xr9kv-atl",
"package": {
"activate": false,
"filename": "exercitation dolor Excepteur",
"version": "incididunt",
"remote_download": {
"path": "sint",
"protocol": "mollit cillum enim dolore",
"credentials": {
"cleartext": "ex adipisicing occaecat",
"username": "adipisicing ut",
"hashed": {
"hash": "dolore do commodo",
"method": "labore ad occaecat"
}
}
}
},
"contents": "in elit pariatur",
"hash": "elit eiusmod veniam"
}
Copied to Clipboard
{
"type": "object",
"properties": {
"contents": {
"title": "contents",
"type": "string"
},
"hash": {
"title": "hash",
"type": "string"
},
"host": {
"title": "host",
"type": "string",
"$ref": "deviceData#/definitions/deviceName"
},
"package": {
"title": "package",
"type": "object",
"properties": {
"activate": {
"title": "activate",
"type": "boolean"
},
"filename": {
"title": "filename",
"type": "string"
},
"version": {
"title": "version",
"type": "string"
},
"remote_download": {
"title": "remote_download",
"type": "object",
"properties": {
"path": {
"title": "path",
"type": "string"
},
"protocol": {
"title": "protocol",
"type": "string"
},
"credentials": {
"title": "credentials",
"type": "object",
"properties": {
"cleartext": {
"title": "cleartext",
"type": "string"
},
"username": {
"title": "username",
"type": "string"
},
"hashed": {
"title": "hashed",
"type": "object",
"properties": {
"hash": {
"title": "hash",
"type": "string"
},
"method": {
"title": "method",
"type": "string"
}
}
}
}
}
}
}
}
}
},
"required": [
"host",
"package"
],
"additionalProperties": false
}
Return
DetailsExampleSchema
Name |
Type |
Description |
result |
object |
gNOI response object. |
Copied to Clipboard
{
"key": "status",
"status": "200"
}