ansible-collections/community.general
1
0
Fork 0
mirror of https://github.com/ansible-collections/community.general.git synced 2025-04-06 10:40:32 -07:00
Code Issues Projects Releases Packages Wiki Activity Actions 11

h*.py: normalize docs (#9394)

Browse source 
* h*.py: normalize docs

* Apply suggestions from code review

Co-authored-by: Felix Fontein <felix@fontein.de>

---------

Co-authored-by: Felix Fontein <felix@fontein.de>
This commit is contained in:
Alexei Znamensky 2024-12-27 09:55:56 +13:00 • committed by GitHub
parent 3048d5305d
commit 912065ad0e
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
26 changed files with 2272 additions and 2513 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

51
plugins/modules/haproxy.py
View file

@ -8,8 +8,7 @@
from __future__ import absolute_import, division, print_function from __future__ import absolute_import, division, print_function
__metaclass__ = type __metaclass__ = type
DOCUMENTATION = r''' DOCUMENTATION = r"""
---
module: haproxy module: haproxy
short_description: Enable, disable, and set weights for HAProxy backend servers using socket commands short_description: Enable, disable, and set weights for HAProxy backend servers using socket commands
author: author:
@ -17,12 +16,11 @@ author:
description: description:
- Enable, disable, drain and set weights for HAProxy backend servers using socket commands. - Enable, disable, drain and set weights for HAProxy backend servers using socket commands.
notes: notes:
- Enable, disable and drain commands are restricted and can only be issued on - Enable, disable and drain commands are restricted and can only be issued on sockets configured for level C(admin). For
sockets configured for level 'admin'. For example, you can add the line example, you can add the line C(stats socket /var/run/haproxy.sock level admin) to the general section of C(haproxy.cfg).
'stats socket /var/run/haproxy.sock level admin' to the general section of See U(http://haproxy.1wt.eu/download/1.5/doc/configuration.txt).
haproxy.cfg. See U(http://haproxy.1wt.eu/download/1.5/doc/configuration.txt). - Depends on netcat (C(nc)) being available; you need to install the appropriate package for your operating system before
- Depends on netcat (C(nc)) being available; you need to install the appropriate this module can be used.
package for your operating system before this module can be used.
extends_documentation_fragment: extends_documentation_fragment:
- community.general.attributes - community.general.attributes
attributes: attributes:
@ -38,8 +36,8 @@ options:
type: str type: str
drain: drain:
description: description:
- Wait until the server has no active connections or until the timeout - Wait until the server has no active connections or until the timeout determined by O(wait_interval) and O(wait_retries)
determined by wait_interval and wait_retries is reached. is reached.
- Continue only after the status changes to C(MAINT). - Continue only after the status changes to C(MAINT).
- This overrides the shutdown_sessions option. - This overrides the shutdown_sessions option.
type: bool type: bool
@ -51,10 +49,9 @@ options:
required: true required: true
shutdown_sessions: shutdown_sessions:
description: description:
- When disabling a server, immediately terminate all the sessions attached - When disabling a server, immediately terminate all the sessions attached to the specified server.
to the specified server. - This can be used to terminate long-running sessions after a server is put into maintenance mode. Overridden by the
- This can be used to terminate long-running sessions after a server is put drain option.
into maintenance mode. Overridden by the drain option.
type: bool type: bool
default: false default: false
socket: socket:
@ -65,8 +62,8 @@ options:
state: state:
description: description:
- Desired state of the provided backend host. - Desired state of the provided backend host.
- Note that V(drain) state is supported only by HAProxy version 1.5 or later. - Note that V(drain) state is supported only by HAProxy version 1.5 or later. When used on versions < 1.5, it will be
When used on versions < 1.5, it will be ignored. ignored.
type: str type: str
required: true required: true
choices: [disabled, drain, enabled] choices: [disabled, drain, enabled]
@ -89,8 +86,8 @@ options:
default: false default: false
wait: wait:
description: description:
- Wait until the server reports a status of C(UP) when O(state=enabled), - Wait until the server reports a status of C(UP) when O(state=enabled), status of C(MAINT) when O(state=disabled) or
status of C(MAINT) when O(state=disabled) or status of C(DRAIN) when O(state=drain). status of C(DRAIN) when O(state=drain).
type: bool type: bool
default: false default: false
wait_interval: wait_interval:
@ -106,14 +103,12 @@ options:
weight: weight:
description: description:
- The value passed in argument. - The value passed in argument.
- If the value ends with the V(%) sign, then the new weight will be - If the value ends with the V(%) sign, then the new weight will be relative to the initially configured weight.
relative to the initially configured weight. - Relative weights are only permitted between 0 and 100% and absolute weights are permitted between 0 and 256.
- Relative weights are only permitted between 0 and 100% and absolute
weights are permitted between 0 and 256.
type: str type: str
''' """
EXAMPLES = r''' EXAMPLES = r"""
- name: Disable server in 'www' backend pool - name: Disable server in 'www' backend pool
community.general.haproxy: community.general.haproxy:
state: disabled state: disabled
@ -168,7 +163,8 @@ EXAMPLES = r'''
socket: /var/run/haproxy.sock socket: /var/run/haproxy.sock
shutdown_sessions: true shutdown_sessions: true
- name: Disable server without backend pool name (apply to all available backend pool) but fail when the backend host is not found - name: Disable server without backend pool name (apply to all available backend pool) but fail when the backend host is
not found
community.general.haproxy: community.general.haproxy:
state: disabled state: disabled
host: '{{ inventory_hostname }}' host: '{{ inventory_hostname }}'
@ -187,7 +183,8 @@ EXAMPLES = r'''
backend: www backend: www
wait: true wait: true
- name: Enable server in 'www' backend pool wait until healthy. Retry 10 times with intervals of 5 seconds to retrieve the health - name: Enable server in 'www' backend pool wait until healthy. Retry 10 times with intervals of 5 seconds to retrieve the
health
community.general.haproxy: community.general.haproxy:
state: enabled state: enabled
host: '{{ inventory_hostname }}' host: '{{ inventory_hostname }}'
@ -210,7 +207,7 @@ EXAMPLES = r'''
host: '{{ inventory_hostname }}' host: '{{ inventory_hostname }}'
socket: /var/run/haproxy.sock socket: /var/run/haproxy.sock
backend: www backend: www
''' """
import csv import csv
import socket import socket

23
plugins/modules/heroku_collaborator.py
View file

@ -8,8 +8,7 @@
from __future__ import absolute_import, division, print_function from __future__ import absolute_import, division, print_function
__metaclass__ = type __metaclass__ = type
DOCUMENTATION = ''' DOCUMENTATION = r"""
---
module: heroku_collaborator module: heroku_collaborator
short_description: Add or delete app collaborators on Heroku short_description: Add or delete app collaborators on Heroku
description: description:
@ -32,35 +31,35 @@ options:
api_key: api_key:
type: str type: str
description: description:
- Heroku API key - Heroku API key.
apps: apps:
type: list type: list
elements: str elements: str
description: description:
- List of Heroku App names - List of Heroku App names.
required: true required: true
suppress_invitation: suppress_invitation:
description: description:
- Suppress email invitation when creating collaborator - Suppress email invitation when creating collaborator.
type: bool type: bool
default: false default: false
user: user:
type: str type: str
description: description:
- User ID or e-mail - User ID or e-mail.
required: true required: true
state: state:
type: str type: str
description: description:
- Create or remove the heroku collaborator - Create or remove the heroku collaborator.
choices: ["present", "absent"] choices: ["present", "absent"]
default: "present" default: "present"
notes: notes:
- E(HEROKU_API_KEY) and E(TF_VAR_HEROKU_API_KEY) environment variables can be used instead setting O(api_key). - E(HEROKU_API_KEY) and E(TF_VAR_HEROKU_API_KEY) environment variables can be used instead setting O(api_key).
- If you use C(check_mode), you can also pass the C(-v) flag to see affected apps in C(msg), e.g. ["heroku-example-app"]. - If you use C(check_mode), you can also pass the C(-v) flag to see affected apps in C(msg), for example C(["heroku-example-app"]).
''' """
EXAMPLES = ''' EXAMPLES = r"""
- name: Create a heroku collaborator - name: Create a heroku collaborator
community.general.heroku_collaborator: community.general.heroku_collaborator:
api_key: YOUR_API_KEY api_key: YOUR_API_KEY
@ -79,9 +78,9 @@ EXAMPLES = '''
- {user: 'a.b@example.com'} - {user: 'a.b@example.com'}
- {state: 'absent', user: 'b.c@example.com', suppress_invitation: false} - {state: 'absent', user: 'b.c@example.com', suppress_invitation: false}
- {user: 'x.y@example.com', apps: ["heroku-example-app"]} - {user: 'x.y@example.com', apps: ["heroku-example-app"]}
''' """
RETURN = ''' # ''' RETURN = """ # """
from ansible.module_utils.basic import AnsibleModule from ansible.module_utils.basic import AnsibleModule
from ansible_collections.community.general.plugins.module_utils.heroku import HerokuHelper from ansible_collections.community.general.plugins.module_utils.heroku import HerokuHelper

34
plugins/modules/hg.py
View file

@ -9,8 +9,7 @@
from __future__ import absolute_import, division, print_function from __future__ import absolute_import, division, print_function
__metaclass__ = type __metaclass__ = type
DOCUMENTATION = ''' DOCUMENTATION = r"""
---
module: hg module: hg
short_description: Manages Mercurial (hg) repositories short_description: Manages Mercurial (hg) repositories
description: description:
@ -32,13 +31,12 @@ options:
type: str type: str
dest: dest:
description: description:
- Absolute path of where the repository should be cloned to. - Absolute path of where the repository should be cloned to. This parameter is required, unless clone and update are
This parameter is required, unless clone and update are set to no set to no.
type: path type: path
revision: revision:
description: description:
- Equivalent C(-r) option in hg command which could be the changeset, revision number, - Equivalent C(-r) option in hg command which could be the changeset, revision number, branch name or even tag.
branch name or even tag.
aliases: [version] aliases: [version]
type: str type: str
force: force:
@ -53,7 +51,7 @@ options:
default: false default: false
update: update:
description: description:
- If V(false), do not retrieve new revisions from the origin repository - If V(false), do not retrieve new revisions from the origin repository.
type: bool type: bool
default: true default: true
clone: clone:
@ -63,21 +61,19 @@ options:
default: true default: true
executable: executable:
description: description:
- Path to hg executable to use. If not supplied, - Path to hg executable to use. If not supplied, the normal mechanism for resolving binary paths will be used.
the normal mechanism for resolving binary paths will be used.
type: str type: str
notes: notes:
- This module does not support push capability. See U(https://github.com/ansible/ansible/issues/31156). - This module does not support push capability. See U(https://github.com/ansible/ansible/issues/31156).
- "If the task seems to be hanging, first verify remote host is in C(known_hosts). - 'If the task seems to be hanging, first verify remote host is in C(known_hosts). SSH will prompt user to authorize the
SSH will prompt user to authorize the first contact with a remote host. To avoid this prompt, first contact with a remote host. To avoid this prompt, one solution is to add the remote host public key in C(/etc/ssh/ssh_known_hosts)
one solution is to add the remote host public key in C(/etc/ssh/ssh_known_hosts) before calling before calling the hg module, with the following command: C(ssh-keyscan remote_host.com >> /etc/ssh/ssh_known_hosts).'
the hg module, with the following command: ssh-keyscan remote_host.com >> /etc/ssh/ssh_known_hosts." - As per 01 Dec 2018, Bitbucket has dropped support for TLSv1 and TLSv1.1 connections. As such, if the underlying system
- As per 01 Dec 2018, Bitbucket has dropped support for TLSv1 and TLSv1.1 connections. As such, still uses a Python version below 2.7.9, you will have issues checking out bitbucket repositories.
if the underlying system still uses a Python version below 2.7.9, you will have issues checking out See U(https://bitbucket.org/blog/deprecating-tlsv1-tlsv1-1-2018-12-01).
bitbucket repositories. See U(https://bitbucket.org/blog/deprecating-tlsv1-tlsv1-1-2018-12-01). """
'''
EXAMPLES = ''' EXAMPLES = r"""
- name: Ensure the current working copy is inside the stable branch and deletes untracked files if any. - name: Ensure the current working copy is inside the stable branch and deletes untracked files if any.
community.general.hg: community.general.hg:
repo: https://bitbucket.org/user/repo1 repo: https://bitbucket.org/user/repo1
@ -91,7 +87,7 @@ EXAMPLES = '''
dest: /srv/checkout dest: /srv/checkout
clone: false clone: false
update: false update: false
''' """
import os import os

20
plugins/modules/hipchat.py
View file

@ -9,8 +9,7 @@ from __future__ import absolute_import, division, print_function
__metaclass__ = type __metaclass__ = type
DOCUMENTATION = ''' DOCUMENTATION = r"""
---
module: hipchat module: hipchat
short_description: Send a message to Hipchat short_description: Send a message to Hipchat
description: description:
@ -40,8 +39,7 @@ options:
msg_from: msg_from:
type: str type: str
description: description:
- Name the message will appear to be sent from. Max length is 15 - Name the message will appear to be sent from. Max length is 15 characters - above this it will be truncated.
characters - above this it will be truncated.
default: Ansible default: Ansible
aliases: [from] aliases: [from]
msg: msg:
@ -68,23 +66,23 @@ options:
default: true default: true
validate_certs: validate_certs:
description: description:
- If V(false), SSL certificates will not be validated. This should only be used - If V(false), SSL certificates will not be validated. This should only be used on personally controlled sites using
on personally controlled sites using self-signed certificates. self-signed certificates.
type: bool type: bool
default: true default: true
api: api:
type: str type: str
description: description:
- API url if using a self-hosted hipchat server. For Hipchat API version - API url if using a self-hosted hipchat server. For Hipchat API version 2 use the default URI with C(/v2) instead of
2 use the default URI with C(/v2) instead of C(/v1). C(/v1).
default: 'https://api.hipchat.com/v1' default: 'https://api.hipchat.com/v1'
author: author:
- Shirou Wakayama (@shirou) - Shirou Wakayama (@shirou)
- Paul Bourdel (@pb8226) - Paul Bourdel (@pb8226)
''' """
EXAMPLES = ''' EXAMPLES = r"""
- name: Send a message to a Hipchat room - name: Send a message to a Hipchat room
community.general.hipchat: community.general.hipchat:
room: notif room: notif
@ -96,7 +94,7 @@ EXAMPLES = '''
token: OAUTH2_TOKEN token: OAUTH2_TOKEN
room: notify room: notify
msg: Ansible task finished msg: Ansible task finished
''' """
# =========================================== # ===========================================
# HipChat module specific support methods. # HipChat module specific support methods.

39
plugins/modules/homebrew.py
View file

@ -14,8 +14,7 @@ from __future__ import absolute_import, division, print_function
__metaclass__ = type __metaclass__ = type
DOCUMENTATION = ''' DOCUMENTATION = r"""
---
module: homebrew module: homebrew
author: author:
- "Indrajit Raychaudhuri (@indrajitr)" - "Indrajit Raychaudhuri (@indrajitr)"
@ -25,7 +24,7 @@ requirements:
- homebrew must already be installed on the target system - homebrew must already be installed on the target system
short_description: Package manager for Homebrew short_description: Package manager for Homebrew
description: description:
- Manages Homebrew packages - Manages Homebrew packages.
extends_documentation_fragment: extends_documentation_fragment:
- community.general.attributes - community.general.attributes
attributes: attributes:
@ -42,31 +41,31 @@ options:
elements: str elements: str
path: path:
description: description:
- "A V(:) separated list of paths to search for C(brew) executable. - A V(:) separated list of paths to search for C(brew) executable. Since a package (I(formula) in homebrew parlance)
Since a package (I(formula) in homebrew parlance) location is prefixed relative to the actual path of C(brew) command, location is prefixed relative to the actual path of C(brew) command, providing an alternative C(brew) path enables
providing an alternative C(brew) path enables managing different set of packages in an alternative location in the system." managing different set of packages in an alternative location in the system.
default: '/usr/local/bin:/opt/homebrew/bin:/home/linuxbrew/.linuxbrew/bin' default: '/usr/local/bin:/opt/homebrew/bin:/home/linuxbrew/.linuxbrew/bin'
type: path type: path
state: state:
description: description:
- state of the package. - State of the package.
choices: ['absent', 'head', 'installed', 'latest', 'linked', 'present', 'removed', 'uninstalled', 'unlinked', 'upgraded'] choices: ['absent', 'head', 'installed', 'latest', 'linked', 'present', 'removed', 'uninstalled', 'unlinked', 'upgraded']
default: present default: present
type: str type: str
update_homebrew: update_homebrew:
description: description:
- update homebrew itself first. - Update homebrew itself first.
type: bool type: bool
default: false default: false
upgrade_all: upgrade_all:
description: description:
- upgrade all homebrew packages. - Upgrade all homebrew packages.
type: bool type: bool
default: false default: false
aliases: ['upgrade'] aliases: ['upgrade']
install_options: install_options:
description: description:
- options flags to install a package. - Options flags to install a package.
aliases: ['options'] aliases: ['options']
type: list type: list
elements: str elements: str
@ -84,11 +83,11 @@ options:
default: false default: false
version_added: 9.0.0 version_added: 9.0.0
notes: notes:
- When used with a C(loop:) each package will be processed individually, - When used with a C(loop:) each package will be processed individually, it is much more efficient to pass the list directly
it is much more efficient to pass the list directly to the O(name) option. to the O(name) option.
''' """
EXAMPLES = ''' EXAMPLES = r"""
# Install formula foo with 'brew' in default path # Install formula foo with 'brew' in default path
- community.general.homebrew: - community.general.homebrew:
name: foo name: foo
@ -154,29 +153,29 @@ EXAMPLES = '''
name: ambiguous_formula name: ambiguous_formula
state: present state: present
force_formula: true force_formula: true
''' """
RETURN = ''' RETURN = r"""
msg: msg:
description: if the cache was updated or not description: If the cache was updated or not.
returned: always returned: always
type: str type: str
sample: "Changed: 0, Unchanged: 2" sample: "Changed: 0, Unchanged: 2"
unchanged_pkgs: unchanged_pkgs:
description: description:
- List of package names which are unchanged after module run - List of package names which are unchanged after module run.
returned: success returned: success
type: list type: list
sample: ["awscli", "ag"] sample: ["awscli", "ag"]
version_added: '0.2.0' version_added: '0.2.0'
changed_pkgs: changed_pkgs:
description: description:
- List of package names which are changed after module run - List of package names which are changed after module run.
returned: success returned: success
type: list type: list
sample: ['git', 'git-cola'] sample: ['git', 'git-cola']
version_added: '0.2.0' version_added: '0.2.0'
''' """
import json import json
import re import re

16
plugins/modules/homebrew_cask.py
View file

@ -11,8 +11,7 @@ from __future__ import absolute_import, division, print_function
__metaclass__ = type __metaclass__ = type
DOCUMENTATION = ''' DOCUMENTATION = r"""
---
module: homebrew_cask module: homebrew_cask
author: author:
- "Indrajit Raychaudhuri (@indrajitr)" - "Indrajit Raychaudhuri (@indrajitr)"
@ -48,7 +47,7 @@ options:
type: str type: str
sudo_password: sudo_password:
description: description:
- The sudo password to be passed to SUDO_ASKPASS. - The sudo password to be passed to E(SUDO_ASKPASS).
required: false required: false
type: str type: str
update_homebrew: update_homebrew:
@ -78,13 +77,12 @@ options:
greedy: greedy:
description: description:
- Upgrade casks that auto update. - Upgrade casks that auto update.
- Passes C(--greedy) to C(brew outdated --cask) when checking - Passes C(--greedy) to C(brew outdated --cask) when checking if an installed cask has a newer version available, or
if an installed cask has a newer version available, to C(brew upgrade --cask) when upgrading all casks.
or to C(brew upgrade --cask) when upgrading all casks.
type: bool type: bool
default: false default: false
''' """
EXAMPLES = ''' EXAMPLES = r"""
- name: Install cask - name: Install cask
community.general.homebrew_cask: community.general.homebrew_cask:
name: alfred name: alfred
@ -151,7 +149,7 @@ EXAMPLES = '''
name: wireshark name: wireshark
state: present state: present
sudo_password: "{{ ansible_become_pass }}" sudo_password: "{{ ansible_become_pass }}"
''' """
import os import os
import re import re

15
plugins/modules/homebrew_services.py
View file

@ -14,8 +14,7 @@ from __future__ import absolute_import, division, print_function
__metaclass__ = type __metaclass__ = type
DOCUMENTATION = """ DOCUMENTATION = r"""
---
module: homebrew_services module: homebrew_services
author: author:
- "Kit Ham (@kitizz)" - "Kit Ham (@kitizz)"
@ -24,7 +23,7 @@ requirements:
short_description: Services manager for Homebrew short_description: Services manager for Homebrew
version_added: 9.3.0 version_added: 9.3.0
description: description:
- Manages daemons and services via Homebrew. - Manages daemons and services using Homebrew.
extends_documentation_fragment: extends_documentation_fragment:
- community.general.attributes - community.general.attributes
attributes: attributes:
@ -41,9 +40,9 @@ options:
required: true required: true
path: path:
description: description:
- "A V(:) separated list of paths to search for C(brew) executable. - A V(:) separated list of paths to search for C(brew) executable. Since a package (I(formula) in homebrew parlance)
Since a package (I(formula) in homebrew parlance) location is prefixed relative to the actual path of C(brew) command, location is prefixed relative to the actual path of C(brew) command, providing an alternative C(brew) path enables
providing an alternative C(brew) path enables managing different set of packages in an alternative location in the system." managing different set of packages in an alternative location in the system.
default: '/usr/local/bin:/opt/homebrew/bin:/home/linuxbrew/.linuxbrew/bin' default: '/usr/local/bin:/opt/homebrew/bin:/home/linuxbrew/.linuxbrew/bin'
type: path type: path
state: state:
@ -54,7 +53,7 @@ options:
type: str type: str
""" """
EXAMPLES = """ EXAMPLES = r"""
- name: Install foo package - name: Install foo package
community.general.homebrew: community.general.homebrew:
name: foo name: foo
@ -76,7 +75,7 @@ EXAMPLES = """
service_state: absent service_state: absent
""" """
RETURN = """ RETURN = r"""
pid: pid:
description: description:
- If the service is now running, this is the PID of the service, otherwise -1. - If the service is now running, this is the PID of the service, otherwise -1.

21
plugins/modules/homebrew_tap.py
View file

@ -13,8 +13,7 @@ from __future__ import absolute_import, division, print_function
__metaclass__ = type __metaclass__ = type
DOCUMENTATION = r''' DOCUMENTATION = r"""
---
module: homebrew_tap module: homebrew_tap
author: author:
- "Indrajit Raychaudhuri (@indrajitr)" - "Indrajit Raychaudhuri (@indrajitr)"
@ -39,30 +38,28 @@ options:
elements: str elements: str
url: url:
description: description:
- The optional git URL of the repository to tap. The URL is not - The optional git URL of the repository to tap. The URL is not assumed to be on GitHub, and the protocol does not have
assumed to be on GitHub, and the protocol doesn't have to be HTTP. to be HTTP. Any location and protocol that git can handle is fine.
Any location and protocol that git can handle is fine. - O(name) option may not be a list of multiple taps (but a single tap instead) when this option is provided.
- O(name) option may not be a list of multiple taps (but a single
tap instead) when this option is provided.
required: false required: false
type: str type: str
state: state:
description: description:
- state of the repository. - State of the repository.
choices: ['present', 'absent'] choices: ['present', 'absent']
required: false required: false
default: 'present' default: 'present'
type: str type: str
path: path:
description: description:
- "A V(:) separated list of paths to search for C(brew) executable." - A V(:) separated list of paths to search for C(brew) executable.
default: '/usr/local/bin:/opt/homebrew/bin:/home/linuxbrew/.linuxbrew/bin' default: '/usr/local/bin:/opt/homebrew/bin:/home/linuxbrew/.linuxbrew/bin'
type: path type: path
version_added: '2.1.0' version_added: '2.1.0'
requirements: [homebrew] requirements: [homebrew]
''' """
EXAMPLES = r''' EXAMPLES = r"""
- name: Tap a Homebrew repository, state present - name: Tap a Homebrew repository, state present
community.general.homebrew_tap: community.general.homebrew_tap:
name: homebrew/dupes name: homebrew/dupes
@ -81,7 +78,7 @@ EXAMPLES = r'''
community.general.homebrew_tap: community.general.homebrew_tap:
name: telemachus/brew name: telemachus/brew
url: 'https://bitbucket.org/telemachus/brew' url: 'https://bitbucket.org/telemachus/brew'
''' """
import re import re

35
plugins/modules/homectl.py
View file

@ -8,8 +8,7 @@
from __future__ import absolute_import, division, print_function from __future__ import absolute_import, division, print_function
__metaclass__ = type __metaclass__ = type
DOCUMENTATION = ''' DOCUMENTATION = r"""
---
module: homectl module: homectl
author: author:
- "James Livulpi (@jameslivulpi)" - "James Livulpi (@jameslivulpi)"
@ -18,9 +17,8 @@ version_added: 4.4.0
description: description:
- Manages a user's home directory managed by systemd-homed. - Manages a user's home directory managed by systemd-homed.
notes: notes:
- This module requires the deprecated L(crypt Python module, - This module requires the deprecated L(crypt Python module, https://docs.python.org/3.12/library/crypt.html) library which
https://docs.python.org/3.12/library/crypt.html) library which was removed from Python 3.13. was removed from Python 3.13. For Python 3.13 or newer, you need to install L(legacycrypt, https://pypi.org/project/legacycrypt/).
For Python 3.13 or newer, you need to install L(legacycrypt, https://pypi.org/project/legacycrypt/).
requirements: requirements:
- legacycrypt (on Python 3.13 or newer) - legacycrypt (on Python 3.13 or newer)
extends_documentation_fragment: extends_documentation_fragment:
@ -41,9 +39,11 @@ options:
description: description:
- Set the user's password to this. - Set the user's password to this.
- Homed requires this value to be in cleartext on user creation and updating a user. - Homed requires this value to be in cleartext on user creation and updating a user.
- The module takes the password and generates a password hash in SHA-512 with 10000 rounds of salt generation using crypt. - The module takes the password and generates a password hash in SHA-512 with 10000 rounds of salt generation using
crypt.
- See U(https://systemd.io/USER_RECORD/). - See U(https://systemd.io/USER_RECORD/).
- This is required for O(state=present). When an existing user is updated this is checked against the stored hash in homed. - This is required for O(state=present). When an existing user is updated this is checked against the stored hash in
homed.
type: str type: str
state: state:
description: description:
@ -54,7 +54,7 @@ options:
storage: storage:
description: description:
- Indicates the storage mechanism for the user's home directory. - Indicates the storage mechanism for the user's home directory.
- If the storage type is not specified, ``homed.conf(5)`` defines which default storage to use. - If the storage type is not specified, C(homed.conf(5\)) defines which default storage to use.
- Only used when a user is first created. - Only used when a user is first created.
choices: ['classic', 'luks', 'directory', 'subvolume', 'fscrypt', 'cifs'] choices: ['classic', 'luks', 'directory', 'subvolume', 'fscrypt', 'cifs']
type: str type: str
@ -125,7 +125,7 @@ options:
type: str type: str
umask: umask:
description: description:
- Sets the umask for the user's login sessions - Sets the umask for the user's login sessions.
- Value from V(0000) to V(0777). - Value from V(0000) to V(0777).
type: int type: int
memberof: memberof:
@ -148,10 +148,9 @@ options:
type: str type: str
environment: environment:
description: description:
- String separated by comma each containing an environment variable and its value to - String separated by comma each containing an environment variable and its value to set for the user's login session,
set for the user's login session, in a format compatible with ``putenv()``. in a format compatible with C(putenv(\)).
- Any environment variable listed here is automatically set by pam_systemd for all - Any environment variable listed here is automatically set by pam_systemd for all login sessions of the user.
login sessions of the user.
aliases: ['setenv'] aliases: ['setenv']
type: str type: str
timezone: timezone:
@ -185,9 +184,9 @@ options:
description: description:
- A time since the UNIX epoch after which the record should be considered invalid for the purpose of logging in. - A time since the UNIX epoch after which the record should be considered invalid for the purpose of logging in.
type: int type: int
''' """
EXAMPLES = ''' EXAMPLES = r"""
- name: Add the user 'james' - name: Add the user 'james'
community.general.homectl: community.general.homectl:
name: johnd name: johnd
@ -215,9 +214,9 @@ EXAMPLES = '''
community.general.homectl: community.general.homectl:
name: janet name: janet
state: absent state: absent
''' """
RETURN = ''' RETURN = r"""
data: data:
description: A json dictionary returned from C(homectl inspect -j). description: A json dictionary returned from C(homectl inspect -j).
returned: success returned: success
@ -267,7 +266,7 @@ data:
"userName": "james", "userName": "james",
} }
} }
''' """
import json import json
import traceback import traceback

24
plugins/modules/honeybadger_deployment.py
View file

@ -8,8 +8,7 @@
from __future__ import absolute_import, division, print_function from __future__ import absolute_import, division, print_function
__metaclass__ = type __metaclass__ = type
DOCUMENTATION = ''' DOCUMENTATION = r"""
---
module: honeybadger_deployment module: honeybadger_deployment
author: "Benjamin Curtis (@stympy)" author: "Benjamin Curtis (@stympy)"
short_description: Notify Honeybadger.io about app deployments short_description: Notify Honeybadger.io about app deployments
@ -31,20 +30,20 @@ options:
environment: environment:
type: str type: str
description: description:
- The environment name, typically 'production', 'staging', etc. - The environment name, typically V(production), V(staging), and so on.
required: true required: true
user: user:
type: str type: str
description: description:
- The username of the person doing the deployment - The username of the person doing the deployment.
repo: repo:
type: str type: str
description: description:
- URL of the project repository - URL of the project repository.
revision: revision:
type: str type: str
description: description:
- A hash, number, tag, or other identifier showing what revision was deployed - A hash, number, tag, or other identifier showing what revision was deployed.
url: url:
type: str type: str
description: description:
@ -52,14 +51,13 @@ options:
default: "https://api.honeybadger.io/v1/deploys" default: "https://api.honeybadger.io/v1/deploys"
validate_certs: validate_certs:
description: description:
- If V(false), SSL certificates for the target url will not be validated. This should only be used - If V(false), SSL certificates for the target url will not be validated. This should only be used on personally controlled
on personally controlled sites using self-signed certificates. sites using self-signed certificates.
type: bool type: bool
default: true default: true
"""
''' EXAMPLES = r"""
EXAMPLES = '''
- name: Notify Honeybadger.io about an app deployment - name: Notify Honeybadger.io about an app deployment
community.general.honeybadger_deployment: community.general.honeybadger_deployment:
token: AAAAAA token: AAAAAA
@ -67,9 +65,9 @@ EXAMPLES = '''
user: ansible user: ansible
revision: b6826b8 revision: b6826b8
repo: 'git@github.com:user/repo.git' repo: 'git@github.com:user/repo.git'
''' """
RETURN = '''# ''' RETURN = """# """
import traceback import traceback

44
plugins/modules/hpilo_boot.py
View file

@ -9,14 +9,13 @@ from __future__ import absolute_import, division, print_function
__metaclass__ = type __metaclass__ = type
DOCUMENTATION = ''' DOCUMENTATION = r"""
---
module: hpilo_boot module: hpilo_boot
author: Dag Wieers (@dagwieers) author: Dag Wieers (@dagwieers)
short_description: Boot system using specific media through HP iLO interface short_description: Boot system using specific media through HP iLO interface
description: description:
- "This module boots a system through its HP iLO interface. The boot media - 'This module boots a system through its HP iLO interface. The boot media can be one of: V(cdrom), V(floppy), V(hdd),
can be one of: cdrom, floppy, hdd, network or usb." V(network), or V(usb).'
- This module requires the hpilo python module. - This module requires the hpilo python module.
extends_documentation_fragment: extends_documentation_fragment:
- community.general.attributes - community.general.attributes
@ -43,26 +42,25 @@ options:
type: str type: str
media: media:
description: description:
- The boot media to boot the system from - The boot media to boot the system from.
choices: ["cdrom", "floppy", "rbsu", "hdd", "network", "normal", "usb"] choices: ["cdrom", "floppy", "rbsu", "hdd", "network", "normal", "usb"]
type: str type: str
image: image:
description: description:
- The URL of a cdrom, floppy or usb boot media image. - The URL of a cdrom, floppy or usb boot media image in the form V(protocol://username:password@hostname:port/filename).
protocol://username:password@hostname:port/filename - V(protocol) is either V(http) or V(https).
- protocol is either 'http' or 'https' - V(username:password) is optional.
- username:password is optional - V(port) is optional.
- port is optional
type: str type: str
state: state:
description: description:
- The state of the boot media. - The state of the boot media.
- "no_boot: Do not boot from the device" - "V(no_boot): Do not boot from the device"
- "boot_once: Boot from the device once and then notthereafter" - "V(boot_once): Boot from the device once and then notthereafter"
- "boot_always: Boot from the device each time the server is rebooted" - "V(boot_always): Boot from the device each time the server is rebooted"
- "connect: Connect the virtual media device and set to boot_always" - "V(connect): Connect the virtual media device and set to boot_always"
- "disconnect: Disconnects the virtual media device and set to no_boot" - "V(disconnect): Disconnects the virtual media device and set to no_boot"
- "poweroff: Power off the server" - "V(poweroff): Power off the server"
default: boot_once default: boot_once
type: str type: str
choices: ["boot_always", "boot_once", "connect", "disconnect", "no_boot", "poweroff"] choices: ["boot_always", "boot_once", "connect", "disconnect", "no_boot", "poweroff"]
@ -82,11 +80,11 @@ requirements:
- python-hpilo - python-hpilo
notes: notes:
- To use a USB key image you need to specify floppy as boot media. - To use a USB key image you need to specify floppy as boot media.
- This module ought to be run from a system that can access the HP iLO - This module ought to be run from a system that can access the HP iLO interface directly, either by using C(local_action)
interface directly, either by using C(local_action) or using C(delegate_to). or using C(delegate_to).
''' """
EXAMPLES = r''' EXAMPLES = r"""
- name: Task to boot a system using an ISO from an HP iLO interface only if the system is an HP server - name: Task to boot a system using an ISO from an HP iLO interface only if the system is an HP server
community.general.hpilo_boot: community.general.hpilo_boot:
host: YOUR_ILO_ADDRESS host: YOUR_ILO_ADDRESS
@ -104,11 +102,11 @@ EXAMPLES = r'''
password: YOUR_ILO_PASSWORD password: YOUR_ILO_PASSWORD
state: poweroff state: poweroff
delegate_to: localhost delegate_to: localhost
''' """
RETURN = ''' RETURN = r"""
# Default return values # Default return values
''' """
import time import time
import traceback import traceback

38
plugins/modules/hpilo_info.py
View file

@ -9,15 +9,13 @@ from __future__ import absolute_import, division, print_function
__metaclass__ = type __metaclass__ = type
DOCUMENTATION = r''' DOCUMENTATION = r"""
---
module: hpilo_info module: hpilo_info
author: Dag Wieers (@dagwieers) author: Dag Wieers (@dagwieers)
short_description: Gather information through an HP iLO interface short_description: Gather information through an HP iLO interface
description: description:
- This module gathers information on a specific system using its HP iLO interface. - This module gathers information on a specific system using its HP iLO interface. These information includes hardware and
These information includes hardware and network related information useful network related information useful for provisioning (for example macaddress, uuid).
for provisioning (e.g. macaddress, uuid).
- This module requires the C(hpilo) python module. - This module requires the C(hpilo) python module.
extends_documentation_fragment: extends_documentation_fragment:
- community.general.attributes - community.general.attributes
@ -47,11 +45,11 @@ options:
requirements: requirements:
- hpilo - hpilo
notes: notes:
- This module ought to be run from a system that can access the HP iLO - This module ought to be run from a system that can access the HP iLO interface directly, either by using C(local_action)
interface directly, either by using C(local_action) or using C(delegate_to). or using C(delegate_to).
''' """
EXAMPLES = r''' EXAMPLES = r"""
- name: Gather facts from a HP iLO interface only if the system is an HP server - name: Gather facts from a HP iLO interface only if the system is an HP server
community.general.hpilo_info: community.general.hpilo_info:
host: YOUR_ILO_ADDRESS host: YOUR_ILO_ADDRESS
@ -64,24 +62,24 @@ EXAMPLES = r'''
- ansible.builtin.fail: - ansible.builtin.fail:
msg: 'CMDB serial ({{ cmdb_serialno }}) does not match hardware serial ({{ results.hw_system_serial }}) !' msg: 'CMDB serial ({{ cmdb_serialno }}) does not match hardware serial ({{ results.hw_system_serial }}) !'
when: cmdb_serialno != results.hw_system_serial when: cmdb_serialno != results.hw_system_serial
''' """
RETURN = r''' RETURN = r"""
# Typical output of HP iLO_info for a physical system # Typical output of HP iLO_info for a physical system
hw_bios_date: hw_bios_date:
description: BIOS date description: BIOS date.
returned: always returned: always
type: str type: str
sample: 05/05/2011 sample: 05/05/2011
hw_bios_version: hw_bios_version:
description: BIOS version description: BIOS version.
returned: always returned: always
type: str type: str
sample: P68 sample: P68
hw_ethX: hw_ethX:
description: Interface information (for each interface) description: Interface information (for each interface).
returned: always returned: always
type: dict type: dict
sample: sample:
@ -89,7 +87,7 @@ hw_ethX:
macaddress_dash: 00-11-22-33-44-55 macaddress_dash: 00-11-22-33-44-55
hw_eth_ilo: hw_eth_ilo:
description: Interface information (for the iLO network interface) description: Interface information (for the iLO network interface).
returned: always returned: always
type: dict type: dict
sample: sample:
@ -97,25 +95,25 @@ hw_eth_ilo:
- macaddress_dash: 00-11-22-33-44-BA - macaddress_dash: 00-11-22-33-44-BA
hw_product_name: hw_product_name:
description: Product name description: Product name.
returned: always returned: always
type: str type: str
sample: ProLiant DL360 G7 sample: ProLiant DL360 G7
hw_product_uuid: hw_product_uuid:
description: Product UUID description: Product UUID.
returned: always returned: always
type: str type: str
sample: ef50bac8-2845-40ff-81d9-675315501dac sample: ef50bac8-2845-40ff-81d9-675315501dac
hw_system_serial: hw_system_serial:
description: System serial number description: System serial number.
returned: always returned: always
type: str type: str
sample: ABC12345D6 sample: ABC12345D6
hw_uuid: hw_uuid:
description: Hardware UUID description: Hardware UUID.
returned: always returned: always
type: str type: str
sample: 123456ABC78901D2 sample: 123456ABC78901D2
@ -128,7 +126,7 @@ host_power_status:
type: str type: str
sample: "ON" sample: "ON"
version_added: 3.5.0 version_added: 3.5.0
''' """
import re import re
import traceback import traceback

21
plugins/modules/hponcfg.py
View file

@ -9,13 +9,12 @@ from __future__ import absolute_import, division, print_function
__metaclass__ = type __metaclass__ = type
DOCUMENTATION = r''' DOCUMENTATION = r"""
---
module: hponcfg module: hponcfg
author: Dag Wieers (@dagwieers) author: Dag Wieers (@dagwieers)
short_description: Configure HP iLO interface using hponcfg short_description: Configure HP iLO interface using C(hponcfg)
description: description:
- This modules configures the HP iLO interface using hponcfg. - This modules configures the HP iLO interface using C(hponcfg).
extends_documentation_fragment: extends_documentation_fragment:
- community.general.attributes - community.general.attributes
attributes: attributes:
@ -26,7 +25,7 @@ attributes:
options: options:
path: path:
description: description:
- The XML file as accepted by hponcfg. - The XML file as accepted by C(hponcfg).
required: true required: true
aliases: ['src'] aliases: ['src']
type: path type: path
@ -37,21 +36,21 @@ options:
type: str type: str
executable: executable:
description: description:
- Path to the hponcfg executable (C(hponcfg) which uses $PATH). - Path to the hponcfg executable (C(hponcfg) which uses E(PATH)).
default: hponcfg default: hponcfg
type: str type: str
verbose: verbose:
description: description:
- Run hponcfg in verbose mode (-v). - Run C(hponcfg) in verbose mode (-v).
default: false default: false
type: bool type: bool
requirements: requirements:
- hponcfg tool - hponcfg tool
notes: notes:
- You need a working hponcfg on the target system. - You need a working C(hponcfg) on the target system.
''' """
EXAMPLES = r''' EXAMPLES = r"""
- name: Example hponcfg configuration XML - name: Example hponcfg configuration XML
ansible.builtin.copy: ansible.builtin.copy:
content: | content: |
@ -78,7 +77,7 @@ EXAMPLES = r'''
community.general.hponcfg: community.general.hponcfg:
src: /tmp/enable-ssh.xml src: /tmp/enable-ssh.xml
executable: /opt/hp/tools/hponcfg executable: /opt/hp/tools/hponcfg
''' """
from ansible_collections.community.general.plugins.module_utils.cmd_runner import CmdRunner, cmd_runner_fmt from ansible_collections.community.general.plugins.module_utils.cmd_runner import CmdRunner, cmd_runner_fmt
from ansible_collections.community.general.plugins.module_utils.module_helper import ModuleHelper from ansible_collections.community.general.plugins.module_utils.module_helper import ModuleHelper

29
plugins/modules/htpasswd.py
View file

@ -9,7 +9,7 @@ from __future__ import absolute_import, division, print_function
__metaclass__ = type __metaclass__ = type
DOCUMENTATION = ''' DOCUMENTATION = r"""
module: htpasswd module: htpasswd
short_description: Manage user files for basic authentication short_description: Manage user files for basic authentication
description: description:
@ -44,12 +44,10 @@ options:
required: false required: false
default: "apr_md5_crypt" default: "apr_md5_crypt"
description: description:
- Hashing scheme to be used. As well as the four choices listed - Hashing scheme to be used. As well as the four choices listed here, you can also use any other hash supported by passlib,
here, you can also use any other hash supported by passlib, such as such as V(portable_apache22) and V(host_apache24); or V(md5_crypt) and V(sha256_crypt), which are Linux passwd hashes.
V(portable_apache22) and V(host_apache24); or V(md5_crypt) and V(sha256_crypt), Only some schemes in addition to the four choices below will be compatible with Apache or Nginx, and supported schemes
which are Linux passwd hashes. Only some schemes in addition to depend on passlib version and its dependencies.
the four choices below will be compatible with Apache or Nginx, and
supported schemes depend on passlib version and its dependencies.
- See U(https://passlib.readthedocs.io/en/stable/lib/passlib.apache.html#passlib.apache.HtpasswdFile) parameter C(default_scheme). - See U(https://passlib.readthedocs.io/en/stable/lib/passlib.apache.html#passlib.apache.HtpasswdFile) parameter C(default_scheme).
- 'Some of the available choices might be: V(apr_md5_crypt), V(des_crypt), V(ldap_sha1), V(plaintext).' - 'Some of the available choices might be: V(apr_md5_crypt), V(des_crypt), V(ldap_sha1), V(plaintext).'
aliases: [crypt_scheme] aliases: [crypt_scheme]
@ -65,22 +63,21 @@ options:
type: bool type: bool
default: true default: true
description: description:
- Used with O(state=present). If V(true), the file will be created - Used with O(state=present). If V(true), the file will be created if it does not exist. Conversely, if set to V(false)
if it does not exist. Conversely, if set to V(false) and the file and the file does not exist it will fail.
does not exist it will fail.
notes: notes:
- "This module depends on the C(passlib) Python library, which needs to be installed on all target systems." - This module depends on the C(passlib) Python library, which needs to be installed on all target systems.
- "On Debian < 11, Ubuntu <= 20.04, or Fedora: install C(python-passlib)." - 'On Debian < 11, Ubuntu <= 20.04, or Fedora: install C(python-passlib).'
- "On Debian, Ubuntu: install C(python3-passlib)." - 'On Debian, Ubuntu: install C(python3-passlib).'
- "On RHEL or CentOS: Enable EPEL, then install C(python-passlib)." - 'On RHEL or CentOS: Enable EPEL, then install C(python-passlib).'
requirements: [passlib>=1.6] requirements: [passlib>=1.6]
author: "Ansible Core Team" author: "Ansible Core Team"
extends_documentation_fragment: extends_documentation_fragment:
- files - files
- community.general.attributes - community.general.attributes
''' """
EXAMPLES = """ EXAMPLES = r"""
- name: Add a user to a password file and ensure permissions are set - name: Add a user to a password file and ensure permissions are set
community.general.htpasswd: community.general.htpasswd:
path: /etc/nginx/passwdfile path: /etc/nginx/passwdfile

185
plugins/modules/hwc_ecs_instance.py
View file

@ -12,11 +12,10 @@ __metaclass__ = type
# Documentation # Documentation
############################################################################### ###############################################################################
DOCUMENTATION = ''' DOCUMENTATION = r"""
---
module: hwc_ecs_instance module: hwc_ecs_instance
description: description:
- instance management. - Instance management.
short_description: Creates a resource of Ecs/Instance in Huawei Cloud short_description: Creates a resource of Ecs/Instance in Huawei Cloud
version_added: '0.2.0' version_added: '0.2.0'
author: Huawei Inc. (@huaweicloud) author: Huawei Inc. (@huaweicloud)
@ -72,25 +71,22 @@ options:
required: true required: true
name: name:
description: description:
- Specifies the ECS name. Value requirements consists of 1 to 64 - Specifies the ECS name. Value requirements consists of 1 to 64 characters, including letters, digits, underscores
characters, including letters, digits, underscores (V(_)), hyphens (V(_)), hyphens (V(-)), periods (V(.)).
(V(-)), periods (V(.)).
type: str type: str
required: true required: true
nics: nics:
description: description:
- Specifies the NIC information of the ECS. Constraints the - Specifies the NIC information of the ECS. Constraints the network of the NIC must belong to the VPC specified by vpc_id.
network of the NIC must belong to the VPC specified by vpc_id. A A maximum of 12 NICs can be attached to an ECS.
maximum of 12 NICs can be attached to an ECS.
type: list type: list
elements: dict elements: dict
required: true required: true
suboptions: suboptions:
ip_address: ip_address:
description: description:
- Specifies the IP address of the NIC. The value is an IPv4 - Specifies the IP address of the NIC. The value is an IPv4 address. Its value must be an unused IP address in the
address. Its value must be an unused IP network segment of the subnet.
address in the network segment of the subnet.
type: str type: str
required: true required: true
subnet_id: subnet_id:
@ -110,28 +106,22 @@ options:
- SATA is common I/O disk type. - SATA is common I/O disk type.
- SAS is high I/O disk type. - SAS is high I/O disk type.
- SSD is ultra-high I/O disk type. - SSD is ultra-high I/O disk type.
- co-p1 is high I/O (performance-optimized I) disk type. - Co-p1 is high I/O (performance-optimized I) disk type.
- uh-l1 is ultra-high I/O (latency-optimized) disk type. - Uh-l1 is ultra-high I/O (latency-optimized) disk type.
- NOTE is For HANA, HL1, and HL2 ECSs, use co-p1 and uh-l1 - NOTE is For HANA, HL1, and HL2 ECSs, use co-p1 and uh-l1 disks. For other ECSs, do not use co-p1 or uh-l1 disks.
disks. For other ECSs, do not use co-p1 or uh-l1 disks.
type: str type: str
required: true required: true
size: size:
description: description:
- Specifies the system disk size, in GB. The value range is - Specifies the system disk size, in GB. The value range is 1 to 1024. The system disk size must be greater than
1 to 1024. The system disk size must be or equal to the minimum system disk size supported by the image (min_disk attribute of the image). If this parameter
greater than or equal to the minimum system disk size is not specified or is set to 0, the default system disk size is the minimum value of the system disk in the image
supported by the image (min_disk attribute of the image). (min_disk attribute of the image).
If this parameter is not specified or is set to 0, the
default system disk size is the minimum value of the
system disk in the image (min_disk attribute of the
image).
type: int type: int
required: false required: false
snapshot_id: snapshot_id:
description: description:
- Specifies the snapshot ID or ID of the original data disk - Specifies the snapshot ID or ID of the original data disk contained in the full-ECS image.
contained in the full-ECS image.
type: str type: str
required: false required: false
vpc_id: vpc_id:
@ -141,16 +131,12 @@ options:
required: true required: true
admin_pass: admin_pass:
description: description:
- Specifies the initial login password of the administrator account - Specifies the initial login password of the administrator account for logging in to an ECS using password authentication.
for logging in to an ECS using password authentication. The Linux The Linux administrator is root, and the Windows administrator is Administrator. Password complexity requirements,
administrator is root, and the Windows administrator is consists of 8 to 26 characters. The password must contain at least three of the following character types 'uppercase
Administrator. Password complexity requirements, consists of 8 to letters, lowercase letters, digits, and special characters (V(!@$%^-_=+[{}]:,./?))'. The password cannot contain the
26 characters. The password must contain at least three of the username or the username in reverse. The Windows ECS password cannot contain the username, the username in reverse,
following character types 'uppercase letters, lowercase letters, or more than two consecutive characters in the username.
digits, and special characters (!@$%^-_=+[{}]:,./?)'. The password
cannot contain the username or the username in reverse. The
Windows ECS password cannot contain the username, the username in
reverse, or more than two consecutive characters in the username.
type: str type: str
required: false required: false
data_volumes: data_volumes:
@ -172,15 +158,13 @@ options:
required: false required: false
description: description:
description: description:
- Specifies the description of an ECS, which is a null string by - Specifies the description of an ECS, which is a null string by default. Can contain a maximum of 85 characters. Cannot
default. Can contain a maximum of 85 characters. Cannot contain contain special characters, such as V(<) and V(>).
special characters, such as < and >.
type: str type: str
required: false required: false
eip_id: eip_id:
description: description:
- Specifies the ID of the elastic IP address assigned to the ECS. - Specifies the ID of the elastic IP address assigned to the ECS. Only elastic IP addresses in the DOWN state can be
Only elastic IP addresses in the DOWN state can be
assigned. assigned.
type: str type: str
required: false required: false
@ -191,14 +175,12 @@ options:
required: false required: false
enterprise_project_id: enterprise_project_id:
description: description:
- Specifies the ID of the enterprise project to which the ECS - Specifies the ID of the enterprise project to which the ECS belongs.
belongs.
type: str type: str
required: false required: false
security_groups: security_groups:
description: description:
- Specifies the security groups of the ECS. If this - Specifies the security groups of the ECS. If this parameter is left blank, the default security group is bound to
parameter is left blank, the default security group is bound to
the ECS by default. the ECS by default.
type: list type: list
elements: str elements: str
@ -210,8 +192,7 @@ options:
required: false required: false
server_tags: server_tags:
description: description:
- Specifies the tags of an ECS. When you create ECSs, one ECS - Specifies the tags of an ECS. When you create ECSs, one ECS supports up to 10 tags.
supports up to 10 tags.
type: dict type: dict
required: false required: false
ssh_key_name: ssh_key_name:
@ -221,21 +202,17 @@ options:
required: false required: false
user_data: user_data:
description: description:
- Specifies the user data to be injected during the ECS creation - Specifies the user data to be injected during the ECS creation process. Text, text files, and gzip files can be injected.
process. Text, text files, and gzip files can be injected. The content to be injected must be encoded with base64. The maximum size of the content to be injected (before encoding)
The content to be injected must be encoded with is 32 KB. For Linux ECSs, this parameter does not take effect when adminPass is used.
base64. The maximum size of the content to be injected (before
encoding) is 32 KB. For Linux ECSs, this parameter does not take
effect when adminPass is used.
type: str type: str
required: false required: false
extends_documentation_fragment: extends_documentation_fragment:
- community.general.hwc - community.general.hwc
- community.general.attributes - community.general.attributes
"""
''' EXAMPLES = r"""
EXAMPLES = '''
# create an ecs instance # create an ecs instance
- name: Create a vpc - name: Create a vpc
hwc_network_vpc: hwc_network_vpc:
@ -285,9 +262,9 @@ EXAMPLES = '''
vpc_id: "{{ vpc.id }}" vpc_id: "{{ vpc.id }}"
root_volume: root_volume:
volume_type: "SAS" volume_type: "SAS"
''' """
RETURN = ''' RETURN = r"""
availability_zone: availability_zone:
description: description:
- Specifies the name of the AZ where the ECS is located. - Specifies the name of the AZ where the ECS is located.
@ -305,24 +282,21 @@ RETURN = '''
returned: success returned: success
name: name:
description: description:
- Specifies the ECS name. Value requirements "Consists of 1 to 64 - Specifies the ECS name. Value requirements "Consists of 1 to 64 characters, including letters, digits, underscores (V(_)),
characters, including letters, digits, underscores (V(_)), hyphens hyphens (V(-)), periods (V(.)).".
(V(-)), periods (V(.)).".
type: str type: str
returned: success returned: success
nics: nics:
description: description:
- Specifies the NIC information of the ECS. The - Specifies the NIC information of the ECS. The network of the NIC must belong to the VPC specified by vpc_id. A maximum
network of the NIC must belong to the VPC specified by vpc_id. A of 12 NICs can be attached to an ECS.
maximum of 12 NICs can be attached to an ECS.
type: list type: list
returned: success returned: success
contains: contains:
ip_address: ip_address:
description: description:
- Specifies the IP address of the NIC. The value is an IPv4 - Specifies the IP address of the NIC. The value is an IPv4 address. Its value must be an unused IP address in the
address. Its value must be an unused IP network segment of the subnet.
address in the network segment of the subnet.
type: str type: str
returned: success returned: success
subnet_id: subnet_id:
@ -347,28 +321,22 @@ RETURN = '''
- SATA is common I/O disk type. - SATA is common I/O disk type.
- SAS is high I/O disk type. - SAS is high I/O disk type.
- SSD is ultra-high I/O disk type. - SSD is ultra-high I/O disk type.
- co-p1 is high I/O (performance-optimized I) disk type. - Co-p1 is high I/O (performance-optimized I) disk type.
- uh-l1 is ultra-high I/O (latency-optimized) disk type. - Uh-l1 is ultra-high I/O (latency-optimized) disk type.
- NOTE is For HANA, HL1, and HL2 ECSs, use co-p1 and uh-l1 - NOTE is For HANA, HL1, and HL2 ECSs, use co-p1 and uh-l1 disks. For other ECSs, do not use co-p1 or uh-l1 disks.
disks. For other ECSs, do not use co-p1 or uh-l1 disks.
type: str type: str
returned: success returned: success
size: size:
description: description:
- Specifies the system disk size, in GB. The value range is - Specifies the system disk size, in GB. The value range is 1 to 1024. The system disk size must be greater than or
1 to 1024. The system disk size must be equal to the minimum system disk size supported by the image (min_disk attribute of the image). If this parameter
greater than or equal to the minimum system disk size is not specified or is set to 0, the default system disk size is the minimum value of the system disk in the image
supported by the image (min_disk attribute of the image). (min_disk attribute of the image).
If this parameter is not specified or is set to 0, the
default system disk size is the minimum value of the
system disk in the image (min_disk attribute of the
image).
type: int type: int
returned: success returned: success
snapshot_id: snapshot_id:
description: description:
- Specifies the snapshot ID or ID of the original data disk - Specifies the snapshot ID or ID of the original data disk contained in the full-ECS image.
contained in the full-ECS image.
type: str type: str
returned: success returned: success
device: device:
@ -388,16 +356,12 @@ RETURN = '''
returned: success returned: success
admin_pass: admin_pass:
description: description:
- Specifies the initial login password of the administrator account - Specifies the initial login password of the administrator account for logging in to an ECS using password authentication.
for logging in to an ECS using password authentication. The Linux The Linux administrator is root, and the Windows administrator is Administrator. Password complexity requirements consists
administrator is root, and the Windows administrator is of 8 to 26 characters. The password must contain at least three of the following character types "uppercase letters,
Administrator. Password complexity requirements consists of 8 to lowercase letters, digits, and special characters (!@$%^-_=+[{}]:,./?)". The password cannot contain the username or
26 characters. The password must contain at least three of the the username in reverse. The Windows ECS password cannot contain the username, the username in reverse, or more than
following character types "uppercase letters, lowercase letters, two consecutive characters in the username.
digits, and special characters (!@$%^-_=+[{}]:,./?)". The password
cannot contain the username or the username in reverse. The
Windows ECS password cannot contain the username, the username in
reverse, or more than two consecutive characters in the username.
type: str type: str
returned: success returned: success
data_volumes: data_volumes:
@ -418,15 +382,13 @@ RETURN = '''
returned: success returned: success
description: description:
description: description:
- Specifies the description of an ECS, which is a null string by - Specifies the description of an ECS, which is a null string by default. Can contain a maximum of 85 characters. Cannot
default. Can contain a maximum of 85 characters. Cannot contain contain special characters, such as < and >.
special characters, such as < and >.
type: str type: str
returned: success returned: success
eip_id: eip_id:
description: description:
- Specifies the ID of the elastic IP address assigned to the ECS. - Specifies the ID of the elastic IP address assigned to the ECS. Only elastic IP addresses in the DOWN state can be assigned.
Only elastic IP addresses in the DOWN state can be assigned.
type: str type: str
returned: success returned: success
enable_auto_recovery: enable_auto_recovery:
@ -436,14 +398,13 @@ RETURN = '''
returned: success returned: success
enterprise_project_id: enterprise_project_id:
description: description:
- Specifies the ID of the enterprise project to which the ECS - Specifies the ID of the enterprise project to which the ECS belongs.
belongs.
type: str type: str
returned: success returned: success
security_groups: security_groups:
description: description:
- Specifies the security groups of the ECS. If this parameter is left - Specifies the security groups of the ECS. If this parameter is left blank, the default security group is bound to the
blank, the default security group is bound to the ECS by default. ECS by default.
type: list type: list
returned: success returned: success
server_metadata: server_metadata:
@ -453,8 +414,7 @@ RETURN = '''
returned: success returned: success
server_tags: server_tags:
description: description:
- Specifies the tags of an ECS. When you create ECSs, one ECS - Specifies the tags of an ECS. When you create ECSs, one ECS supports up to 10 tags.
supports up to 10 tags.
type: dict type: dict
returned: success returned: success
ssh_key_name: ssh_key_name:
@ -464,12 +424,9 @@ RETURN = '''
returned: success returned: success
user_data: user_data:
description: description:
- Specifies the user data to be injected during the ECS creation - Specifies the user data to be injected during the ECS creation process. Text, text files, and gzip files can be injected.
process. Text, text files, and gzip files can be injected. The content to be injected must be encoded with base64. The maximum size of the content to be injected (before encoding)
The content to be injected must be encoded with base64. The maximum is 32 KB. For Linux ECSs, this parameter does not take effect when adminPass is used.
size of the content to be injected (before encoding) is 32 KB. For
Linux ECSs, this parameter does not take effect when adminPass is
used.
type: str type: str
returned: success returned: success
config_drive: config_drive:
@ -484,9 +441,8 @@ RETURN = '''
returned: success returned: success
disk_config_type: disk_config_type:
description: description:
- Specifies the disk configuration type. MANUAL is The image - Specifies the disk configuration type. MANUAL is The image space is not expanded. AUTO is the image space of the system
space is not expanded. AUTO is the image space of the system disk disk will be expanded to be as same as the flavor.
will be expanded to be as same as the flavor.
type: str type: str
returned: success returned: success
host_name: host_name:
@ -511,12 +467,11 @@ RETURN = '''
returned: success returned: success
status: status:
description: description:
- Specifies the ECS status. Options are ACTIVE, REBOOT, HARD_REBOOT, - Specifies the ECS status. Options are ACTIVE, REBOOT, HARD_REBOOT, REBUILD, MIGRATING, BUILD, SHUTOFF, RESIZE, VERIFY_RESIZE,
REBUILD, MIGRATING, BUILD, SHUTOFF, RESIZE, VERIFY_RESIZE, ERROR, ERROR, and DELETED.
and DELETED.
type: str type: str
returned: success returned: success
''' """
from ansible_collections.community.general.plugins.module_utils.hwc_utils import ( from ansible_collections.community.general.plugins.module_utils.hwc_utils import (
Config, HwcClientException, HwcModule, are_different_dicts, build_path, Config, HwcClientException, HwcModule, are_different_dicts, build_path,

165
plugins/modules/hwc_evs_disk.py
View file

@ -12,11 +12,10 @@ __metaclass__ = type
# Documentation # Documentation
############################################################################### ###############################################################################
DOCUMENTATION = ''' DOCUMENTATION = r"""
---
module: hwc_evs_disk module: hwc_evs_disk
description: description:
- block storage management. - Block storage management.
short_description: Creates a resource of Evs/Disk in Huawei Cloud short_description: Creates a resource of Evs/Disk in Huawei Cloud
version_added: '0.2.0' version_added: '0.2.0'
author: Huawei Inc. (@huaweicloud) author: Huawei Inc. (@huaweicloud)
@ -30,7 +29,7 @@ attributes:
options: options:
state: state:
description: description:
- Whether the given object should exist in Huaweicloud Cloud. - Whether the given object should exist in Huawei Cloud.
type: str type: str
choices: ['present', 'absent'] choices: ['present', 'absent']
default: 'present' default: 'present'
@ -62,59 +61,47 @@ options:
required: true required: true
name: name:
description: description:
- Specifies the disk name. The value can contain a maximum of 255 - Specifies the disk name. The value can contain a maximum of 255 bytes.
bytes.
type: str type: str
required: true required: true
volume_type: volume_type:
description: description:
- Specifies the disk type. Currently, the value can be SSD, SAS, or - Specifies the disk type. Currently, the value can be SSD, SAS, or SATA.
SATA.
- SSD specifies the ultra-high I/O disk type. - SSD specifies the ultra-high I/O disk type.
- SAS specifies the high I/O disk type. - SAS specifies the high I/O disk type.
- SATA specifies the common I/O disk type. - SATA specifies the common I/O disk type.
- If the specified disk type is not available in the AZ, the - If the specified disk type is not available in the AZ, the disk will fail to create. If the EVS disk is created from
disk will fail to create. If the EVS disk is created from a a snapshot, the volume_type field must be the same as that of the snapshot's source disk.
snapshot, the volume_type field must be the same as that of the
snapshot's source disk.
type: str type: str
required: true required: true
backup_id: backup_id:
description: description:
- Specifies the ID of the backup that can be used to create a disk. - Specifies the ID of the backup that can be used to create a disk. This parameter is mandatory when you use a backup
This parameter is mandatory when you use a backup to create the to create the disk.
disk.
type: str type: str
required: false required: false
description: description:
description: description:
- Specifies the disk description. The value can contain a maximum - Specifies the disk description. The value can contain a maximum of 255 bytes.
of 255 bytes.
type: str type: str
required: false required: false
enable_full_clone: enable_full_clone:
description: description:
- If the disk is created from a snapshot and linked cloning needs - If the disk is created from a snapshot and linked cloning needs to be used, set this parameter to True.
to be used, set this parameter to True.
type: bool type: bool
required: false required: false
enable_scsi: enable_scsi:
description: description:
- If this parameter is set to True, the disk device type will be - If this parameter is set to True, the disk device type will be SCSI, which allows ECS OSs to directly access underlying
SCSI, which allows ECS OSs to directly access underlying storage storage media. SCSI reservation command is supported. If this parameter is set to False, the disk device type will
media. SCSI reservation command is supported. If this parameter be VBD, which supports only simple SCSI read/write commands.
is set to False, the disk device type will be VBD, which supports - If parameter enable_share is set to True and this parameter is not specified, shared SCSI disks are created. SCSI
only simple SCSI read/write commands. EVS disks cannot be created from backups, which means that this parameter cannot be True if backup_id has been specified.
- If parameter enable_share is set to True and this parameter
is not specified, shared SCSI disks are created. SCSI EVS disks
cannot be created from backups, which means that this parameter
cannot be True if backup_id has been specified.
type: bool type: bool
required: false required: false
enable_share: enable_share:
description: description:
- Specifies whether the disk is shareable. The default value is - Specifies whether the disk is shareable. The default value is False.
False.
type: bool type: bool
required: false required: false
encryption_id: encryption_id:
@ -124,43 +111,36 @@ options:
required: false required: false
enterprise_project_id: enterprise_project_id:
description: description:
- Specifies the enterprise project ID. This ID is associated with - Specifies the enterprise project ID. This ID is associated with the disk during the disk creation. If it is not specified,
the disk during the disk creation. If it is not specified, the the disk is bound to the default enterprise project.
disk is bound to the default enterprise project.
type: str type: str
required: false required: false
image_id: image_id:
description: description:
- Specifies the image ID. If this parameter is specified, the disk - Specifies the image ID. If this parameter is specified, the disk is created from an image. BMS system disks cannot
is created from an image. BMS system disks cannot be be created from BMS images.
created from BMS images.
type: str type: str
required: false required: false
size: size:
description: description:
- Specifies the disk size, in GB. Its values are as follows, System - Specifies the disk size, in GB. Its values are as follows, System disk 1 GB to 1024 GB, Data disk 10 GB to 32768 GB.
disk 1 GB to 1024 GB, Data disk 10 GB to 32768 GB. This This parameter is mandatory when you create an empty disk or use an image or a snapshot to create a disk. If you use
parameter is mandatory when you create an empty disk or use an an image or a snapshot to create a disk, the disk size must be greater than or equal to the image or snapshot size.
image or a snapshot to create a disk. If you use an image or a This parameter is optional when you use a backup to create a disk. If this parameter is not specified, the disk size
snapshot to create a disk, the disk size must be greater than or is equal to the backup size.
equal to the image or snapshot size. This parameter is optional
when you use a backup to create a disk. If this parameter is not
specified, the disk size is equal to the backup size.
type: int type: int
required: false required: false
snapshot_id: snapshot_id:
description: description:
- Specifies the snapshot ID. If this parameter is specified, the - Specifies the snapshot ID. If this parameter is specified, the disk is created from a snapshot.
disk is created from a snapshot.
type: str type: str
required: false required: false
extends_documentation_fragment: extends_documentation_fragment:
- community.general.hwc - community.general.hwc
- community.general.attributes - community.general.attributes
"""
''' EXAMPLES = r"""
EXAMPLES = '''
# test create disk # test create disk
- name: Create a disk - name: Create a disk
community.general.hwc_evs_disk: community.general.hwc_evs_disk:
@ -168,9 +148,9 @@ EXAMPLES = '''
name: "ansible_evs_disk_test" name: "ansible_evs_disk_test"
volume_type: "SATA" volume_type: "SATA"
size: 10 size: 10
''' """
RETURN = ''' RETURN = r"""
availability_zone: availability_zone:
description: description:
- Specifies the AZ where you want to create the disk. - Specifies the AZ where you want to create the disk.
@ -178,59 +158,47 @@ RETURN = '''
returned: success returned: success
name: name:
description: description:
- Specifies the disk name. The value can contain a maximum of 255 - Specifies the disk name. The value can contain a maximum of 255 bytes.
bytes.
type: str type: str
returned: success returned: success
volume_type: volume_type:
description: description:
- Specifies the disk type. Currently, the value can be SSD, SAS, or - Specifies the disk type. Currently, the value can be SSD, SAS, or SATA.
SATA.
- SSD specifies the ultra-high I/O disk type. - SSD specifies the ultra-high I/O disk type.
- SAS specifies the high I/O disk type. - SAS specifies the high I/O disk type.
- SATA specifies the common I/O disk type. - SATA specifies the common I/O disk type.
- If the specified disk type is not available in the AZ, the - If the specified disk type is not available in the AZ, the disk will fail to create. If the EVS disk is created from
disk will fail to create. If the EVS disk is created from a a snapshot, the volume_type field must be the same as that of the snapshot's source disk.
snapshot, the volume_type field must be the same as that of the
snapshot's source disk.
type: str type: str
returned: success returned: success
backup_id: backup_id:
description: description:
- Specifies the ID of the backup that can be used to create a disk. - Specifies the ID of the backup that can be used to create a disk. This parameter is mandatory when you use a backup
This parameter is mandatory when you use a backup to create the to create the disk.
disk.
type: str type: str
returned: success returned: success
description: description:
description: description:
- Specifies the disk description. The value can contain a maximum - Specifies the disk description. The value can contain a maximum of 255 bytes.
of 255 bytes.
type: str type: str
returned: success returned: success
enable_full_clone: enable_full_clone:
description: description:
- If the disk is created from a snapshot and linked cloning needs - If the disk is created from a snapshot and linked cloning needs to be used, set this parameter to True.
to be used, set this parameter to True.
type: bool type: bool
returned: success returned: success
enable_scsi: enable_scsi:
description: description:
- If this parameter is set to True, the disk device type will be - If this parameter is set to True, the disk device type will be SCSI, which allows ECS OSs to directly access underlying
SCSI, which allows ECS OSs to directly access underlying storage storage media. SCSI reservation command is supported. If this parameter is set to False, the disk device type will be
media. SCSI reservation command is supported. If this parameter VBD, which supports only simple SCSI read/write commands.
is set to False, the disk device type will be VBD, which supports - If parameter enable_share is set to True and this parameter is not specified, shared SCSI disks are created. SCSI EVS
only simple SCSI read/write commands. disks cannot be created from backups, which means that this parameter cannot be True if backup_id has been specified.
- If parameter enable_share is set to True and this parameter
is not specified, shared SCSI disks are created. SCSI EVS disks
cannot be created from backups, which means that this parameter
cannot be True if backup_id has been specified.
type: bool type: bool
returned: success returned: success
enable_share: enable_share:
description: description:
- Specifies whether the disk is shareable. The default value is - Specifies whether the disk is shareable. The default value is False.
False.
type: bool type: bool
returned: success returned: success
encryption_id: encryption_id:
@ -240,34 +208,28 @@ RETURN = '''
returned: success returned: success
enterprise_project_id: enterprise_project_id:
description: description:
- Specifies the enterprise project ID. This ID is associated with - Specifies the enterprise project ID. This ID is associated with the disk during the disk creation. If it is not specified,
the disk during the disk creation. If it is not specified, the the disk is bound to the default enterprise project.
disk is bound to the default enterprise project.
type: str type: str
returned: success returned: success
image_id: image_id:
description: description:
- Specifies the image ID. If this parameter is specified, the disk - Specifies the image ID. If this parameter is specified, the disk is created from an image. BMS system disks cannot be
is created from an image. BMS system disks cannot be
created from BMS images. created from BMS images.
type: str type: str
returned: success returned: success
size: size:
description: description:
- Specifies the disk size, in GB. Its values are as follows, System - Specifies the disk size, in GB. Its values are as follows, System disk 1 GB to 1024 GB, Data disk 10 GB to 32768 GB.
disk 1 GB to 1024 GB, Data disk 10 GB to 32768 GB. This This parameter is mandatory when you create an empty disk or use an image or a snapshot to create a disk. If you use
parameter is mandatory when you create an empty disk or use an an image or a snapshot to create a disk, the disk size must be greater than or equal to the image or snapshot size.
image or a snapshot to create a disk. If you use an image or a This parameter is optional when you use a backup to create a disk. If this parameter is not specified, the disk size
snapshot to create a disk, the disk size must be greater than or is equal to the backup size.
equal to the image or snapshot size. This parameter is optional
when you use a backup to create a disk. If this parameter is not
specified, the disk size is equal to the backup size.
type: int type: int
returned: success returned: success
snapshot_id: snapshot_id:
description: description:
- Specifies the snapshot ID. If this parameter is specified, the - Specifies the snapshot ID. If this parameter is specified, the disk is created from a snapshot.
disk is created from a snapshot.
type: str type: str
returned: success returned: success
attachments: attachments:
@ -278,8 +240,7 @@ RETURN = '''
contains: contains:
attached_at: attached_at:
description: description:
- Specifies the time when the disk was attached. Time - Specifies the time when the disk was attached. Time format is 'UTC YYYY-MM-DDTHH:MM:SS'.
format is 'UTC YYYY-MM-DDTHH:MM:SS'.
type: str type: str
returned: success returned: success
attachment_id: attachment_id:
@ -294,8 +255,7 @@ RETURN = '''
returned: success returned: success
server_id: server_id:
description: description:
- Specifies the ID of the server to which the disk is - Specifies the ID of the server to which the disk is attached.
attached.
type: str type: str
returned: success returned: success
backup_policy_id: backup_policy_id:
@ -305,8 +265,7 @@ RETURN = '''
returned: success returned: success
created_at: created_at:
description: description:
- Specifies the time when the disk was created. Time format is 'UTC - Specifies the time when the disk was created. Time format is 'UTC YYYY-MM-DDTHH:MM:SS'.
YYYY-MM-DDTHH:MM:SS'.
type: str type: str
returned: success returned: success
is_bootable: is_bootable:
@ -316,15 +275,13 @@ RETURN = '''
returned: success returned: success
is_readonly: is_readonly:
description: description:
- Specifies whether the disk is read-only or read/write. True - Specifies whether the disk is read-only or read/write. True indicates that the disk is read-only. False indicates that
indicates that the disk is read-only. False indicates that the the disk is read/write.
disk is read/write.
type: bool type: bool
returned: success returned: success
source_volume_id: source_volume_id:
description: description:
- Specifies the source disk ID. This parameter has a value if the - Specifies the source disk ID. This parameter has a value if the disk is created from a source disk.
disk is created from a source disk.
type: str type: str
returned: success returned: success
status: status:
@ -337,7 +294,7 @@ RETURN = '''
- Specifies the disk tags. - Specifies the disk tags.
type: dict type: dict
returned: success returned: success
''' """
from ansible_collections.community.general.plugins.module_utils.hwc_utils import ( from ansible_collections.community.general.plugins.module_utils.hwc_utils import (
Config, HwcClientException, HwcModule, are_different_dicts, build_path, Config, HwcClientException, HwcModule, are_different_dicts, build_path,

35
plugins/modules/hwc_network_vpc.py
View file

@ -12,8 +12,7 @@ __metaclass__ = type
# Documentation # Documentation
############################################################################### ###############################################################################
DOCUMENTATION = ''' DOCUMENTATION = r"""
---
module: hwc_network_vpc module: hwc_network_vpc
description: description:
- Represents an vpc resource. - Represents an vpc resource.
@ -30,7 +29,7 @@ attributes:
options: options:
state: state:
description: description:
- Whether the given object should exist in vpc. - Whether the given object should exist in VPC.
type: str type: str
choices: ['present', 'absent'] choices: ['present', 'absent']
default: 'present' default: 'present'
@ -62,16 +61,15 @@ options:
required: true required: true
cidr: cidr:
description: description:
- The range of available subnets in the vpc. - The range of available subnets in the VPC.
type: str type: str
required: true required: true
extends_documentation_fragment: extends_documentation_fragment:
- community.general.hwc - community.general.hwc
- community.general.attributes - community.general.attributes
"""
''' EXAMPLES = r"""
EXAMPLES = '''
- name: Create a vpc - name: Create a vpc
community.general.hwc_network_vpc: community.general.hwc_network_vpc:
identity_endpoint: "{{ identity_endpoint }}" identity_endpoint: "{{ identity_endpoint }}"
@ -83,52 +81,51 @@ EXAMPLES = '''
name: "vpc_1" name: "vpc_1"
cidr: "192.168.100.0/24" cidr: "192.168.100.0/24"
state: present state: present
''' """
RETURN = ''' RETURN = r"""
id: id:
description: description:
- the id of vpc. - The id of vpc.
type: str type: str
returned: success returned: success
name: name:
description: description:
- the name of vpc. - The name of vpc.
type: str type: str
returned: success returned: success
cidr: cidr:
description: description:
- the range of available subnets in the vpc. - The range of available subnets in the vpc.
type: str type: str
returned: success returned: success
status: status:
description: description:
- the status of vpc. - The status of vpc.
type: str type: str
returned: success returned: success
routes: routes:
description: description:
- the route information. - The route information.
type: complex type: complex
returned: success returned: success
contains: contains:
destination: destination:
description: description:
- the destination network segment of a route. - The destination network segment of a route.
type: str type: str
returned: success returned: success
next_hop: next_hop:
description: description:
- the next hop of a route. If the route type is peering, - The next hop of a route. If the route type is peering, it will provide VPC peering connection ID.
it will provide VPC peering connection ID.
type: str type: str
returned: success returned: success
enable_shared_snat: enable_shared_snat:
description: description:
- show whether the shared snat is enabled. - Show whether the shared snat is enabled.
type: bool type: bool
returned: success returned: success
''' """
############################################################################### ###############################################################################
# Imports # Imports

45
plugins/modules/hwc_smn_topic.py
View file

@ -12,12 +12,11 @@ __metaclass__ = type
# Documentation # Documentation
############################################################################### ###############################################################################
DOCUMENTATION = ''' DOCUMENTATION = r"""
---
module: hwc_smn_topic module: hwc_smn_topic
description: description:
- Represents a SMN notification topic resource. - Represents a SMN notification topic resource.
short_description: Creates a resource of SMNTopic in Huaweicloud Cloud short_description: Creates a resource of SMNTopic in Huawei Cloud
author: Huawei Inc. (@huaweicloud) author: Huawei Inc. (@huaweicloud)
requirements: requirements:
- requests >= 2.18.4 - requests >= 2.18.4
@ -30,32 +29,28 @@ attributes:
options: options:
state: state:
description: description:
- Whether the given object should exist in Huaweicloud Cloud. - Whether the given object should exist in Huawei Cloud.
type: str type: str
choices: ['present', 'absent'] choices: ['present', 'absent']
default: 'present' default: 'present'
display_name: display_name:
description: description:
- Topic display name, which is presented as the name of the email - Topic display name, which is presented as the name of the email sender in an email message. The topic display name
sender in an email message. The topic display name contains a contains a maximum of 192 bytes.
maximum of 192 bytes.
type: str type: str
required: false required: false
name: name:
description: description:
- Name of the topic to be created. The topic name is a string of 1 - Name of the topic to be created. The topic name is a string of 1 to 256 characters. It must contain upper- or lower-case
to 256 characters. It must contain upper- or lower-case letters, letters, digits, hyphens (V(-)), and underscores (V(_)), and must start with a letter or digit.
digits, hyphens (V(-)), and underscores (V(_)), and must start with a
letter or digit.
type: str type: str
required: true required: true
extends_documentation_fragment: extends_documentation_fragment:
- community.general.hwc - community.general.hwc
- community.general.attributes - community.general.attributes
"""
''' EXAMPLES = r"""
EXAMPLES = '''
- name: Create a smn topic - name: Create a smn topic
community.general.hwc_smn_topic: community.general.hwc_smn_topic:
identity_endpoint: "{{ identity_endpoint }}" identity_endpoint: "{{ identity_endpoint }}"
@ -66,9 +61,9 @@ EXAMPLES = '''
region: "{{ region }}" region: "{{ region }}"
name: "ansible_smn_topic_test" name: "ansible_smn_topic_test"
state: present state: present
''' """
RETURN = ''' RETURN = r"""
create_time: create_time:
description: description:
- Time when the topic was created. - Time when the topic was created.
@ -76,24 +71,20 @@ create_time:
type: str type: str
display_name: display_name:
description: description:
- Topic display name, which is presented as the name of the email - Topic display name, which is presented as the name of the email sender in an email message. The topic display name contains
sender in an email message. The topic display name contains a a maximum of 192 bytes.
maximum of 192 bytes.
returned: success returned: success
type: str type: str
name: name:
description: description:
- Name of the topic to be created. The topic name is a string of 1 - Name of the topic to be created. The topic name is a string of 1 to 256 characters. It must contain upper- or lower-case
to 256 characters. It must contain upper- or lower-case letters, letters, digits, hyphens (V(-)), and underscores (V(_)), and must start with a letter or digit.
digits, hyphens (V(-)), and underscores (V(_)), and must start with a
letter or digit.
returned: success returned: success
type: str type: str
push_policy: push_policy:
description: description:
- Message pushing policy. 0 indicates that the message sending - Message pushing policy. V(0) indicates that the message sending fails and the message is cached in the queue. V(1) indicates
fails and the message is cached in the queue. 1 indicates that that the failed message is discarded.
the failed message is discarded.
returned: success returned: success
type: int type: int
topic_urn: topic_urn:
@ -106,7 +97,7 @@ update_time:
- Time when the topic was updated. - Time when the topic was updated.
returned: success returned: success
type: str type: str
''' """
############################################################################### ###############################################################################
# Imports # Imports

110
plugins/modules/hwc_vpc_eip.py
View file

@ -12,12 +12,11 @@ __metaclass__ = type
# Documentation # Documentation
############################################################################### ###############################################################################
DOCUMENTATION = ''' DOCUMENTATION = r"""
---
module: hwc_vpc_eip module: hwc_vpc_eip
description: description:
- elastic ip management. - Elastic IP management.
short_description: Creates a resource of Vpc/EIP in Huawei Cloud short_description: Creates a resource of VPC/EIP in Huawei Cloud
version_added: '0.2.0' version_added: '0.2.0'
author: Huawei Inc. (@huaweicloud) author: Huawei Inc. (@huaweicloud)
requirements: requirements:
@ -63,38 +62,27 @@ options:
suboptions: suboptions:
charge_mode: charge_mode:
description: description:
- Specifies whether the bandwidth is billed by traffic or - Specifies whether the bandwidth is billed by traffic or by bandwidth size. The value can be bandwidth or traffic.
by bandwidth size. The value can be bandwidth or traffic. If this parameter is left blank or is null character string, default value bandwidth is used. For IPv6 addresses,
If this parameter is left blank or is null character the default parameter value is bandwidth outside China and is traffic in China.
string, default value bandwidth is used. For IPv6
addresses, the default parameter value is bandwidth
outside China and is traffic in China.
type: str type: str
required: true required: true
name: name:
description: description:
- Specifies the bandwidth name. The value is a string of 1 - Specifies the bandwidth name. The value is a string of 1 to 64 characters that can contain letters, digits, underscores
to 64 characters that can contain letters, digits, (V(_)), hyphens (V(-)), and periods (V(.)).
underscores (V(_)), hyphens (V(-)), and periods (V(.)).
type: str type: str
required: true required: true
size: size:
description: description:
- Specifies the bandwidth size. The value ranges from 1 - Specifies the bandwidth size. The value ranges from 1 Mbit/s to 2000 Mbit/s by default. (The specific range may
Mbit/s to 2000 Mbit/s by default. (The specific range may vary depending on the configuration in each region. You can see the bandwidth range of each region on the management
vary depending on the configuration in each region. You console.) The minimum unit for bandwidth adjustment varies depending on the bandwidth range. The details are as
can see the bandwidth range of each region on the follows.
management console.) The minimum unit for bandwidth - The minimum unit is 1 Mbit/s if the allowed bandwidth size ranges from 0 to 300 Mbit/s (with 300 Mbit/s included).
adjustment varies depending on the bandwidth range. The - The minimum unit is 50 Mbit/s if the allowed bandwidth size ranges 300 Mbit/s to 1000 Mbit/s (with 1000 Mbit/s
details are as follows.
- The minimum unit is 1 Mbit/s if the allowed bandwidth
size ranges from 0 to 300 Mbit/s (with 300 Mbit/s
included). included).
- The minimum unit is 50 Mbit/s if the allowed bandwidth - The minimum unit is 500 Mbit/s if the allowed bandwidth size is greater than 1000 Mbit/s.
size ranges 300 Mbit/s to 1000 Mbit/s (with 1000 Mbit/s
included).
- The minimum unit is 500 Mbit/s if the allowed bandwidth
size is greater than 1000 Mbit/s.
type: int type: int
required: true required: true
enterprise_project_id: enterprise_project_id:
@ -104,20 +92,17 @@ options:
required: false required: false
ip_version: ip_version:
description: description:
- The value can be 4 (IPv4 address) or 6 (IPv6 address). If this - The value can be 4 (IPv4 address) or 6 (IPv6 address). If this parameter is left blank, an IPv4 address will be assigned.
parameter is left blank, an IPv4 address will be assigned.
type: int type: int
required: false required: false
ipv4_address: ipv4_address:
description: description:
- Specifies the obtained IPv4 EIP. The system automatically assigns - Specifies the obtained IPv4 EIP. The system automatically assigns an EIP if you do not specify it.
an EIP if you do not specify it.
type: str type: str
required: false required: false
port_id: port_id:
description: description:
- Specifies the port ID. This parameter is returned only when a - Specifies the port ID. This parameter is returned only when a private IP address is bound with the EIP.
private IP address is bound with the EIP.
type: str type: str
required: false required: false
shared_bandwidth_id: shared_bandwidth_id:
@ -128,10 +113,9 @@ options:
extends_documentation_fragment: extends_documentation_fragment:
- community.general.hwc - community.general.hwc
- community.general.attributes - community.general.attributes
"""
''' EXAMPLES = r"""
EXAMPLES = '''
# create an eip and bind it to a port # create an eip and bind it to a port
- name: Create vpc - name: Create vpc
hwc_network_vpc: hwc_network_vpc:
@ -159,9 +143,9 @@ EXAMPLES = '''
name: "ansible_test_dedicated_bandwidth" name: "ansible_test_dedicated_bandwidth"
size: 1 size: 1
port_id: "{{ port.id }}" port_id: "{{ port.id }}"
''' """
RETURN = ''' RETURN = r"""
type: type:
description: description:
- Specifies the EIP type. - Specifies the EIP type.
@ -175,38 +159,26 @@ RETURN = '''
contains: contains:
charge_mode: charge_mode:
description: description:
- Specifies whether the bandwidth is billed by traffic or - Specifies whether the bandwidth is billed by traffic or by bandwidth size. The value can be bandwidth or traffic.
by bandwidth size. The value can be bandwidth or traffic. If this parameter is left blank or is null character string, default value bandwidth is used. For IPv6 addresses,
If this parameter is left blank or is null character the default parameter value is bandwidth outside China and is traffic in China.
string, default value bandwidth is used. For IPv6
addresses, the default parameter value is bandwidth
outside China and is traffic in China.
type: str type: str
returned: success returned: success
name: name:
description: description:
- Specifies the bandwidth name. The value is a string of 1 - Specifies the bandwidth name. The value is a string of 1 to 64 characters that can contain letters, digits, underscores
to 64 characters that can contain letters, digits, (V(_)), hyphens (V(-)), and periods (V(.)).
underscores (V(_)), hyphens (V(-)), and periods (V(.)).
type: str type: str
returned: success returned: success
size: size:
description: description:
- Specifies the bandwidth size. The value ranges from 1 - Specifies the bandwidth size. The value ranges from 1 Mbit/s to 2000 Mbit/s by default. (The specific range may
Mbit/s to 2000 Mbit/s by default. (The specific range may vary depending on the configuration in each region. You can see the bandwidth range of each region on the management
vary depending on the configuration in each region. You console.) The minimum unit for bandwidth adjustment varies depending on the bandwidth range. The details are as
can see the bandwidth range of each region on the follows:.
management console.) The minimum unit for bandwidth - The minimum unit is 1 Mbit/s if the allowed bandwidth size ranges from 0 to 300 Mbit/s (with 300 Mbit/s included).
adjustment varies depending on the bandwidth range. The - The minimum unit is 50 Mbit/s if the allowed bandwidth size ranges 300 Mbit/s to 1000 Mbit/s (with 1000 Mbit/s included).
details are as follows:. - The minimum unit is 500 Mbit/s if the allowed bandwidth size is greater than 1000 Mbit/s.
- The minimum unit is 1 Mbit/s if the allowed bandwidth
size ranges from 0 to 300 Mbit/s (with 300 Mbit/s
included).
- The minimum unit is 50 Mbit/s if the allowed bandwidth
size ranges 300 Mbit/s to 1000 Mbit/s (with 1000 Mbit/s
included).
- The minimum unit is 500 Mbit/s if the allowed bandwidth
size is greater than 1000 Mbit/s.
type: int type: int
returned: success returned: success
id: id:
@ -221,20 +193,17 @@ RETURN = '''
returned: success returned: success
ip_version: ip_version:
description: description:
- The value can be 4 (IPv4 address) or 6 (IPv6 address). If this - The value can be 4 (IPv4 address) or 6 (IPv6 address). If this parameter is left blank, an IPv4 address will be assigned.
parameter is left blank, an IPv4 address will be assigned.
type: int type: int
returned: success returned: success
ipv4_address: ipv4_address:
description: description:
- Specifies the obtained IPv4 EIP. The system automatically assigns - Specifies the obtained IPv4 EIP. The system automatically assigns an EIP if you do not specify it.
an EIP if you do not specify it.
type: str type: str
returned: success returned: success
port_id: port_id:
description: description:
- Specifies the port ID. This parameter is returned only when a - Specifies the port ID. This parameter is returned only when a private IP address is bound with the EIP.
private IP address is bound with the EIP.
type: str type: str
returned: success returned: success
shared_bandwidth_id: shared_bandwidth_id:
@ -254,12 +223,11 @@ RETURN = '''
returned: success returned: success
private_ip_address: private_ip_address:
description: description:
- Specifies the private IP address bound with the EIP. This - Specifies the private IP address bound with the EIP. This parameter is returned only when a private IP address is bound
parameter is returned only when a private IP address is bound
with the EIP. with the EIP.
type: str type: str
returned: success returned: success
''' """
from ansible_collections.community.general.plugins.module_utils.hwc_utils import ( from ansible_collections.community.general.plugins.module_utils.hwc_utils import (
Config, HwcClientException, HwcClientException404, HwcModule, Config, HwcClientException, HwcClientException404, HwcModule,

30
plugins/modules/hwc_vpc_peering_connect.py
View file

@ -13,12 +13,11 @@ __metaclass__ = type
# Documentation # Documentation
############################################################################### ###############################################################################
DOCUMENTATION = ''' DOCUMENTATION = r"""
---
module: hwc_vpc_peering_connect module: hwc_vpc_peering_connect
description: description:
- vpc peering management. - VPC peering management.
short_description: Creates a resource of Vpc/PeeringConnect in Huawei Cloud short_description: Creates a resource of VPC/PeeringConnect in Huawei Cloud
version_added: '0.2.0' version_added: '0.2.0'
author: Huawei Inc. (@huaweicloud) author: Huawei Inc. (@huaweicloud)
requirements: requirements:
@ -53,8 +52,7 @@ options:
required: true required: true
name: name:
description: description:
- Specifies the name of the VPC peering connection. The value can - Specifies the name of the VPC peering connection. The value can contain 1 to 64 characters.
contain 1 to 64 characters.
type: str type: str
required: true required: true
peering_vpc: peering_vpc:
@ -70,8 +68,7 @@ options:
required: true required: true
project_id: project_id:
description: description:
- Specifies the ID of the project which the peering vpc - Specifies the ID of the project which the peering vpc belongs to.
belongs to.
type: str type: str
required: false required: false
description: description:
@ -82,10 +79,9 @@ options:
extends_documentation_fragment: extends_documentation_fragment:
- community.general.hwc - community.general.hwc
- community.general.attributes - community.general.attributes
"""
''' EXAMPLES = r"""
EXAMPLES = '''
# create a peering connect # create a peering connect
- name: Create a local vpc - name: Create a local vpc
hwc_network_vpc: hwc_network_vpc:
@ -103,9 +99,9 @@ EXAMPLES = '''
name: "ansible_network_peering_test" name: "ansible_network_peering_test"
peering_vpc: peering_vpc:
vpc_id: "{{ vpc2.id }}" vpc_id: "{{ vpc2.id }}"
''' """
RETURN = ''' RETURN = r"""
local_vpc_id: local_vpc_id:
description: description:
- Specifies the ID of local VPC. - Specifies the ID of local VPC.
@ -113,8 +109,7 @@ RETURN = '''
returned: success returned: success
name: name:
description: description:
- Specifies the name of the VPC peering connection. The value can - Specifies the name of the VPC peering connection. The value can contain 1 to 64 characters.
contain 1 to 64 characters.
type: str type: str
returned: success returned: success
peering_vpc: peering_vpc:
@ -130,8 +125,7 @@ RETURN = '''
returned: success returned: success
project_id: project_id:
description: description:
- Specifies the ID of the project which the peering vpc - Specifies the ID of the project which the peering vpc belongs to.
belongs to.
type: str type: str
returned: success returned: success
description: description:
@ -139,7 +133,7 @@ RETURN = '''
- The description of vpc peering connection. - The description of vpc peering connection.
type: str type: str
returned: success returned: success
''' """
from ansible_collections.community.general.plugins.module_utils.hwc_utils import ( from ansible_collections.community.general.plugins.module_utils.hwc_utils import (
Config, HwcClientException, HwcClientException404, HwcModule, Config, HwcClientException, HwcClientException404, HwcModule,

36
plugins/modules/hwc_vpc_port.py
View file

@ -12,12 +12,11 @@ __metaclass__ = type
# Documentation # Documentation
############################################################################### ###############################################################################
DOCUMENTATION = ''' DOCUMENTATION = r"""
---
module: hwc_vpc_port module: hwc_vpc_port
description: description:
- vpc port management. - VPC port management.
short_description: Creates a resource of Vpc/Port in Huawei Cloud short_description: Creates a resource of VPC/Port in Huawei Cloud
version_added: '0.2.0' version_added: '0.2.0'
author: Huawei Inc. (@huaweicloud) author: Huawei Inc. (@huaweicloud)
requirements: requirements:
@ -64,10 +63,8 @@ options:
suboptions: suboptions:
ip_address: ip_address:
description: description:
- Specifies the IP address. It cannot set it to 0.0.0.0. - Specifies the IP address. It cannot set it to 0.0.0.0. Configure an independent security group for the port if
Configure an independent security group for the port if a a large CIDR block (subnet mask less than 24) is configured for parameter allowed_address_pairs.
large CIDR block (subnet mask less than 24) is configured
for parameter allowed_address_pairs.
type: str type: str
required: false required: false
mac_address: mac_address:
@ -99,8 +96,7 @@ options:
required: false required: false
name: name:
description: description:
- Specifies the port name. The value can contain no more than 255 - Specifies the port name. The value can contain no more than 255 characters.
characters.
type: str type: str
required: false required: false
security_groups: security_groups:
@ -112,10 +108,9 @@ options:
extends_documentation_fragment: extends_documentation_fragment:
- community.general.hwc - community.general.hwc
- community.general.attributes - community.general.attributes
"""
''' EXAMPLES = r"""
EXAMPLES = '''
# create a port # create a port
- name: Create vpc - name: Create vpc
hwc_network_vpc: hwc_network_vpc:
@ -134,9 +129,9 @@ EXAMPLES = '''
community.general.hwc_vpc_port: community.general.hwc_vpc_port:
subnet_id: "{{ subnet.id }}" subnet_id: "{{ subnet.id }}"
ip_address: "192.168.100.33" ip_address: "192.168.100.33"
''' """
RETURN = ''' RETURN = r"""
subnet_id: subnet_id:
description: description:
- Specifies the ID of the subnet to which the port belongs. - Specifies the ID of the subnet to which the port belongs.
@ -155,10 +150,8 @@ RETURN = '''
contains: contains:
ip_address: ip_address:
description: description:
- Specifies the IP address. It cannot set it to 0.0.0.0. - Specifies the IP address. It cannot set it to 0.0.0.0. Configure an independent security group for the port if a
Configure an independent security group for the port if a large CIDR block (subnet mask less than 24) is configured for parameter allowed_address_pairs.
large CIDR block (subnet mask less than 24) is configured
for parameter allowed_address_pairs.
type: str type: str
returned: success returned: success
mac_address: mac_address:
@ -189,8 +182,7 @@ RETURN = '''
returned: success returned: success
name: name:
description: description:
- Specifies the port name. The value can contain no more than 255 - Specifies the port name. The value can contain no more than 255 characters.
characters.
type: str type: str
returned: success returned: success
security_groups: security_groups:
@ -203,7 +195,7 @@ RETURN = '''
- Specifies the port MAC address. - Specifies the port MAC address.
type: str type: str
returned: success returned: success
''' """
from ansible_collections.community.general.plugins.module_utils.hwc_utils import ( from ansible_collections.community.general.plugins.module_utils.hwc_utils import (
Config, HwcClientException, HwcClientException404, HwcModule, Config, HwcClientException, HwcClientException404, HwcModule,

45
plugins/modules/hwc_vpc_private_ip.py
View file

@ -12,15 +12,15 @@ __metaclass__ = type
# Documentation # Documentation
############################################################################### ###############################################################################
DOCUMENTATION = ''' DOCUMENTATION = r"""
---
module: hwc_vpc_private_ip module: hwc_vpc_private_ip
description: description:
- vpc private ip management. - VPC private IP management.
short_description: Creates a resource of Vpc/PrivateIP in Huawei Cloud short_description: Creates a resource of VPC/PrivateIP in Huawei Cloud
notes: notes:
- If O(id) option is provided, it takes precedence over O(subnet_id), O(ip_address) for private ip selection. - If O(id) option is provided, it takes precedence over O(subnet_id), O(ip_address) for private IP selection.
- O(subnet_id), O(ip_address) are used for private ip selection. If more than one private ip with this options exists, execution is aborted. - O(subnet_id), O(ip_address) are used for private IP selection. If more than one private IP with this options exists, execution
is aborted.
- No parameter support updating. If one of option is changed, the module will create a new resource. - No parameter support updating. If one of option is changed, the module will create a new resource.
version_added: '0.2.0' version_added: '0.2.0'
author: Huawei Inc. (@huaweicloud) author: Huawei Inc. (@huaweicloud)
@ -40,26 +40,23 @@ options:
default: 'present' default: 'present'
subnet_id: subnet_id:
description: description:
- Specifies the ID of the subnet from which IP addresses are - Specifies the ID of the subnet from which IP addresses are assigned. Cannot be changed after creating the private
assigned. Cannot be changed after creating the private ip. IP.
type: str type: str
required: true required: true
ip_address: ip_address:
description: description:
- Specifies the target IP address. The value can be an available IP - Specifies the target IP address. The value can be an available IP address in the subnet. If it is not specified, the
address in the subnet. If it is not specified, the system system automatically assigns an IP address. Cannot be changed after creating the private IP.
automatically assigns an IP address. Cannot be changed after
creating the private ip.
type: str type: str
required: false required: false
extends_documentation_fragment: extends_documentation_fragment:
- community.general.hwc - community.general.hwc
- community.general.attributes - community.general.attributes
"""
''' EXAMPLES = r"""
# create a private IP
EXAMPLES = '''
# create a private ip
- name: Create vpc - name: Create vpc
hwc_network_vpc: hwc_network_vpc:
cidr: "192.168.100.0/24" cidr: "192.168.100.0/24"
@ -73,27 +70,25 @@ EXAMPLES = '''
vpc_id: "{{ vpc.id }}" vpc_id: "{{ vpc.id }}"
cidr: "192.168.100.0/26" cidr: "192.168.100.0/26"
register: subnet register: subnet
- name: Create a private ip - name: Create a private IP
community.general.hwc_vpc_private_ip: community.general.hwc_vpc_private_ip:
subnet_id: "{{ subnet.id }}" subnet_id: "{{ subnet.id }}"
ip_address: "192.168.100.33" ip_address: "192.168.100.33"
''' """
RETURN = ''' RETURN = r"""
subnet_id: subnet_id:
description: description:
- Specifies the ID of the subnet from which IP addresses are - Specifies the ID of the subnet from which IP addresses are assigned.
assigned.
type: str type: str
returned: success returned: success
ip_address: ip_address:
description: description:
- Specifies the target IP address. The value can be an available IP - Specifies the target IP address. The value can be an available IP address in the subnet. If it is not specified, the
address in the subnet. If it is not specified, the system system automatically assigns an IP address.
automatically assigns an IP address.
type: str type: str
returned: success returned: success
''' """
from ansible_collections.community.general.plugins.module_utils.hwc_utils import ( from ansible_collections.community.general.plugins.module_utils.hwc_utils import (
Config, HwcClientException, HwcModule, are_different_dicts, build_path, Config, HwcClientException, HwcModule, are_different_dicts, build_path,

21
plugins/modules/hwc_vpc_route.py
View file

@ -12,15 +12,15 @@ __metaclass__ = type
# Documentation # Documentation
############################################################################### ###############################################################################
DOCUMENTATION = ''' DOCUMENTATION = r"""
---
module: hwc_vpc_route module: hwc_vpc_route
description: description:
- vpc route management. - VPC route management.
short_description: Creates a resource of Vpc/Route in Huawei Cloud short_description: Creates a resource of VPC/Route in Huawei Cloud
notes: notes:
- If O(id) option is provided, it takes precedence over O(destination), O(vpc_id), O(type), and O(next_hop) for route selection. - If O(id) option is provided, it takes precedence over O(destination), O(vpc_id), O(type), and O(next_hop) for route selection.
- O(destination), O(vpc_id), O(type) and O(next_hop) are used for route selection. If more than one route with this options exists, execution is aborted. - O(destination), O(vpc_id), O(type) and O(next_hop) are used for route selection. If more than one route with this options
exists, execution is aborted.
- No parameter support updating. If one of option is changed, the module will create a new resource. - No parameter support updating. If one of option is changed, the module will create a new resource.
version_added: '0.2.0' version_added: '0.2.0'
author: Huawei Inc. (@huaweicloud) author: Huawei Inc. (@huaweicloud)
@ -62,10 +62,9 @@ options:
extends_documentation_fragment: extends_documentation_fragment:
- community.general.hwc - community.general.hwc
- community.general.attributes - community.general.attributes
"""
''' EXAMPLES = r"""
EXAMPLES = '''
# create a peering connect # create a peering connect
- name: Create a local vpc - name: Create a local vpc
hwc_network_vpc: hwc_network_vpc:
@ -91,9 +90,9 @@ EXAMPLES = '''
vpc_id: "{{ vpc1.id }}" vpc_id: "{{ vpc1.id }}"
destination: "192.168.0.0/16" destination: "192.168.0.0/16"
next_hop: "{{ connect.id }}" next_hop: "{{ connect.id }}"
''' """
RETURN = ''' RETURN = r"""
id: id:
description: description:
- UUID of the route. - UUID of the route.
@ -119,7 +118,7 @@ RETURN = '''
- Specifies the type of route. - Specifies the type of route.
type: str type: str
returned: success returned: success
''' """
from ansible_collections.community.general.plugins.module_utils.hwc_utils import ( from ansible_collections.community.general.plugins.module_utils.hwc_utils import (
Config, HwcClientException, HwcModule, are_different_dicts, build_path, Config, HwcClientException, HwcModule, are_different_dicts, build_path,

89
plugins/modules/hwc_vpc_security_group.py
View file

@ -12,20 +12,17 @@ __metaclass__ = type
# Documentation # Documentation
############################################################################### ###############################################################################
DOCUMENTATION = ''' DOCUMENTATION = r"""
---
module: hwc_vpc_security_group module: hwc_vpc_security_group
description: description:
- vpc security group management. - VPC security group management.
short_description: Creates a resource of Vpc/SecurityGroup in Huawei Cloud short_description: Creates a resource of VPC/SecurityGroup in Huawei Cloud
notes: notes:
- If O(id) option is provided, it takes precedence over O(name), - If O(id) option is provided, it takes precedence over O(name), O(enterprise_project_id), and O(vpc_id) for security group
O(enterprise_project_id), and O(vpc_id) for security group selection. selection.
- O(name), O(enterprise_project_id) and O(vpc_id) are used for security - O(name), O(enterprise_project_id) and O(vpc_id) are used for security group selection. If more than one security group
group selection. If more than one security group with this options exists, with this options exists, execution is aborted.
execution is aborted. - No parameter support updating. If one of option is changed, the module will create a new resource.
- No parameter support updating. If one of option is changed, the module
will create a new resource.
version_added: '0.2.0' version_added: '0.2.0'
author: Huawei Inc. (@huaweicloud) author: Huawei Inc. (@huaweicloud)
requirements: requirements:
@ -44,81 +41,70 @@ options:
default: 'present' default: 'present'
name: name:
description: description:
- Specifies the security group name. The value is a string of 1 to - Specifies the security group name. The value is a string of 1 to 64 characters that can contain letters, digits, underscores
64 characters that can contain letters, digits, underscores (V(_)), (V(_)), hyphens (V(-)), and periods (V(.)).
hyphens (V(-)), and periods (V(.)).
type: str type: str
required: true required: true
enterprise_project_id: enterprise_project_id:
description: description:
- Specifies the enterprise project ID. When creating a security - Specifies the enterprise project ID. When creating a security group, associate the enterprise project ID with the
group, associate the enterprise project ID with the security security group.s.
group.s
type: str type: str
required: false required: false
vpc_id: vpc_id:
description: description:
- Specifies the resource ID of the VPC to which the security group - Specifies the resource ID of the VPC to which the security group belongs.
belongs.
type: str type: str
required: false required: false
extends_documentation_fragment: extends_documentation_fragment:
- community.general.hwc - community.general.hwc
- community.general.attributes - community.general.attributes
"""
''' EXAMPLES = r"""
EXAMPLES = '''
# create a security group # create a security group
- name: Create a security group - name: Create a security group
community.general.hwc_vpc_security_group: community.general.hwc_vpc_security_group:
name: "ansible_network_security_group_test" name: "ansible_network_security_group_test"
''' """
RETURN = ''' RETURN = r"""
name: name:
description: description:
- Specifies the security group name. The value is a string of 1 to - Specifies the security group name. The value is a string of 1 to 64 characters that can contain letters, digits, underscores
64 characters that can contain letters, digits, underscores (V(_)), (V(_)), hyphens (V(-)), and periods (V(.)).
hyphens (V(-)), and periods (V(.)).
type: str type: str
returned: success returned: success
enterprise_project_id: enterprise_project_id:
description: description:
- Specifies the enterprise project ID. When creating a security - Specifies the enterprise project ID. When creating a security group, associate the enterprise project ID with the security
group, associate the enterprise project ID with the security
group. group.
type: str type: str
returned: success returned: success
vpc_id: vpc_id:
description: description:
- Specifies the resource ID of the VPC to which the security group - Specifies the resource ID of the VPC to which the security group belongs.
belongs.
type: str type: str
returned: success returned: success
rules: rules:
description: description:
- Specifies the security group rule, which ensures that resources - Specifies the security group rule, which ensures that resources in the security group can communicate with one another.
in the security group can communicate with one another.
type: complex type: complex
returned: success returned: success
contains: contains:
description: description:
description: description:
- Provides supplementary information about the security - Provides supplementary information about the security group rule.
group rule.
type: str type: str
returned: success returned: success
direction: direction:
description: description:
- Specifies the direction of access control. The value can - Specifies the direction of access control. The value can be egress or ingress.
be egress or ingress.
type: str type: str
returned: success returned: success
ethertype: ethertype:
description: description:
- Specifies the IP protocol version. The value can be IPv4 - Specifies the IP protocol version. The value can be IPv4 or IPv6.
or IPv6.
type: str type: str
returned: success returned: success
id: id:
@ -128,24 +114,20 @@ RETURN = '''
returned: success returned: success
port_range_max: port_range_max:
description: description:
- Specifies the end port number. The value ranges from 1 to - Specifies the end port number. The value ranges from 1 to 65535. If the protocol is not icmp, the value cannot be
65535. If the protocol is not icmp, the value cannot be smaller than the port_range_min value. An empty value indicates all ports.
smaller than the port_range_min value. An empty value
indicates all ports.
type: int type: int
returned: success returned: success
port_range_min: port_range_min:
description: description:
- Specifies the start port number. The value ranges from 1 - Specifies the start port number. The value ranges from 1 to 65535. The value cannot be greater than the port_range_max
to 65535. The value cannot be greater than the value. An empty value indicates all ports.
port_range_max value. An empty value indicates all ports.
type: int type: int
returned: success returned: success
protocol: protocol:
description: description:
- Specifies the protocol type. The value can be icmp, tcp, - Specifies the protocol type. The value can be icmp, tcp, udp, or others. If the parameter is left blank, the security
udp, or others. If the parameter is left blank, the group supports all protocols.
security group supports all protocols.
type: str type: str
returned: success returned: success
remote_address_group_id: remote_address_group_id:
@ -160,14 +142,11 @@ RETURN = '''
returned: success returned: success
remote_ip_prefix: remote_ip_prefix:
description: description:
- Specifies the remote IP address. If the access control - Specifies the remote IP address. If the access control direction is set to egress, the parameter specifies the source
direction is set to egress, the parameter specifies the IP address. If the access control direction is set to ingress, the parameter specifies the destination IP address.
source IP address. If the access control direction is set
to ingress, the parameter specifies the destination IP
address.
type: str type: str
returned: success returned: success
''' """
from ansible_collections.community.general.plugins.module_utils.hwc_utils import ( from ansible_collections.community.general.plugins.module_utils.hwc_utils import (
Config, HwcClientException, HwcModule, are_different_dicts, build_path, Config, HwcClientException, HwcModule, are_different_dicts, build_path,

113
plugins/modules/hwc_vpc_security_group_rule.py
View file

@ -12,20 +12,16 @@ __metaclass__ = type
# Documentation # Documentation
############################################################################### ###############################################################################
DOCUMENTATION = ''' DOCUMENTATION = r"""
---
module: hwc_vpc_security_group_rule module: hwc_vpc_security_group_rule
description: description:
- vpc security group management. - VPC security group management.
short_description: Creates a resource of Vpc/SecurityGroupRule in Huawei Cloud short_description: Creates a resource of VPC/SecurityGroupRule in Huawei Cloud
notes: notes:
- If O(id) option is provided, it takes precedence over - If O(id) option is provided, it takes precedence over O(security_group_id) for security group rule selection.
O(security_group_id) for security group rule selection. - O(security_group_id) is used for security group rule selection. If more than one security group rule with this options
- O(security_group_id) is used for security group rule selection. If more exists, execution is aborted.
than one security group rule with this options exists, execution is - No parameter support updating. If one of option is changed, the module will create a new resource.
aborted.
- No parameter support updating. If one of option is changed, the module
will create a new resource.
version_added: '0.2.0' version_added: '0.2.0'
author: Huawei Inc. (@huaweicloud) author: Huawei Inc. (@huaweicloud)
requirements: requirements:
@ -44,73 +40,62 @@ options:
default: 'present' default: 'present'
direction: direction:
description: description:
- Specifies the direction of access control. The value can be - Specifies the direction of access control. The value can be egress or ingress.
egress or ingress.
type: str type: str
required: true required: true
security_group_id: security_group_id:
description: description:
- Specifies the security group rule ID, which uniquely identifies - Specifies the security group rule ID, which uniquely identifies the security group rule.
the security group rule.
type: str type: str
required: true required: true
description: description:
description: description:
- Provides supplementary information about the security group rule. - Provides supplementary information about the security group rule. The value is a string of no more than 255 characters
The value is a string of no more than 255 characters that can that can contain letters and digits.
contain letters and digits.
type: str type: str
required: false required: false
ethertype: ethertype:
description: description:
- Specifies the IP protocol version. The value can be IPv4 or IPv6. - Specifies the IP protocol version. The value can be IPv4 or IPv6. If you do not set this parameter, IPv4 is used by
If you do not set this parameter, IPv4 is used by default. default.
type: str type: str
required: false required: false
port_range_max: port_range_max:
description: description:
- Specifies the end port number. The value ranges from 1 to 65535. - Specifies the end port number. The value ranges from 1 to 65535. If the protocol is not icmp, the value cannot be
If the protocol is not icmp, the value cannot be smaller than the smaller than the port_range_min value. An empty value indicates all ports.
port_range_min value. An empty value indicates all ports.
type: int type: int
required: false required: false
port_range_min: port_range_min:
description: description:
- Specifies the start port number. The value ranges from 1 to - Specifies the start port number. The value ranges from 1 to 65535. The value cannot be greater than the port_range_max
65535. The value cannot be greater than the port_range_max value. value. An empty value indicates all ports.
An empty value indicates all ports.
type: int type: int
required: false required: false
protocol: protocol:
description: description:
- Specifies the protocol type. The value can be icmp, tcp, or udp. - Specifies the protocol type. The value can be icmp, tcp, or udp. If the parameter is left blank, the security group
If the parameter is left blank, the security group supports all supports all protocols.
protocols.
type: str type: str
required: false required: false
remote_group_id: remote_group_id:
description: description:
- Specifies the ID of the peer security group. The value is - Specifies the ID of the peer security group. The value is exclusive with parameter remote_ip_prefix.
exclusive with parameter remote_ip_prefix.
type: str type: str
required: false required: false
remote_ip_prefix: remote_ip_prefix:
description: description:
- Specifies the remote IP address. If the access control direction - Specifies the remote IP address. If the access control direction is set to egress, the parameter specifies the source
is set to egress, the parameter specifies the source IP address. IP address. If the access control direction is set to ingress, the parameter specifies the destination IP address.
If the access control direction is set to ingress, the parameter The value can be in the CIDR format or IP addresses. The parameter is exclusive with parameter remote_group_id.
specifies the destination IP address. The value can be in the
CIDR format or IP addresses. The parameter is exclusive with
parameter remote_group_id.
type: str type: str
required: false required: false
extends_documentation_fragment: extends_documentation_fragment:
- community.general.hwc - community.general.hwc
- community.general.attributes - community.general.attributes
"""
''' EXAMPLES = r"""
EXAMPLES = '''
# create a security group rule # create a security group rule
- name: Create a security group - name: Create a security group
hwc_vpc_security_group: hwc_vpc_security_group:
@ -125,72 +110,62 @@ EXAMPLES = '''
security_group_id: "{{ sg.id }}" security_group_id: "{{ sg.id }}"
port_range_min: 22 port_range_min: 22
remote_ip_prefix: "0.0.0.0/0" remote_ip_prefix: "0.0.0.0/0"
''' """
RETURN = ''' RETURN = r"""
direction: direction:
description: description:
- Specifies the direction of access control. The value can be - Specifies the direction of access control. The value can be egress or ingress.
egress or ingress.
type: str type: str
returned: success returned: success
security_group_id: security_group_id:
description: description:
- Specifies the security group rule ID, which uniquely identifies - Specifies the security group rule ID, which uniquely identifies the security group rule.
the security group rule.
type: str type: str
returned: success returned: success
description: description:
description: description:
- Provides supplementary information about the security group rule. - Provides supplementary information about the security group rule. The value is a string of no more than 255 characters
The value is a string of no more than 255 characters that can that can contain letters and digits.
contain letters and digits.
type: str type: str
returned: success returned: success
ethertype: ethertype:
description: description:
- Specifies the IP protocol version. The value can be IPv4 or IPv6. - Specifies the IP protocol version. The value can be IPv4 or IPv6. If you do not set this parameter, IPv4 is used by
If you do not set this parameter, IPv4 is used by default. default.
type: str type: str
returned: success returned: success
port_range_max: port_range_max:
description: description:
- Specifies the end port number. The value ranges from 1 to 65535. - Specifies the end port number. The value ranges from 1 to 65535. If the protocol is not icmp, the value cannot be smaller
If the protocol is not icmp, the value cannot be smaller than the than the port_range_min value. An empty value indicates all ports.
port_range_min value. An empty value indicates all ports.
type: int type: int
returned: success returned: success
port_range_min: port_range_min:
description: description:
- Specifies the start port number. The value ranges from 1 to - Specifies the start port number. The value ranges from 1 to 65535. The value cannot be greater than the port_range_max
65535. The value cannot be greater than the port_range_max value. value. An empty value indicates all ports.
An empty value indicates all ports.
type: int type: int
returned: success returned: success
protocol: protocol:
description: description:
- Specifies the protocol type. The value can be icmp, tcp, or udp. - Specifies the protocol type. The value can be icmp, tcp, or udp. If the parameter is left blank, the security group
If the parameter is left blank, the security group supports all supports all protocols.
protocols.
type: str type: str
returned: success returned: success
remote_group_id: remote_group_id:
description: description:
- Specifies the ID of the peer security group. The value is - Specifies the ID of the peer security group. The value is exclusive with parameter remote_ip_prefix.
exclusive with parameter remote_ip_prefix.
type: str type: str
returned: success returned: success
remote_ip_prefix: remote_ip_prefix:
description: description:
- Specifies the remote IP address. If the access control direction - Specifies the remote IP address. If the access control direction is set to egress, the parameter specifies the source
is set to egress, the parameter specifies the source IP address. IP address. If the access control direction is set to ingress, the parameter specifies the destination IP address. The
If the access control direction is set to ingress, the parameter value can be in the CIDR format or IP addresses. The parameter is exclusive with parameter remote_group_id.
specifies the destination IP address. The value can be in the
CIDR format or IP addresses. The parameter is exclusive with
parameter remote_group_id.
type: str type: str
returned: success returned: success
''' """
from ansible_collections.community.general.plugins.module_utils.hwc_utils import ( from ansible_collections.community.general.plugins.module_utils.hwc_utils import (
Config, HwcClientException, HwcModule, are_different_dicts, build_path, Config, HwcClientException, HwcModule, are_different_dicts, build_path,

73
plugins/modules/hwc_vpc_subnet.py
View file

@ -12,12 +12,11 @@ __metaclass__ = type
# Documentation # Documentation
############################################################################### ###############################################################################
DOCUMENTATION = ''' DOCUMENTATION = r"""
---
module: hwc_vpc_subnet module: hwc_vpc_subnet
description: description:
- subnet management. - Subnet management.
short_description: Creates a resource of Vpc/Subnet in Huawei Cloud short_description: Creates a resource of VPC/Subnet in Huawei Cloud
version_added: '0.2.0' version_added: '0.2.0'
author: Huawei Inc. (@huaweicloud) author: Huawei Inc. (@huaweicloud)
requirements: requirements:
@ -52,59 +51,51 @@ options:
default: '15m' default: '15m'
cidr: cidr:
description: description:
- Specifies the subnet CIDR block. The value must be within the VPC - Specifies the subnet CIDR block. The value must be within the VPC CIDR block and be in CIDR format. The subnet mask
CIDR block and be in CIDR format. The subnet mask cannot be cannot be greater than 28. Cannot be changed after creating the subnet.
greater than 28. Cannot be changed after creating the subnet.
type: str type: str
required: true required: true
gateway_ip: gateway_ip:
description: description:
- Specifies the gateway of the subnet. The value must be an IP - Specifies the gateway of the subnet. The value must be an IP address in the subnet. Cannot be changed after creating
address in the subnet. Cannot be changed after creating the subnet. the subnet.
type: str type: str
required: true required: true
name: name:
description: description:
- Specifies the subnet name. The value is a string of 1 to 64 - Specifies the subnet name. The value is a string of 1 to 64 characters that can contain letters, digits, underscores
characters that can contain letters, digits, underscores (V(_)), (V(_)), hyphens (V(-)), and periods (V(.)).
hyphens (V(-)), and periods (V(.)).
type: str type: str
required: true required: true
vpc_id: vpc_id:
description: description:
- Specifies the ID of the VPC to which the subnet belongs. Cannot - Specifies the ID of the VPC to which the subnet belongs. Cannot be changed after creating the subnet.
be changed after creating the subnet.
type: str type: str
required: true required: true
availability_zone: availability_zone:
description: description:
- Specifies the AZ to which the subnet belongs. Cannot be changed - Specifies the AZ to which the subnet belongs. Cannot be changed after creating the subnet.
after creating the subnet.
type: str type: str
required: false required: false
dhcp_enable: dhcp_enable:
description: description:
- Specifies whether DHCP is enabled for the subnet. The value can - Specifies whether DHCP is enabled for the subnet. The value can be true (enabled) or false(disabled), and default
be true (enabled) or false(disabled), and default value is true. value is true. If this parameter is set to false, newly created ECSs cannot obtain IP addresses, and usernames and
If this parameter is set to false, newly created ECSs cannot passwords cannot be injected using Cloud-init.
obtain IP addresses, and usernames and passwords cannot be
injected using Cloud-init.
type: bool type: bool
required: false required: false
dns_address: dns_address:
description: description:
- Specifies the DNS server addresses for subnet. The address - Specifies the DNS server addresses for subnet. The address in the head will be used first.
in the head will be used first.
type: list type: list
elements: str elements: str
required: false required: false
extends_documentation_fragment: extends_documentation_fragment:
- community.general.hwc - community.general.hwc
- community.general.attributes - community.general.attributes
"""
''' EXAMPLES = r"""
EXAMPLES = '''
# create subnet # create subnet
- name: Create vpc - name: Create vpc
hwc_network_vpc: hwc_network_vpc:
@ -118,27 +109,24 @@ EXAMPLES = '''
gateway_ip: "192.168.100.32" gateway_ip: "192.168.100.32"
name: "ansible_network_subnet_test" name: "ansible_network_subnet_test"
dhcp_enable: true dhcp_enable: true
''' """
RETURN = ''' RETURN = r"""
cidr: cidr:
description: description:
- Specifies the subnet CIDR block. The value must be within the VPC - Specifies the subnet CIDR block. The value must be within the VPC CIDR block and be in CIDR format. The subnet mask
CIDR block and be in CIDR format. The subnet mask cannot be cannot be greater than 28.
greater than 28.
type: str type: str
returned: success returned: success
gateway_ip: gateway_ip:
description: description:
- Specifies the gateway of the subnet. The value must be an IP - Specifies the gateway of the subnet. The value must be an IP address in the subnet.
address in the subnet.
type: str type: str
returned: success returned: success
name: name:
description: description:
- Specifies the subnet name. The value is a string of 1 to 64 - Specifies the subnet name. The value is a string of 1 to 64 characters that can contain letters, digits, underscores
characters that can contain letters, digits, underscores (V(_)), (V(_)), hyphens (V(-)), and periods (V(.)).
hyphens (V(-)), and periods (V(.)).
type: str type: str
returned: success returned: success
vpc_id: vpc_id:
@ -153,20 +141,17 @@ RETURN = '''
returned: success returned: success
dhcp_enable: dhcp_enable:
description: description:
- Specifies whether DHCP is enabled for the subnet. The value can - Specifies whether DHCP is enabled for the subnet. The value can be true (enabled) or false(disabled), and default value
be true (enabled) or false(disabled), and default value is true. is true. If this parameter is set to false, newly created ECSs cannot obtain IP addresses, and usernames and passwords
If this parameter is set to false, newly created ECSs cannot cannot be injected using Cloud-init.
obtain IP addresses, and usernames and passwords cannot be
injected using Cloud-init.
type: bool type: bool
returned: success returned: success
dns_address: dns_address:
description: description:
- Specifies the DNS server addresses for subnet. The address - Specifies the DNS server addresses for subnet. The address in the head will be used first.
in the head will be used first.
type: list type: list
returned: success returned: success
''' """
from ansible_collections.community.general.plugins.module_utils.hwc_utils import ( from ansible_collections.community.general.plugins.module_utils.hwc_utils import (
Config, HwcClientException, HwcClientException404, HwcModule, Config, HwcClientException, HwcClientException404, HwcModule,