puppet.disable
Disables Puppet on the node. You are required to include a reason for disabling Puppet. The reason and the user who ran the command are reported by puppet.status, and the reason is shown when a run is attempted while Puppet is disabled.
JSON-RPC Request
{"jsonrpc":"2.0","id":1,"method":"puppet.disable","params":{"message":"<message>"}}
Request Parameters
| Argument | Type | Description | Required |
|---|---|---|---|
message | String | The reason that Puppet is being disabled. | Yes |
JSON-RPC Response
{
"jsonrpc": "2.0",
"id": 1,
"result": "<result_message>"
}
RVC CLI Example
rvc puppet disable --message 'Disabling Puppet to ensure no further changes are made.'
Response
Puppet disabled!
If --message is omitted, the CLI rejects the command before any request is sent and exits with code 1:
Missing required argument: message