Skip to content

Commit f19126b

Browse files
authored
Updating documentation for SSH Connection Plugin.
Updating documentation for SSH Connection Plugin.
2 parents a70d937 + 64562df commit f19126b

2 files changed

Lines changed: 12 additions & 6 deletions

File tree

README.md

Lines changed: 10 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -135,12 +135,13 @@ Refer to the [sample_playboook](https://github.com/netscaler/ansible-collection-
135135
### SSH Connection Plugin
136136
137137
The collection provides an SSH connection plugin (`netscaler.adc.ssh_netscaler_adc`) that enables direct SSH connectivity to NetScaler ADC devices for executing shell commands and CLI operations.
138+
The collection supports both SSH key-based authentication and SSH password based authentication.
138139

139140
#### Prerequisites
140141

141-
- SSH key-based authentication must be configured
142-
- SSH access to the NetScaler ADC device
143-
- Private SSH key file available on the control machine
142+
- SSH access to the NetScaler ADC device.
143+
- Private SSH key file available on the control machine (required when using SSH key-based authentication). Refer [Configure SSH key-based authentication](https://docs.netscaler.com/en-us/citrix-adc/current-release/system/authentication-and-authorization-for-system-user/ssh-key-based-authentication-for-system-users.html#configure-ssh-key-based-authentication-for-the-netscaler-local-system-users-by-using-cli)
144+
- SSH username and password (required when using SSH password based authentication).
144145

145146
#### Inventory Configuration
146147

@@ -167,7 +168,7 @@ netscaler_adc ansible_host=10.10.10.10 ansible_user=nsroot ansible_ssh_private_k
167168
**Required inventory parameters:**
168169
- `ansible_host` - IP address or hostname of NetScaler ADC
169170
- `ansible_user` - SSH username (typically `nsroot`)
170-
- `ansible_ssh_private_key_file` - Path to SSH private key
171+
- `ansible_ssh_private_key_file` - Path to SSH private key (required when using SSH key-based authentication)
171172
- `nitro_pass` - Password for nscli commands (required when using CLI commands)
172173

173174
#### Playbook Structure for Shell Commands
@@ -240,6 +241,11 @@ To execute NetScaler CLI commands using nscli:
240241
ansible-playbook playbook.yaml -i inventory.ini
241242
```
242243

244+
Use --ask-pass to key in SSH password on demand in case of SSH password based authentication.
245+
```bash
246+
ansible-playbook playbook.yaml -i inventory.ini --ask-pass
247+
```
248+
243249
Add `-vvvv` for verbose debugging output if needed:
244250
```bash
245251
ansible-playbook playbook.yaml -i inventory.ini -vvvv

tools/migrationtool/utils.py

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -22,15 +22,15 @@
2222
"citrix_adc_cs_policy": "netscaler.adc.cspolicy",
2323
"citrix_adc_cs_vserver": "netscaler.adc.csvserver",
2424
"citrix_adc_dnsnsrec": "netscaler.adc.dnsnsrec",
25-
"citrix_adc_get_bearer_token": "netscaler.adc.get_bearer_token",
25+
"citrix_adc_get_bearer_token": "netscaler.adc.get_bearer_token", # nosec
2626
"citrix_adc_gslb_service": "netscaler.adc.gslbservice",
2727
"citrix_adc_gslb_site": "netscaler.adc.gslbsite",
2828
"citrix_adc_gslb_vserver": "netscaler.adc.gslbvserver",
2929
"citrix_adc_lb_monitor": "netscaler.adc.lbmonitor",
3030
"citrix_adc_lb_vserver": "netscaler.adc.lbvserver",
3131
"citrix_adc_nsip": "netscaler.adc.nsip",
3232
"citrix_adc_nspartition": "netscaler.adc.nspartition",
33-
"citrix_adc_password_reset": "netscaler.adc.password_reset",
33+
"citrix_adc_password_reset": "netscaler.adc.password_reset", # nosec
3434
"citrix_adc_save_config": "netscaler.adc.save_config",
3535
"citrix_adc_server": "netscaler.adc.server",
3636
"citrix_adc_servicegroup": "netscaler.adc.servicegroup",

0 commit comments

Comments
 (0)