Skip to content

Commit

Permalink
Doc update
Browse files Browse the repository at this point in the history
  • Loading branch information
Bhavneet-Sharma committed Jan 25, 2024
1 parent d08ccd2 commit 81b6763
Show file tree
Hide file tree
Showing 12 changed files with 22 additions and 19 deletions.
2 changes: 1 addition & 1 deletion docs/modules/file_dns.rst
Original file line number Diff line number Diff line change
Expand Up @@ -112,7 +112,7 @@ Notes

.. note::
- The *check_mode* is supported.
- The details of a file DNS can be fetched using *file_dns_id* or *nas_server*
- The details of a file DNS can be fetched using *file_dns_id* or *nas_server*.
- The modules present in this collection named as 'dellemc.powerstore' are built to support the Dell PowerStore storage platform.


Expand Down
4 changes: 2 additions & 2 deletions docs/modules/file_interface.rst
Original file line number Diff line number Diff line change
Expand Up @@ -65,7 +65,7 @@ Parameters

``Backup`` type of network interface is used only for NDMP/NFS backup or disaster recovery testing. This type of interface is always active in all NAS server modes.

``System`` type of interface are reserved for system traffic such as for NAS server migration, they can't be used for the production traffic.
``System`` type of interface are reserved for system traffic such as for NAS server migration, they can not be used for the production traffic.

``System`` type is not supported during create interface.

Expand Down Expand Up @@ -128,7 +128,7 @@ Notes

.. note::
- The *check_mode* is supported.
- The details of a file interface can be fetched using *file_interface_id* or *nas_server* and *ip_address*
- The details of a file interface can be fetched using *file_interface_id* or *nas_server* and *ip_address*.
- The modules present in this collection named as 'dellemc.powerstore' are built to support the Dell PowerStore storage platform.


Expand Down
2 changes: 1 addition & 1 deletion docs/modules/file_nis.rst
Original file line number Diff line number Diff line change
Expand Up @@ -104,7 +104,7 @@ Notes

.. note::
- The *check_mode* is supported.
- The details of a file NIS can be fetched using *file_nis_id* or *nas_server*
- The details of a file NIS can be fetched using *file_nis_id* or *nas_server*.
- The modules present in this collection named as 'dellemc.powerstore' are built to support the Dell PowerStore storage platform.


Expand Down
6 changes: 4 additions & 2 deletions docs/modules/info.rst
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,9 @@ Replication module includes replication rules, replication sessions, replication

Virtualization module includes vCenters and virtual volumes.

Configuration module includes cluster nodes, networks, roles, local users, appliances, discovered appliances, security configs, certificates, AD/LDAP servers, LDAP accounts, LDAP domain, and service configs.
Configuration module includes cluster nodes, networks, roles, local users, appliances, discovered appliances, security configs, certificates.

Configureation modules also includes AD/LDAP servers, LDAP accounts, LDAP domain, and service configs.

It also includes DNS/NTP servers, smtp configs, email destinations, remote support, and remote support contacts.

Expand Down Expand Up @@ -473,7 +475,7 @@ Examples
- file_dns
- file_nis

- name: Get list of service configs.
- name: Get list of service configs
dellemc.powerstore.info:
array_ip: "{{array_ip}}"
validate_certs: "{{validate_certs}}"
Expand Down
4 changes: 2 additions & 2 deletions docs/modules/nfs_server.rst
Original file line number Diff line number Diff line change
Expand Up @@ -120,8 +120,8 @@ Notes

.. note::
- The *check_mode* is supported.
- The details of an NFS server can be fetched using *nfs_server_id* or *nas_server*
- To set *is_use_smb_config_enabled* as ``true``, *is_secure_enabled* should be set to ``true``
- The details of an NFS server can be fetched using *nfs_server_id* or *nas_server*.
- To set *is_use_smb_config_enabled* as ``true``, *is_secure_enabled* should be set to ``true``.
- The modules present in this collection named as 'dellemc.powerstore' are built to support the Dell PowerStore storage platform.


