Summary
IAG Native Netmiko send_command
Description
Transactional Netmiko send_command wrapper which accepts all function parameters
Route
POST /automationgateway/netmikoSendCommandExec
Roles
admin
Parameters
DetailsExampleSchema
| Name | Type | Required | Description |
|---|---|---|---|
| host | string | yes | netmiko device name |
| commandString | string | yes | The command to be executed on the remote device |
| expectString | string | no | Regular expression pattern to use for determining end of output. If left blank will default to being based on router prompt. |
| delayFactor | number | no | Multiplying factor used to adjust delays (default to 1). |
| maxLoops | number | no | Controls wait time in conjunction with delay_factor. Will default to be based upon the timeout in netmiko device |
| stripPrompt | boolean | no | Remove the trailing router prompt from the output (default to True). |
| stripCommand | boolean | no | Remove the echo of the command from the output (default to True). |
| normalize | boolean | no | Ensure the proper enter is sent at end of command (default to True). |
| useTextfsm | boolean | no | Process command output through TextFSM template (default to False). |
| textfsmTemplate | string | no | Name of template to parse output with; can be fully qualified path, relative path, or name of file in current directory. (default to None). |
| useTtp | boolean | no | Process command output through TTP template (default to False). |
| ttpTemplate | string | no | Name of template to parse output with; can be fully qualified path, relative path, or name of file in current directory. (default to None). |
| useGenie | boolean | no | Process command output through PyATS/Genie parser (default to False). |
| cmdVerify | boolean | no | Verify command echo before proceeding (default to True). |
Return
DetailsExampleSchema
| Name | Type | Description |
|---|---|---|
| result | object | A JSON Object containing status, code and the result |