diff --git a/Packs/Netmiko/Integrations/Netmiko/Netmiko.yml b/Packs/Netmiko/Integrations/Netmiko/Netmiko.yml index 1d9ad919824a..dc0c0537e3a4 100644 --- a/Packs/Netmiko/Integrations/Netmiko/Netmiko.yml +++ b/Packs/Netmiko/Integrations/Netmiko/Netmiko.yml @@ -3,18 +3,18 @@ commonfields: id: Netmiko version: -1 configuration: - - name: port - display: Port - required: true - defaultvalue: null - type: 0 - additionalinfo: "" - name: hostname display: Hostname required: true defaultvalue: null type: 0 additionalinfo: null + - name: port + display: Port + required: true + defaultvalue: null + type: 0 + additionalinfo: "" - name: platform display: Platform required: true @@ -203,8 +203,6 @@ script: required: true isArray: true defaultValue: "" - predefined: - - "" - auto: PREDEFINED defaultValue: "false" description: Whether requires "enable" to be run before commands are executed. Default diff --git a/Packs/Netmiko/Integrations/Netmiko/README.md b/Packs/Netmiko/Integrations/Netmiko/README.md index a5ba2d2daeda..1eabb076d85d 100644 --- a/Packs/Netmiko/Integrations/Netmiko/README.md +++ b/Packs/Netmiko/Integrations/Netmiko/README.md @@ -18,7 +18,7 @@ This integration provides ssh-based access to network devices, servers, and othe - *Credentials*: The username/password, or XSOAR credential object, to be used for the connection. **NOTE**: Platform names are taken from the supported [SSH](https://github.com/ktbyers/netmiko/blob/develop/PLATFORMS.md#supported-ssh-device_type-values) or [Telnet](https://github.com/ktbyers/netmiko/blob/develop/PLATFORMS.md#supported-telnet-device_type-values) device type lists on GitHub. -4. Click **Test** to validate the new instance. This performs a simple connection to the system hosting the SSH server. + 4. Click **Test** to validate the new instance. This performs a simple connection to the system hosting the SSH server. ## Commands @@ -27,12 +27,15 @@ This integration provides ssh-based access to network devices, servers, and othe 1. [Executes a command, or series of commands, over an SSH connection: netmiko-cmds](#netmiko-cmds) ## netmiko-cmds + Executes a command, or series of commands, over an SSH connection. Outputs from the executed commands are returned to the incident/playground context. #### Base Command + `netmiko-cmds` #### Input + ------------------ | **Argument Name** | **Description** | **Required** | |--|--|--| @@ -50,6 +53,7 @@ Executes a command, or series of commands, over an SSH connection. Outputs from |require_exit|Specifies an optional command that must be executed upon completion of the cmds parameter being executed. Default: False.|Optional| #### Context Output + |**Path**|**Type**|**Description**| |--|--|--| |Netmiko.Command|String|The executed command(s).| @@ -58,51 +62,59 @@ Executes a command, or series of commands, over an SSH connection. Outputs from |Netmiko.Output|String|The results of the command(s) that were executed.| #### Command Example (Single command) + `!netmiko-cmds cmds="whoami"` + #### Context Example ->{
-> "Command": "whoami",
-> "DateTimeUTC": "2023-04-24T21:40:21.755985",
-> "Hostname": "192.168.0.1",
-> "Output": "[someuser@someserver ~]$ root"
->}
+>{ +> "Command": "whoami", +> "DateTimeUTC": "2023-04-24T21:40:21.755985", +> "Hostname": "192.168.0.1", +> "Output": "[someuser@someserver ~]$ root" +>} #### Human Readable Output + #### Command(s) against 192.168.0.1 (linux) + |**Command**|**DateTimeUTC**|**Hostname**|**Output**| |--|--|--|--| |whoami|2023-04-24T21:40:21.755985|192.168.0.1|root| ### Command Example (Multiple commands) + #### As multiple commands via CLI or task -`!netmiko-cmds cmds="whoami` -`who"` +`!netmiko-cmds cmds="whoami` +`who"` #### As multiple commands via CLI or task using an array -`array context key = ["whoami", "who"]` -`!netmiko-cmds cmds=${array}` + +`array context key = ["whoami", "who"]` +`!netmiko-cmds cmds=${array}` #### Context Example ->{
-> "Netmiko": [{
->  "Command": "whoami",
->  "DateTimeUTC": "2023-04-24T21:59:02.177240",
->  "Hostname": "192.168.0.1",
->  "Output": "[someuser@somehost ~]$ root"
-> },
-> {
->  "Command": "who",
->  "DateTimeUTC": "2023-04-24T21:59:04.882842",
->  "Hostname": "192.168.0.1",
->  "Output": "[someuser@somehost ~]$ root pts/0 2023-04-24 17:58 (192.168.0.1)"
-> }]
->}
+>{ +> "Netmiko": [{ +>  "Command": "whoami", +>  "DateTimeUTC": "2023-04-24T21:59:02.177240", +>  "Hostname": "192.168.0.1", +>  "Output": "[someuser@somehost ~]$ root" +> }, +> { +>  "Command": "who", +>  "DateTimeUTC": "2023-04-24T21:59:04.882842", +>  "Hostname": "192.168.0.1", +>  "Output": "[someuser@somehost ~]$ root pts/0 2023-04-24 17:58 (192.168.0.1)" +> }] +>} #### Human Readable Output + #### Command(s) against 192.168.0.1 (linux) + |**Command**|**DateTimeUTC**|**Hostname**|**Output**| |--|--|--|--| |whoami|2023-04-24T21:59:02.177240|192.168.0.1|root| diff --git a/Packs/Netmiko/ReleaseNotes/1_0_3.md b/Packs/Netmiko/ReleaseNotes/1_0_3.md new file mode 100644 index 000000000000..ed75a50e73a6 --- /dev/null +++ b/Packs/Netmiko/ReleaseNotes/1_0_3.md @@ -0,0 +1,7 @@ + +#### Integrations + +##### Netmiko + +- Documentation and metadata improvements. +- Fixed an issue in the ***netmiko-cmds*** command where the *cmds* command argument could not accept free text values. diff --git a/Packs/Netmiko/pack_metadata.json b/Packs/Netmiko/pack_metadata.json index 51fe0c2dc296..beb9ed376b6c 100644 --- a/Packs/Netmiko/pack_metadata.json +++ b/Packs/Netmiko/pack_metadata.json @@ -2,7 +2,7 @@ "name": "Netmiko", "description": "The Netmiko pack uses the Netmiko/Paramiko libraries to execute commands via SSH on platforms supported by these python modules.", "support": "xsoar", - "currentVersion": "1.0.2", + "currentVersion": "1.0.3", "author": "Josh Levine", "url": "", "email": "",