Expand Down
2 changes: 1 addition & 1 deletion docs/modules/smb_server.rst
Original file line number Diff line number Diff line change
Expand Up @@ -118,7 +118,7 @@ Notes

.. note::
- The *check_mode* is supported.
- The details of an SMB server can be fetched using *smb_server_id* or *nas_server*
- The details of an SMB server can be fetched using *smb_server_id* or *nas_server*.
- The modules present in this collection named as 'dellemc.powerstore' are built to support the Dell PowerStore storage platform.


Expand Down
2 changes: 1 addition & 1 deletion plugins/modules/file_dns.py
Original file line number Diff line number Diff line change
Expand Up @@ -71,7 +71,7 @@
notes:
- The I(check_mode) is supported.
- The details of a file DNS can be fetched using I(file_dns_id) or
I(nas_server)
I(nas_server).
'''

EXAMPLES = r'''
Expand Down
4 changes: 2 additions & 2 deletions plugins/modules/file_interface.py
Original file line number Diff line number Diff line change
Expand Up @@ -56,7 +56,7 @@
This type of interface is inactive while a NAS server is in destination mode.
- C(Backup) type of network interface is used only for NDMP/NFS backup or disaster recovery testing.
This type of interface is always active in all NAS server modes.
- C(System) type of interface are reserved for system traffic such as for NAS server migration, they can't be used for the production traffic.
- C(System) type of interface are reserved for system traffic such as for NAS server migration, they can not be used for the production traffic.
- C(System) type is not supported during create interface.
choices: ['Production', 'Backup', 'System']
type: str
Expand All @@ -83,7 +83,7 @@
notes:
- The I(check_mode) is supported.
- The details of a file interface can be fetched using I(file_interface_id) or
I(nas_server) and I(ip_address)
I(nas_server) and I(ip_address).
'''

EXAMPLES = r'''
Expand Down
2 changes: 1 addition & 1 deletion plugins/modules/file_nis.py
Original file line number Diff line number Diff line change
Expand Up @@ -63,7 +63,7 @@
notes:
- The I(check_mode) is supported.
- The details of a file NIS can be fetched using I(file_nis_id) or
I(nas_server)
I(nas_server).
'''

EXAMPLES = r'''
Expand Down
7 changes: 4 additions & 3 deletions plugins/modules/info.py
Original file line number Diff line number Diff line change
Expand Up @@ -24,8 +24,9 @@
replication groups, and remote system.
- Virtualization module includes vCenters and virtual volumes.
- Configuration module includes cluster nodes, networks, roles, local users,
appliances, discovered appliances, security configs, certificates,
AD/LDAP servers, LDAP accounts, LDAP domain, and service configs.
appliances, discovered appliances, security configs, certificates.
- Configureation modules also includes AD/LDAP servers, LDAP accounts,
LDAP domain, and service configs.
- It also includes DNS/NTP servers, smtp configs, email destinations,
remote support, and remote support contacts.
author:
Expand Down Expand Up @@ -399,7 +400,7 @@
- file_dns
- file_nis
- name: Get list of service configs.
- name: Get list of service configs
dellemc.powerstore.info:
array_ip: "{{array_ip}}"
validate_certs: "{{validate_certs}}"
Expand Down
4 changes: 2 additions & 2 deletions plugins/modules/nfs_server.py
Original file line number Diff line number Diff line change
Expand Up @@ -77,9 +77,9 @@
notes:
- The I(check_mode) is supported.
- The details of an NFS server can be fetched using I(nfs_server_id) or
I(nas_server)
I(nas_server).
- To set I(is_use_smb_config_enabled) as C(true), I(is_secure_enabled) should be
set to C(true)
set to C(true).
'''

EXAMPLES = r'''
Expand Down
2 changes: 1 addition & 1 deletion plugins/modules/smb_server.py
Original file line number Diff line number Diff line change
Expand Up @@ -73,7 +73,7 @@
notes:
- The I(check_mode) is supported.
- The details of an SMB server can be fetched using I(smb_server_id) or
I(nas_server)
I(nas_server).
'''

EXAMPLES = r'''
Expand Down

0 comments on commit 81b6763

Please sign in to comment.