ACI: Move to 'host' parameter instead of 'hostname' (#35161)

* ACI: Move to 'host' parameter instead of 'hostname' * Update host parameter in documentation fragment too
ansible · Jan 22, 2018 · d600485 · d600485
1 parent cf1f7b5
commit d600485
Show file tree

Hide file tree

Showing 56 changed files with 197 additions and 198 deletions.
diff --git a/lib/ansible/module_utils/network/aci/aci.py b/lib/ansible/module_utils/network/aci/aci.py
@@ -63,7 +63,7 @@
 
 def aci_argument_spec():
     return dict(
-        hostname=dict(type='str', required=True, aliases=['host']),
+        host=dict(type='str', required=True, aliases=['hostname']),
         port=dict(type='int', required=False),
         username=dict(type='str', default='admin', aliases=['user']),
         password=dict(type='str', no_log=True),
@@ -216,9 +216,9 @@ def login(self):
 
         # Perform login request
         if 'port' in self.params and self.params['port'] is not None:
-            url = '%(protocol)s://%(hostname)s:%(port)s/api/aaaLogin.json' % self.params
+            url = '%(protocol)s://%(host)s:%(port)s/api/aaaLogin.json' % self.params
         else:
-            url = '%(protocol)s://%(hostname)s/api/aaaLogin.json' % self.params
+            url = '%(protocol)s://%(host)s/api/aaaLogin.json' % self.params
         payload = {'aaaUser': {'attributes': {'name': self.params['username'], 'pwd': self.params['password']}}}
         resp, auth = fetch_url(self.module, url,
                                data=json.dumps(payload),
@@ -281,9 +281,9 @@ def request(self, path, payload=None):
         self.result['path'] = path
 
         if 'port' in self.params and self.params['port'] is not None:
-            self.result['url'] = '%(protocol)s://%(hostname)s:%(port)s/' % self.params + path.lstrip('/')
+            self.result['url'] = '%(protocol)s://%(host)s:%(port)s/' % self.params + path.lstrip('/')
         else:
-            self.result['url'] = '%(protocol)s://%(hostname)s/' % self.params + path.lstrip('/')
+            self.result['url'] = '%(protocol)s://%(host)s/' % self.params + path.lstrip('/')
 
         # Sign and encode request as to APIC's wishes
         if self.params['private_key'] is not None:
@@ -319,9 +319,9 @@ def query(self, path):
         self.result['path'] = path
 
         if 'port' in self.params and self.params['port'] is not None:
-            self.result['url'] = '%(protocol)s://%(hostname)s:%(port)s/' % self.params + path.lstrip('/')
+            self.result['url'] = '%(protocol)s://%(host)s:%(port)s/' % self.params + path.lstrip('/')
         else:
-            self.result['url'] = '%(protocol)s://%(hostname)s/' % self.params + path.lstrip('/')
+            self.result['url'] = '%(protocol)s://%(host)s/' % self.params + path.lstrip('/')
 
         # Sign and encode request as to APIC's wishes
         if self.params['private_key'] is not None:
@@ -395,9 +395,9 @@ def construct_url(self, root_class, subclass_1=None, subclass_2=None, subclass_3
 
         self.result['path'] = path
         if 'port' in self.params and self.params['port'] is not None:
-            self.result['url'] = '{0}://{1}:{2}/{3}'.format(self.module.params['protocol'], self.module.params['hostname'], self.module.params['port'], path)
+            self.result['url'] = '{0}://{1}:{2}/{3}'.format(self.module.params['protocol'], self.module.params['host'], self.module.params['port'], path)
         else:
-            self.result['url'] = '{0}://{1}/{2}'.format(self.module.params['protocol'], self.module.params['hostname'], path)
+            self.result['url'] = '{0}://{1}/{2}'.format(self.module.params['protocol'], self.module.params['host'], path)
         self.result['filter_string'] = filter_string
 
     def _construct_url_1(self, obj, child_includes):

diff --git a/lib/ansible/modules/network/aci/aci_aaa_user_certificate.py b/lib/ansible/modules/network/aci/aci_aaa_user_certificate.py
@@ -54,7 +54,7 @@
 EXAMPLES = r'''
 - name: Add a certificate to user
   aci_aaa_user_certificate:
-    hostname: apic
+    host: apic
     username: admin
     password: SomeSecretPassword
     user: admin
@@ -64,7 +64,7 @@
 
 - name: Remove a certificate of a user
   aci_aaa_user_certificate:
-    hostname: apic
+    host: apic
     username: admin
     password: SomeSecretPassword
     user: admin
@@ -73,7 +73,7 @@
 
 - name: Query a certificate of a user
   aci_aaa_user_certificate:
-    hostname: apic
+    host: apic
     username: admin
     password: SomeSecretPassword
     user: admin
@@ -82,7 +82,7 @@
 
 - name: Query all certificates of a user
   aci_aaa_user_certificate:
-    hostname: apic
+    host: apic
     username: admin
     password: SomeSecretPassword
     user: admin

diff --git a/lib/ansible/modules/network/aci/aci_access_port_to_interface_policy_leaf_profile.py b/lib/ansible/modules/network/aci/aci_access_port_to_interface_policy_leaf_profile.py
@@ -73,7 +73,7 @@
 EXAMPLES = r'''
 - name: Associate an Interface Access Port Selector to an Interface Policy Leaf Profile with a Policy Group
   aci_access_port_to_interface_policy_leaf_profile:
-    hostname: apic
+    host: apic
     username: admin
     password: SomeSecretPassword
     leaf_interface_profile: leafintprfname
@@ -86,7 +86,7 @@
 
 - name: Associate an interface access port selector to an Interface Policy Leaf Profile (w/o policy group) (check if this works)
   aci_access_port_to_interface_policy_leaf_profile:
-    hostname: apic
+    host: apic
     username: admin
     password: SomeSecretPassword
     leaf_interface_profile: leafintprfname
@@ -98,7 +98,7 @@
 
 - name: Remove an interface access port selector associated with an Interface Policy Leaf Profile
   aci_access_port_to_interface_policy_leaf_profile:
-    hostname: apic
+    host: apic
     username: admin
     password: SomeSecretPassword
     leaf_interface_profile: leafintprfname
@@ -107,7 +107,7 @@
 
 - name: Query Specific access_port_selector under given leaf_interface_profile
   aci_access_port_to_interface_policy_leaf_profile:
-    hostname: apic
+    host: apic
     username: admin
     password: SomeSecretPassword
     leaf_interface_profile: leafintprfname

diff --git a/lib/ansible/modules/network/aci/aci_aep.py b/lib/ansible/modules/network/aci/aci_aep.py
@@ -55,7 +55,7 @@
 EXAMPLES = r'''
 - name: Add a new AEP
   aci_aep:
-    hostname: apic
+    host: apic
     username: admin
     password: SomeSecretPassword
     aep: ACI-AEP
@@ -64,23 +64,23 @@
 
 - name: Remove an existing AEP
   aci_aep:
-    hostname: apic
+    host: apic
     username: admin
     password: SomeSecretPassword
     aep: ACI-AEP
     state: absent
 
 - name: Query an AEP
   aci_aep:
-    hostname: apic
+    host: apic
     username: admin
     password: SomeSecretPassword
     aep: ACI-AEP
     state: query
 
 - name: Query all AEPs
   aci_aep:
-    hostname: apic
+    host: apic
     username: admin
     password: SomeSecretPassword
     state: query

diff --git a/lib/ansible/modules/network/aci/aci_ap.py b/lib/ansible/modules/network/aci/aci_ap.py
@@ -52,7 +52,7 @@
 EXAMPLES = r'''
 - name: Add a new AP
   aci_ap:
-    hostname: apic
+    host: apic
     username: admin
     password: SomeSecretPassword
     tenant: production
@@ -62,7 +62,7 @@
 
 - name: Remove an AP
   aci_ap:
-    hostname: apic
+    host: apic
     username: admin
     password: SomeSecretPassword
     tenant: production
@@ -71,7 +71,7 @@
 
 - name: Query an AP
   aci_ap:
-    hostname: apic
+    host: apic
     username: admin
     password: SomeSecretPassword
     tenant: production
@@ -80,7 +80,7 @@
 
 - name: Query all APs
   aci_ap:
-    hostname: apic
+    host: apic
     username: admin
     password: SomeSecretPassword
     state: query

diff --git a/lib/ansible/modules/network/aci/aci_bd_subnet.py b/lib/ansible/modules/network/aci/aci_bd_subnet.py
@@ -112,22 +112,22 @@
 EXAMPLES = r'''
 - name: create a tenant
   aci_tenant:
-    hostname: apic
+    host: apic
     username: admin
     password: SomeSecretPassword
     tenant: production
 
 - name: create a bridge domain
   aci_bd:
-    hostname: apic
+    host: apic
     username: admin
     password: SomeSecretPassword
     tenant: production
     bd: database
 
 - name: create a subnet
   aci_bd_subnet:
-    hostname: apic
+    host: apic
     username: admin
     password: SomeSecretPassword
     tenant: production
@@ -137,7 +137,7 @@
 
 - name: create a subnet with options
   aci_bd_subnet:
-    hostname: apic
+    host: apic
     username: admin
     password: SomeSecretPassword
     tenant: production
@@ -152,7 +152,7 @@
 
 - name: update a subnets scope to private and shared
   aci_bd_subnet:
-    hostname: apic
+    host: apic
     username: admin
     password: SomeSecretPassword
     tenant: production
@@ -163,14 +163,14 @@
 
 - name: get all subnets
   aci_bd_subnet:
-    hostname: apic
+    host: apic
     username: admin
     password: SomeSecretPassword
     state: query
 
 - name: get all subnets of specific gateway in specified tenant
   aci_bd_subnet:
-    hostname: apic
+    host: apic
     username: admin
     password: SomeSecretPassword
     state: query
@@ -180,7 +180,7 @@
 
 - name: get specific subnet
   aci_bd_subnet:
-    hostname: apic
+    host: apic
     username: admin
     password: SomeSecretPassword
     state: query
@@ -191,7 +191,7 @@
 
 - name: delete a subnet
   aci_bd_subnet:
-    hostname: apic
+    host: apic
     username: admin
     password: SomeSecretPassword
     state: absent

diff --git a/lib/ansible/modules/network/aci/aci_config_rollback.py b/lib/ansible/modules/network/aci/aci_config_rollback.py
@@ -76,23 +76,23 @@
 ---
 - name: Create a Snapshot
   aci_config_snapshot:
-    hostname: apic
+    host: apic
     username: admin
     password: SomeSecretPassword
     state: present
     export_policy: config_backup
 
 - name: Query Existing Snapshots
   aci_config_snapshot:
-    hostname: apic
+    host: apic
     username: admin
     password: SomeSecretPassword
     state: query
     export_policy: config_backup
 
 - name: Compare Snapshot Files
   aci_config_rollback:
-    hostname: apic
+    host: apic
     username: admin
     password: SomeSecretPassword
     state: preview
@@ -103,7 +103,7 @@
 
 - name: Rollback Configuration
   aci_config_rollback:
-    hostname: apic
+    host: apic
     username: admin
     password: SomeSecretPassword
     state: rollback
@@ -113,7 +113,7 @@
 
 - name: Rollback Configuration
   aci_config_rollback:
-    hostname: apic
+    host: apic
     username: admin
     password: SomeSecretPassword
     state: rollback
@@ -225,7 +225,7 @@ def main():
         aci.post_config()
 
     elif state == 'preview':
-        aci.result['url'] = '%(protocol)s://%(hostname)s/mqapi2/snapshots.diff.xml' % module.params
+        aci.result['url'] = '%(protocol)s://%(host)s/mqapi2/snapshots.diff.xml' % module.params
         aci.result['filter_string'] = (
             '?s1dn=uni/backupst/snapshots-[uni/fabric/configexp-%(export_policy)s]/snapshot-%(snapshot)s&'
             's2dn=uni/backupst/snapshots-[uni/fabric/configexp-%(compare_export_policy)s]/snapshot-%(compare_snapshot)s'

diff --git a/lib/ansible/modules/network/aci/aci_config_snapshot.py b/lib/ansible/modules/network/aci/aci_config_snapshot.py
@@ -69,7 +69,7 @@
 EXAMPLES = r'''
 - name: Create a Snapshot
   aci_config_snapshot:
-    hostname: apic
+    host: apic
     username: admin
     password: SomeSecretPassword
     state: present
@@ -79,22 +79,22 @@
 
 - name: Query all Snapshots
   aci_config_snapshot:
-    hostname: apic
+    host: apic
     username: admin
     password: SomeSecretPassword
     state: query
 
 - name: Query Snapshots associated with a particular Export Policy
   aci_config_snapshot:
-    hostname: apic
+    host: apic
     username: admin
     password: SomeSecretPassword
     state: query
     export_policy: config_backup
 
 - name: Delete a Snapshot
   aci_config_snapshot:
-    hostname: apic
+    host: apic
     username: admin
     password: SomeSecretPassword
     state: absent

diff --git a/lib/ansible/modules/network/aci/aci_contract.py b/lib/ansible/modules/network/aci/aci_contract.py
@@ -69,7 +69,7 @@
 # FIXME: Add more, better examples
 EXAMPLES = r'''
 - aci_contract:
-    hostname: '{{ inventory_hostname }}'
+    host: '{{ inventory_hostname }}'
     username: '{{ username }}'
     password: '{{ password }}'
     contract: '{{ contract }}'