cloudstack: streamline modules doc (part 3) (#53412)

* cloudstack: streamline modules doc (part 3) * Parameter types added * Copyright format fixes * Doc style fixes * Examples format fixes * Remove cs_loadbalancer_rule from ignore.txt * cs_loadbalancer_rule: add "version_added" for params added into the documentation * cs_loadbalancer_rule: ignore E309 for now * cs_loadbalancer_rule: remove E309 from ignore.txt
2026-05-06 13:22:48 +00:00 · 2019-03-12 23:19:07 +01:00
parent b793f08a92
commit 495c197770
9 changed files with 290 additions and 237 deletions
--- a/lib/ansible/modules/cloud/cloudstack/cs_iso.py
+++ b/lib/ansible/modules/cloud/cloudstack/cs_iso.py
@@ -2,21 +2,7 @@
 # -*- coding: utf-8 -*-
 #
 # (c) 2015, René Moser <mail@renemoser.net>
-#
-# This file is part of Ansible
-#
-# Ansible is free software: you can redistribute it and/or modify
-# it under the terms of the GNU General Public License as published by
-# the Free Software Foundation, either version 3 of the License, or
-# (at your option) any later version.
-#
-# Ansible is distributed in the hope that it will be useful,
-# but WITHOUT ANY WARRANTY; without even the implied warranty of
-# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
-# GNU General Public License for more details.
-#
-# You should have received a copy of the GNU General Public License
-# along with Ansible. If not, see <http://www.gnu.org/licenses/>.
+# GNU General Public License v3.0+ (see COPYING or https://www.gnu.org/licenses/gpl-3.0.txt)

 ANSIBLE_METADATA = {'metadata_version': '1.1',
                    'status': ['stableinterface'],
@@ -30,23 +16,27 @@ short_description: Manages ISO images on Apache CloudStack based clouds.
 description:
    - Register and remove ISO images.
 version_added: '2.0'
-author: "René Moser (@resmo)"
+author: René Moser (@resmo)
 options:
  name:
    description:
      - Name of the ISO.
+    type: str
    required: true
  display_text:
    description:
      - Display text of the ISO.
-      - If not specified, C(name) will be used.
-    version_added: "2.4"
+      - If not specified, I(name) will be used.
+    type: str
+    version_added: '2.4'
  url:
    description:
-      - URL where the ISO can be downloaded from. Required if C(state) is present.
+      - URL where the ISO can be downloaded from. Required if I(state) is present.
+    type: str
  os_type:
    description:
-      - Name of the OS that best represents the OS of this ISO. If the iso is bootable this parameter needs to be passed. Required if C(state) is present.
+      - Name of the OS that best represents the OS of this ISO. If the iso is bootable this parameter needs to be passed. Required if I(state) is present.
+    type: str
  is_ready:
    description:
      - This flag is used for searching existing ISOs. If set to C(yes), it will only list ISO ready for deployment e.g.
@@ -55,95 +45,104 @@ options:
    default: no
  is_public:
    description:
-      - Register the ISO to be publicly available to all users. Only used if C(state) is present.
+      - Register the ISO to be publicly available to all users. Only used if I(state) is present.
+    type: bool
  is_featured:
    description:
-      - Register the ISO to be featured. Only used if C(state) is present.
+      - Register the ISO to be featured. Only used if I(state) is present.
    type: bool
  is_dynamically_scalable:
    description:
-      - Register the ISO having XS/VMWare tools installed inorder to support dynamic scaling of VM cpu/memory. Only used if C(state) is present.
+      - Register the ISO having XS/VMWare tools installed inorder to support dynamic scaling of VM cpu/memory. Only used if I(state) is present.
    type: bool
  checksum:
    description:
      - The MD5 checksum value of this ISO. If set, we search by checksum instead of name.
+    type: str
  bootable:
    description:
-      - Register the ISO to be bootable. Only used if C(state) is present.
+      - Register the ISO to be bootable. Only used if I(state) is present.
    type: bool
  domain:
    description:
      - Domain the ISO is related to.
+    type: str
  account:
    description:
      - Account the ISO is related to.
+    type: str
  project:
    description:
      - Name of the project the ISO to be registered in.
+    type: str
  zone:
    description:
      - Name of the zone you wish the ISO to be registered or deleted from.
      - If not specified, first zone found will be used.
+    type: str
  cross_zones:
    description:
      - Whether the ISO should be synced or removed across zones.
-      - Mutually exclusive with C(zone).
+      - Mutually exclusive with I(zone).
    type: bool
-    default: 'no'
-    version_added: "2.4"
+    default: no
+    version_added: '2.4'
  iso_filter:
    description:
      - Name of the filter used to search for the ISO.
-    default: 'self'
-    choices: [ 'featured', 'self', 'selfexecutable','sharedexecutable','executable', 'community' ]
+    type: str
+    default: self
+    choices: [ featured, self, selfexecutable,sharedexecutable,executable, community ]
  state:
    description:
      - State of the ISO.
-    default: 'present'
-    choices: [ 'present', 'absent' ]
+    type: str
+    default: present
+    choices: [ present, absent ]
  poll_async:
    description:
      - Poll async jobs until job has finished.
    type: bool
-    default: 'yes'
-    version_added: "2.3"
+    default: yes
+    version_added: '2.3'
  tags:
    description:
-      - List of tags. Tags are a list of dictionaries having keys C(key) and C(value).
-      - "To delete all tags, set a empty list e.g. C(tags: [])."
-    aliases: [ 'tag' ]
-    version_added: "2.4"
+      - List of tags. Tags are a list of dictionaries having keys I(key) and I(value).
+      - "To delete all tags, set a empty list e.g. I(tags: [])."
+    type: list
+    aliases: [ tag ]
+    version_added: '2.4'
 extends_documentation_fragment: cloudstack
 '''

 EXAMPLES = '''
-# Register an ISO if ISO name does not already exist.
- local_action:
-    module: cs_iso
+- name: Register an ISO if ISO name does not already exist
+  cs_iso:
    name: Debian 7 64-bit
    url: http://mirror.switch.ch/ftp/mirror/debian-cd/current/amd64/iso-cd/debian-7.7.0-amd64-netinst.iso
    os_type: Debian GNU/Linux 7(64-bit)
+  delegate_to: localhost

-# Register an ISO with given name if ISO md5 checksum does not already exist.
- local_action:
-    module: cs_iso
+- name: Register an ISO with given name if ISO md5 checksum does not already exist
+  cs_iso:
    name: Debian 7 64-bit
    url: http://mirror.switch.ch/ftp/mirror/debian-cd/current/amd64/iso-cd/debian-7.7.0-amd64-netinst.iso
    os_type: Debian GNU/Linux 7(64-bit)
    checksum: 0b31bccccb048d20b551f70830bb7ad0
+  delegate_to: localhost

-# Remove an ISO by name
- local_action:
-    module: cs_iso
+- name: Remove an ISO by name
+  cs_iso:
    name: Debian 7 64-bit
    state: absent
+  delegate_to: localhost

-# Remove an ISO by checksum
- local_action:
-    module: cs_iso
+- name: Remove an ISO by checksum
+  cs_iso:
    name: Debian 7 64-bit
    checksum: 0b31bccccb048d20b551f70830bb7ad0
    state: absent
+  delegate_to: localhost
 '''

 RETURN = '''
@@ -183,31 +182,31 @@ is_public:
  returned: success
  type: bool
  sample: true
-  version_added: "2.4"
+  version_added: '2.4'
 bootable:
  description: True if the ISO is bootable.
  returned: success
  type: bool
  sample: true
-  version_added: "2.4"
+  version_added: '2.4'
 is_featured:
  description: True if the ISO is featured.
  returned: success
  type: bool
  sample: true
-  version_added: "2.4"
+  version_added: '2.4'
 format:
  description: Format of the ISO.
  returned: success
  type: str
  sample: ISO
-  version_added: "2.4"
+  version_added: '2.4'
 os_type:
  description: Typo of the OS.
  returned: success
  type: str
  sample: CentOS 6.5 (64-bit)
-  version_added: "2.4"
+  version_added: '2.4'
 checksum:
  description: MD5 checksum of the ISO.
  returned: success
@@ -223,7 +222,7 @@ cross_zones:
  returned: success
  type: bool
  sample: false
-  version_added: "2.4"
+  version_added: '2.4'
 domain:
  description: Domain the ISO is related to.
  returned: success
@@ -244,7 +243,7 @@ tags:
  returned: success
  type: dict
  sample: '[ { "key": "foo", "value": "bar" } ]'
-  version_added: "2.4"
+  version_added: '2.4'
 '''

 from ansible.module_utils.basic import AnsibleModule