mirror of
https://github.com/ansible-collections/google.cloud.git
synced 2025-07-26 14:41:29 -07:00
Documentation Refactor
This commit is contained in:
parent
6a98471a53
commit
87656c4016
88 changed files with 11960 additions and 12598 deletions
|
@ -89,10 +89,10 @@ options:
|
|||
- The network this subnet belongs to.
|
||||
- Only networks that are in the distributed mode can have subnetworks.
|
||||
- 'This field represents a link to a Network resource in GCP. It can be specified
|
||||
in two ways. First, you can place a dictionary with key ''selfLink'' and value
|
||||
of your resource''s selfLink Alternatively, you can add `register: name-of-resource`
|
||||
to a gcp_compute_network task and then set this network field to "{{ name-of-resource
|
||||
}}"'
|
||||
in two ways. You can add `register: name-of-resource` to a gcp_compute_network
|
||||
task and then set this network field to "{{ name-of-resource }}" Alternatively,
|
||||
you can set this network to a dictionary with the selfLink key where the value
|
||||
is the selfLink of your Network'
|
||||
required: true
|
||||
enable_flow_logs:
|
||||
description:
|
||||
|
@ -110,63 +110,11 @@ options:
|
|||
suboptions:
|
||||
range_name:
|
||||
description:
|
||||
- An optional description of this resource. Provide this property when you create
|
||||
the resource. This field can be set only at resource creation time.
|
||||
required: false
|
||||
ip_cidr_range:
|
||||
description:
|
||||
- The range of internal addresses that are owned by this subnetwork.
|
||||
- Provide this property when you create the subnetwork. For example, 10.0.0.0/8 or
|
||||
192.168.0.0/16. Ranges must be unique and non-overlapping within a network. Only
|
||||
IPv4 is supported.
|
||||
- The name associated with this subnetwork secondary range, used when adding
|
||||
an alias IP range to a VM instance. The name must be 1-63 characters long,
|
||||
and comply with RFC1035. The name must be unique within the subnetwork.
|
||||
required: true
|
||||
name:
|
||||
description:
|
||||
- The name of the resource, provided by the client when initially creating the resource.
|
||||
The name must be 1-63 characters long, and comply with RFC1035. Specifically, the
|
||||
name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?`
|
||||
which means the first character must be a lowercase letter, and all following characters
|
||||
must be a dash, lowercase letter, or digit, except the last character, which cannot
|
||||
be a dash.
|
||||
required: true
|
||||
network:
|
||||
description:
|
||||
- The network this subnet belongs to.
|
||||
- Only networks that are in the distributed mode can have subnetworks.
|
||||
- 'This field represents a link to a Network resource in GCP. It can be specified
|
||||
in two ways. You can add `register: name-of-resource` to a gcp_compute_network task
|
||||
and then set this network field to "{{ name-of-resource }}" Alternatively, you can
|
||||
set this network to a dictionary with the selfLink key where the value is the selfLink
|
||||
of your Network.'
|
||||
required: true
|
||||
enable_flow_logs:
|
||||
description:
|
||||
- Whether to enable flow logging for this subnetwork.
|
||||
required: false
|
||||
type: bool
|
||||
version_added: 2.8
|
||||
secondary_ip_ranges:
|
||||
description:
|
||||
- An array of configurations for secondary IP ranges for VM instances contained in
|
||||
this subnetwork. The primary IP of such VM must belong to the primary ipCidrRange
|
||||
of the subnetwork. The alias IPs may belong to either primary or secondary ranges.
|
||||
required: false
|
||||
version_added: 2.8
|
||||
suboptions:
|
||||
range_name:
|
||||
description:
|
||||
- The name associated with this subnetwork secondary range, used when adding an alias
|
||||
IP range to a VM instance. The name must be 1-63 characters long, and comply with
|
||||
RFC1035. The name must be unique within the subnetwork.
|
||||
required: true
|
||||
ip_cidr_range:
|
||||
description:
|
||||
- The range of IP addresses belonging to this subnetwork secondary range. Provide
|
||||
this property when you create the subnetwork.
|
||||
- Ranges must be unique and non-overlapping with all primary and secondary IP ranges
|
||||
within a network. Only IPv4 is supported.
|
||||
required: true
|
||||
private_ip_google_access:
|
||||
ip_cidr_range:
|
||||
description:
|
||||
- The range of IP addresses belonging to this subnetwork secondary range.
|
||||
Provide this property when you create the subnetwork.
|
||||
|
@ -175,8 +123,8 @@ options:
|
|||
required: true
|
||||
private_ip_google_access:
|
||||
description:
|
||||
- When enabled, VMs in this subnetwork without external IP addresses can access
|
||||
Google APIs and services by using Private Google Access.
|
||||
- Whether the VMs in this subnet can access Google services without assigned external
|
||||
IP addresses.
|
||||
required: false
|
||||
type: bool
|
||||
region:
|
||||
|
@ -214,97 +162,97 @@ EXAMPLES = '''
|
|||
'''
|
||||
|
||||
RETURN = '''
|
||||
creationTimestamp:
|
||||
description:
|
||||
- Creation timestamp in RFC3339 text format.
|
||||
returned: success
|
||||
type: str
|
||||
description:
|
||||
description:
|
||||
- An optional description of this resource. Provide this property when you create
|
||||
the resource. This field can be set only at resource creation time.
|
||||
returned: success
|
||||
type: str
|
||||
gatewayAddress:
|
||||
description:
|
||||
- The gateway address for default routes to reach destination addresses outside this
|
||||
subnetwork.
|
||||
returned: success
|
||||
type: str
|
||||
id:
|
||||
description:
|
||||
- The unique identifier for the resource.
|
||||
returned: success
|
||||
type: int
|
||||
creationTimestamp:
|
||||
description:
|
||||
- Creation timestamp in RFC3339 text format.
|
||||
returned: success
|
||||
type: str
|
||||
description:
|
||||
description:
|
||||
- An optional description of this resource. Provide this property when you create
|
||||
the resource. This field can be set only at resource creation time.
|
||||
returned: success
|
||||
type: str
|
||||
gatewayAddress:
|
||||
description:
|
||||
- The gateway address for default routes to reach destination addresses outside
|
||||
this subnetwork.
|
||||
returned: success
|
||||
type: str
|
||||
id:
|
||||
description:
|
||||
- The unique identifier for the resource.
|
||||
returned: success
|
||||
type: int
|
||||
ipCidrRange:
|
||||
description:
|
||||
- The range of internal addresses that are owned by this subnetwork.
|
||||
- Provide this property when you create the subnetwork. For example, 10.0.0.0/8
|
||||
or 192.168.0.0/16. Ranges must be unique and non-overlapping within a network.
|
||||
Only IPv4 is supported.
|
||||
returned: success
|
||||
type: str
|
||||
name:
|
||||
description:
|
||||
- The name of the resource, provided by the client when initially creating the resource.
|
||||
The name must be 1-63 characters long, and comply with RFC1035. Specifically,
|
||||
the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?`
|
||||
which means the first character must be a lowercase letter, and all following
|
||||
characters must be a dash, lowercase letter, or digit, except the last character,
|
||||
which cannot be a dash.
|
||||
returned: success
|
||||
type: str
|
||||
network:
|
||||
description:
|
||||
- The network this subnet belongs to.
|
||||
- Only networks that are in the distributed mode can have subnetworks.
|
||||
returned: success
|
||||
type: dict
|
||||
enableFlowLogs:
|
||||
description:
|
||||
- Whether to enable flow logging for this subnetwork.
|
||||
returned: success
|
||||
type: bool
|
||||
fingerprint:
|
||||
description:
|
||||
- Fingerprint of this resource. This field is used internally during updates of
|
||||
this resource.
|
||||
returned: success
|
||||
type: str
|
||||
secondaryIpRanges:
|
||||
description:
|
||||
- An array of configurations for secondary IP ranges for VM instances contained
|
||||
in this subnetwork. The primary IP of such VM must belong to the primary ipCidrRange
|
||||
of the subnetwork. The alias IPs may belong to either primary or secondary ranges.
|
||||
returned: success
|
||||
type: complex
|
||||
contains:
|
||||
rangeName:
|
||||
description:
|
||||
- The name associated with this subnetwork secondary range, used when adding
|
||||
an alias IP range to a VM instance. The name must be 1-63 characters long,
|
||||
and comply with RFC1035. The name must be unique within the subnetwork.
|
||||
returned: success
|
||||
type: str
|
||||
ipCidrRange:
|
||||
description:
|
||||
- The range of internal addresses that are owned by this subnetwork.
|
||||
- Provide this property when you create the subnetwork. For example, 10.0.0.0/8 or
|
||||
192.168.0.0/16. Ranges must be unique and non-overlapping within a network. Only
|
||||
IPv4 is supported.
|
||||
returned: success
|
||||
type: str
|
||||
name:
|
||||
description:
|
||||
- The name of the resource, provided by the client when initially creating the resource.
|
||||
The name must be 1-63 characters long, and comply with RFC1035. Specifically, the
|
||||
name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?`
|
||||
which means the first character must be a lowercase letter, and all following characters
|
||||
must be a dash, lowercase letter, or digit, except the last character, which cannot
|
||||
be a dash.
|
||||
returned: success
|
||||
type: str
|
||||
network:
|
||||
description:
|
||||
- The network this subnet belongs to.
|
||||
- Only networks that are in the distributed mode can have subnetworks.
|
||||
returned: success
|
||||
type: dict
|
||||
enableFlowLogs:
|
||||
description:
|
||||
- Whether to enable flow logging for this subnetwork.
|
||||
returned: success
|
||||
type: bool
|
||||
fingerprint:
|
||||
description:
|
||||
- Fingerprint of this resource. This field is used internally during updates of this
|
||||
resource.
|
||||
returned: success
|
||||
type: str
|
||||
secondaryIpRanges:
|
||||
description:
|
||||
- An array of configurations for secondary IP ranges for VM instances contained in
|
||||
this subnetwork. The primary IP of such VM must belong to the primary ipCidrRange
|
||||
of the subnetwork. The alias IPs may belong to either primary or secondary ranges.
|
||||
returned: success
|
||||
type: complex
|
||||
contains:
|
||||
rangeName:
|
||||
description:
|
||||
- The name associated with this subnetwork secondary range, used when adding an alias
|
||||
IP range to a VM instance. The name must be 1-63 characters long, and comply with
|
||||
RFC1035. The name must be unique within the subnetwork.
|
||||
returned: success
|
||||
type: str
|
||||
ipCidrRange:
|
||||
description:
|
||||
- The range of IP addresses belonging to this subnetwork secondary range. Provide
|
||||
this property when you create the subnetwork.
|
||||
- Ranges must be unique and non-overlapping with all primary and secondary IP ranges
|
||||
within a network. Only IPv4 is supported.
|
||||
returned: success
|
||||
type: str
|
||||
privateIpGoogleAccess:
|
||||
description:
|
||||
- Whether the VMs in this subnet can access Google services without assigned external
|
||||
IP addresses.
|
||||
returned: success
|
||||
type: bool
|
||||
region:
|
||||
description:
|
||||
- URL of the GCP region for this subnetwork.
|
||||
returned: success
|
||||
type: str
|
||||
description:
|
||||
- The range of IP addresses belonging to this subnetwork secondary range. Provide
|
||||
this property when you create the subnetwork.
|
||||
- Ranges must be unique and non-overlapping with all primary and secondary IP
|
||||
ranges within a network. Only IPv4 is supported.
|
||||
returned: success
|
||||
type: str
|
||||
privateIpGoogleAccess:
|
||||
description:
|
||||
- Whether the VMs in this subnet can access Google services without assigned external
|
||||
IP addresses.
|
||||
returned: success
|
||||
type: bool
|
||||
region:
|
||||
description:
|
||||
- URL of the GCP region for this subnetwork.
|
||||
returned: success
|
||||
type: str
|
||||
'''
|
||||
|
||||
################################################################################
|
||||
|
|
Loading…
Add table
Add a link
Reference in a new issue