ansible-doc: fix typo (#451)

part of #273 Signed-off-by: Alexis La Goutte <[email protected]>
vmware · Feb 28, 2023 · 09291f3 · 09291f3
1 parent a0d662d
commit 09291f3
Show file tree

Hide file tree

Showing 13 changed files with 50 additions and 45 deletions.
diff --git a/plugins/modules/nsxt_certificates.py b/plugins/modules/nsxt_certificates.py
@@ -45,13 +45,13 @@
         required: true
         type: str
     display_name:
-        description:'Identifier to use when displaying entity in logs or GUI'
+        description: 'Identifier to use when displaying entity in logs or GUI'
         required: true
         type: str
     pem_encoded_file:
         description: 'File containing pem encoded certificate data'
         required: true
-        type='str' 
+        type: str
     private_key_file:
         description: 'File containing private key data'
         required: false

diff --git a/plugins/modules/nsxt_deploy_ova.py b/plugins/modules/nsxt_deploy_ova.py
@@ -42,7 +42,7 @@
         type: str
     ovftool_path:
         description: Path of ovf tool
-        type: 'str',
+        type: 'str'
     folder:
         description:  vCenter folder
         required: false

diff --git a/plugins/modules/nsxt_global_manager_enable_service.py b/plugins/modules/nsxt_global_manager_enable_service.py
@@ -41,7 +41,7 @@
         required: true
         type: str
     display_name:
-        description: "Identifier to use when displaying entity in logs or GUI. Defaults to ID if not set'
+        description: 'Identifier to use when displaying entity in logs or GUI. Defaults to ID if not set'
         required: false
         type: str
     id:

diff --git a/plugins/modules/nsxt_global_manager_registration.py b/plugins/modules/nsxt_global_manager_registration.py
@@ -41,6 +41,7 @@
         required: true
         type: str
     connection_info:
+        description: 'Connection info (fqdn, password...)'
         fqdn:
             description: 'IP address or hostname of global manager(cluster)'
             required: true
@@ -61,7 +62,7 @@
             required: false
             type: str
     display_name:
-        description: "Identifier to use when displaying entity in logs or GUI. Defaults to ID if not set'
+        description: 'Identifier to use when displaying entity in logs or GUI. Defaults to ID if not set'
         required: false
         type: str
     description:

diff --git a/plugins/modules/nsxt_local_manager_registration.py b/plugins/modules/nsxt_local_manager_registration.py
@@ -41,7 +41,7 @@
         required: true
         type: str
     display_name:
-        description: "Identifier to use when displaying entity in logs or GUI. Defaults to ID if not set'
+        description: 'Identifier to use when displaying entity in logs or GUI. Defaults to ID if not set'
         required: false
         type: str
     description:
@@ -66,6 +66,7 @@
         required: false
         type: int                  
     site_connection_info:
+        description: Site connecion info (fqdn, password...)
         fqdn:
             description: 'IP address or hostname of local manager'
             required: true

diff --git a/plugins/modules/nsxt_local_managers_compatibility.py b/plugins/modules/nsxt_local_managers_compatibility.py
@@ -41,6 +41,7 @@
         required: true
         type: str
     site_connection_info:
+        description: 'Site Connection ofno (fqdn, password...'
         fqdn:
             description: 'IP address or hostname of local manager'
             required: true

diff --git a/plugins/modules/nsxt_logical_ports.py b/plugins/modules/nsxt_logical_ports.py
@@ -24,14 +24,14 @@
 ---
 module: nsxt_logical_ports
 short_description: Create a Logical Port
-description: Creates a new logical switch port. The required parameters are the
+description: "Creates a new logical switch port. The required parameters are the
 associated logical_switch_id and admin_state (UP or DOWN). Optional
 parameters are the attachment and switching_profile_ids. If you don't
 specify switching_profile_ids, default switching profiles are assigned to
 the port. If you don't specify an attachment, the switch port remains
 empty. To configure an attachment, you must specify an id, and
 optionally you can specify an attachment_type (VIF or LOGICALROUTER).
-The attachment_type is VIF by default.
+The attachment_type is VIF by default."
 
 version_added: "2.7"
 author: Rahul Raghuvanshi

diff --git a/plugins/modules/nsxt_logical_router_ports.py b/plugins/modules/nsxt_logical_router_ports.py
@@ -24,11 +24,11 @@
 ---
 module: nsxt_logical_router_ports
 short_description: Create a Logical Router Port
-description: Creates a logical router port. The required parameters include resource_type
+description: "Creates a logical router port. The required parameters include resource_type
 (LogicalRouterUpLinkPort, LogicalRouterDownLinkPort, LogicalRouterLinkPort,
 LogicalRouterLoopbackPort, LogicalRouterCentralizedServicePort); and
 logical_router_id (the router to which each logical router port is assigned).
-The service_bindings parameter is optional.
+The service_bindings parameter is optional."
 
 version_added: "2.7"
 author: Rahul Raghuvanshi

diff --git a/plugins/modules/nsxt_transport_node_collections.py b/plugins/modules/nsxt_transport_node_collections.py
@@ -23,11 +23,11 @@
 ---
 module: nsxt_transport_node_collections
 short_description: Create transport node collection by attaching Transport Node Profile to cluster.
-description: When transport node collection is created the hosts which are part
+description: "When transport node collection is created the hosts which are part
 of compute collection will be prepared automatically i.e. NSX Manager
 attempts to install the NSX components on hosts. Transport nodes for these
 hosts are created using the configuration specified in transport node
-profile.
+profile."
 
 version_added: "2.7"
 author: Rahul Raghuvanshi

diff --git a/plugins/modules/nsxt_transport_node_profiles.py b/plugins/modules/nsxt_transport_node_profiles.py
@@ -24,9 +24,9 @@
 ---
 module: nsxt_transport_node_profiles
 short_description: Create a Transport Node Profile
-description: Transport node profile captures the configuration needed to create
+description: "Transport node profile captures the configuration needed to create
 a transport node. A transport node profile can be attached to
-compute collections for automatic TN creation of member hosts.
+compute collections for automatic TN creation of member hosts."
 
 version_added: "2.7"
 author: Rahul Raghuvanshi

diff --git a/plugins/modules/nsxt_transport_nodes.py b/plugins/modules/nsxt_transport_nodes.py
@@ -24,7 +24,7 @@
 ---
 module: nsxt_transport_nodes
 short_description: Create a Transport Node
-description: Transport nodes are hypervisor hosts and NSX Edges that will participate
+description: "Transport nodes are hypervisor hosts and NSX Edges that will participate
               in an NSX-T overlay. For a hypervisor host, this means that it hosts
               VMs that will communicate over NSX-T logical switches. For NSX Edges,
               this means that it will have logical router uplinks and downlinks.
@@ -108,7 +108,7 @@
               request.
 
               If host node (hypervisor) or edge node (router) is not already present in
-              system then information should be provided under node_deployment_info.
+              system then information should be provided under node_deployment_info."
 
 version_added: "2.7"
 author: Rahul Raghuvanshi
@@ -193,7 +193,7 @@
                     required: false
                     type: str
                 audit_username:
-                    description: "The default username is \"audit\". To configure username, you
+                    description: "The default username is 'audit'. To configure username, you
                                   must provide this property together with <b>audit_password</b>."
                     required: false
                     type: str
@@ -473,51 +473,51 @@
         named_teaming_policy:
             description: The named teaming policy to be used by the remote tunnel endpoint
             required: False
-            type:'str'
+            type: 'str'
         rtep_vlan:
             description: VLAN id for remote tunnel endpoint
-            required:True
-            type:'dict'
+            required: True
+            type: 'dict'
             VlanID:
                 description: Virtual Local Area Network Identifier
-                required:False
-                type:'int'
+                required: False
+                type: 'int'
         ip_assignment_spec:
             description: Specification for IPs to be used with host switch remote tunnel endpoints
-            required:True
-            type:'dict'
+            required: True
+            type: 'dict'
             resource_type:
                 description: Resource type
-                required:True
-                type:'str'
+                required: True
+                type: 'str'
             ip_pool_id:
                 description: IP pool id
-                required:False
-                type:'str'
+                required: False
+                type: 'str'
             ip_list:
                 description: List of IPs for transport node host switch virtual tunnel endpoints
-                required:False
-                type:'list'
+                required: False
+                type: 'list'
             ip_mac_list:
                 description: List of IPs and MACs for transport node host switch virtual tunnel endpoints 
-                required:False
-                type:'list'
+                required: False
+                type: 'list'
             default_gateway:
                 description: Default gateway
-                required:False
-                type:'dict'
+                required: False
+                type: 'dict'
                 IPAddress:
                     description: IPv4 or IPv6 address
-                    required:False
-                    type:'str'
+                    required: False
+                    type: 'str'
             subnet_mask:
                 description: Subnet mask
-                required:False
-                type:'dict'
+                required: False
+                type: 'dict'
                 IPAddress:
                     description: IPv4 IPv6 address
-                    required:False
-                    type:'str'
+                    required: False
+                    type: 'str'
     tags: 
         description: Opaque identifiers meaningful to the API user
         required: False

diff --git a/plugins/modules/nsxt_transport_zones.py b/plugins/modules/nsxt_transport_zones.py
@@ -24,9 +24,11 @@
 ---
 module: nsxt_transport_zones
 short_description: Create a Transport Zone
-description: Creates a new transport zone. The required parameters are display_name
-and tz_type (OVERLAY_BACKED or VLAN_BACKED). The optional parameters are
-description and resource_type. 
+description: "Creates a new transport zone. The required parameters are host_switch_name
+and transport_type (OVERLAY or VLAN). The optional parameters are
+description and display_name. This api is now deprecated. Please use new api - 
+PUT /infra/sites/<site-id>/enforcement-points/<enforcementpoint- 
+id>/transport-zones/<zone-id>"
 
 version_added: "2.7"
 author: Rahul Raghuvanshi
@@ -291,4 +293,4 @@ def main():
 
 
 if __name__ == '__main__':
-  main()
+  main()
diff --git a/plugins/modules/nsxt_upgrade_postchecks.py b/plugins/modules/nsxt_upgrade_postchecks.py
@@ -49,7 +49,7 @@
             - host
             - mp
             - edge
-        description: "Component type on which post upgrade is to be run.
+        description: "Component type on which post upgrade is to be run."
         required: true   
 '''