mirror of
https://github.com/ansible-collections/community.general.git
synced 2025-06-03 14:59:09 -07:00
[PR #9382/88330575 backport][stable-10] [oc ... onep]*.py: normalize docs (#9408)
[oc ... onep]*.py: normalize docs (#9382)
* [oc ... onep]*.py: normalize docs
* Apply suggestions from code review
Co-authored-by: Felix Fontein <felix@fontein.de>
---------
Co-authored-by: Felix Fontein <felix@fontein.de>
(cherry picked from commit 88330575ff
)
Co-authored-by: Alexei Znamensky <103110+russoz@users.noreply.github.com>
This commit is contained in:
parent
92a07f1794
commit
d3badc6d43
21 changed files with 1807 additions and 1934 deletions
|
@ -8,49 +8,46 @@ from __future__ import absolute_import, division, print_function
|
|||
|
||||
__metaclass__ = type
|
||||
|
||||
DOCUMENTATION = '''
|
||||
---
|
||||
DOCUMENTATION = r"""
|
||||
module: oci_vcn
|
||||
short_description: Manage Virtual Cloud Networks(VCN) in OCI
|
||||
description:
|
||||
- This module allows the user to create, delete and update virtual cloud networks(VCNs) in OCI.
|
||||
The complete Oracle Cloud Infrastructure Ansible Modules can be downloaded from
|
||||
U(https://github.com/oracle/oci-ansible-modules/releases).
|
||||
- This module allows the user to create, delete and update virtual cloud networks(VCNs) in OCI. The complete Oracle Cloud Infrastructure Ansible
|
||||
Modules can be downloaded from U(https://github.com/oracle/oci-ansible-modules/releases).
|
||||
attributes:
|
||||
check_mode:
|
||||
support: none
|
||||
diff_mode:
|
||||
support: none
|
||||
check_mode:
|
||||
support: none
|
||||
diff_mode:
|
||||
support: none
|
||||
options:
|
||||
cidr_block:
|
||||
description: The CIDR IP address block of the VCN. Required when creating a VCN with O(state=present).
|
||||
type: str
|
||||
required: false
|
||||
compartment_id:
|
||||
description: The OCID of the compartment to contain the VCN. Required when creating a VCN with O(state=present).
|
||||
This option is mutually exclusive with O(vcn_id).
|
||||
type: str
|
||||
display_name:
|
||||
description: A user-friendly name. Does not have to be unique, and it's changeable.
|
||||
type: str
|
||||
aliases: [ 'name' ]
|
||||
dns_label:
|
||||
description: A DNS label for the VCN, used in conjunction with the VNIC's hostname and subnet's DNS label to
|
||||
form a fully qualified domain name (FQDN) for each VNIC within this subnet (for example,
|
||||
bminstance-1.subnet123.vcn1.oraclevcn.com). Not required to be unique, but it's a best practice
|
||||
to set unique DNS labels for VCNs in your tenancy. Must be an alphanumeric string that begins
|
||||
with a letter. The value cannot be changed.
|
||||
type: str
|
||||
state:
|
||||
description: Create or update a VCN with O(state=present). Use O(state=absent) to delete a VCN.
|
||||
type: str
|
||||
default: present
|
||||
choices: ['present', 'absent']
|
||||
vcn_id:
|
||||
description: The OCID of the VCN. Required when deleting a VCN with O(state=absent) or updating a VCN
|
||||
with O(state=present). This option is mutually exclusive with O(compartment_id).
|
||||
type: str
|
||||
aliases: [ 'id' ]
|
||||
cidr_block:
|
||||
description: The CIDR IP address block of the VCN. Required when creating a VCN with O(state=present).
|
||||
type: str
|
||||
required: false
|
||||
compartment_id:
|
||||
description: The OCID of the compartment to contain the VCN. Required when creating a VCN with O(state=present). This option is mutually exclusive
|
||||
with O(vcn_id).
|
||||
type: str
|
||||
display_name:
|
||||
description: A user-friendly name. Does not have to be unique, and it's changeable.
|
||||
type: str
|
||||
aliases: ['name']
|
||||
dns_label:
|
||||
description: A DNS label for the VCN, used in conjunction with the VNIC's hostname and subnet's DNS label to form a fully qualified domain
|
||||
name (FQDN) for each VNIC within this subnet (for example, V(bminstance-1.subnet123.vcn1.oraclevcn.com)). Not required to be unique, but it's
|
||||
a best practice to set unique DNS labels for VCNs in your tenancy. Must be an alphanumeric string that begins with a letter. The value cannot
|
||||
be changed.
|
||||
type: str
|
||||
state:
|
||||
description: Create or update a VCN with O(state=present). Use O(state=absent) to delete a VCN.
|
||||
type: str
|
||||
default: present
|
||||
choices: ['present', 'absent']
|
||||
vcn_id:
|
||||
description: The OCID of the VCN. Required when deleting a VCN with O(state=absent) or updating a VCN with O(state=present). This option is
|
||||
mutually exclusive with O(compartment_id).
|
||||
type: str
|
||||
aliases: ['id']
|
||||
author: "Rohit Chaware (@rohitChaware)"
|
||||
extends_documentation_fragment:
|
||||
- community.general.oracle
|
||||
|
@ -58,10 +55,9 @@ extends_documentation_fragment:
|
|||
- community.general.oracle_wait_options
|
||||
- community.general.oracle_tags
|
||||
- community.general.attributes
|
||||
"""
|
||||
|
||||
'''
|
||||
|
||||
EXAMPLES = """
|
||||
EXAMPLES = r"""
|
||||
- name: Create a VCN
|
||||
community.general.oci_vcn:
|
||||
cidr_block: '10.0.0.0/16'
|
||||
|
@ -80,7 +76,7 @@ EXAMPLES = """
|
|||
state: absent
|
||||
"""
|
||||
|
||||
RETURN = """
|
||||
RETURN = r"""
|
||||
vcn:
|
||||
description: Information about the VCN
|
||||
returned: On successful create and update operation
|
||||
|
|
Loading…
Add table
Add a link
Reference in a new issue