mirror of
https://github.com/ansible-collections/google.cloud.git
synced 2025-07-26 22:51:30 -07:00
Documentation Refactor
This commit is contained in:
The Magician
Alex Stephen
parent
6a98471a53
commit
87656c4016
88 changed files with 11960 additions and 12598 deletions
|
|
@ -57,64 +57,75 @@ requirements:
|
|||
options:
|
||||
state:
|
||||
description:
|
||||
description:
|
||||
- An optional description of this resource. Provide this property when you create
|
||||
the resource.
|
||||
required: false
|
||||
version_added: 2.7
|
||||
name:
|
||||
description:
|
||||
- Name of the resource. Provided by the client when the resource is created. 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 that this route applies to.
|
||||
- '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
|
||||
priority:
|
||||
description:
|
||||
- The priority of this route. Priority is used to break ties in cases where there
|
||||
is more than one matching route of equal prefix length.
|
||||
- In the case of two routes with equal prefix length, the one with the lowest-numbered
|
||||
priority value wins.
|
||||
- Default value is 1000. Valid range is 0 through 65535.
|
||||
required: false
|
||||
tags:
|
||||
description:
|
||||
- A list of instance tags to which this route applies.
|
||||
required: false
|
||||
next_hop_gateway:
|
||||
description:
|
||||
- URL to a gateway that should handle matching packets.
|
||||
- 'Currently, you can only specify the internet gateway, using a full or partial valid
|
||||
URL: * U(https://www.googleapis.com/compute/v1/projects/project/global/gateways/default-internet-gateway)
|
||||
* projects/project/global/gateways/default-internet-gateway * global/gateways/default-internet-gateway
|
||||
.'
|
||||
required: false
|
||||
next_hop_instance:
|
||||
description:
|
||||
- URL to an instance that should handle matching packets.
|
||||
- 'You can specify this as a full or partial URL. For example: * U(https://www.googleapis.com/compute/v1/projects/project/zones/zone/)
|
||||
instances/instance * projects/project/zones/zone/instances/instance * zones/zone/instances/instance
|
||||
.'
|
||||
required: false
|
||||
next_hop_ip:
|
||||
description:
|
||||
- Network IP address of an instance that should handle matching packets.
|
||||
required: false
|
||||
next_hop_vpn_tunnel:
|
||||
description:
|
||||
- URL to a VpnTunnel that should handle matching packets.
|
||||
required: false
|
||||
- Whether the given object should exist in GCP
|
||||
choices:
|
||||
- present
|
||||
- absent
|
||||
default: present
|
||||
dest_range:
|
||||
description:
|
||||
- The destination range of outgoing packets that this route applies to.
|
||||
- Only IPv4 is supported.
|
||||
required: true
|
||||
description:
|
||||
description:
|
||||
- An optional description of this resource. Provide this property when you create
|
||||
the resource.
|
||||
required: false
|
||||
version_added: 2.7
|
||||
name:
|
||||
description:
|
||||
- Name of the resource. Provided by the client when the resource is created. 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 that this route applies to.
|
||||
- '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
|
||||
priority:
|
||||
description:
|
||||
- The priority of this route. Priority is used to break ties in cases where there
|
||||
is more than one matching route of equal prefix length.
|
||||
- In the case of two routes with equal prefix length, the one with the lowest-numbered
|
||||
priority value wins.
|
||||
- Default value is 1000. Valid range is 0 through 65535.
|
||||
required: false
|
||||
tags:
|
||||
description:
|
||||
- A list of instance tags to which this route applies.
|
||||
required: false
|
||||
next_hop_gateway:
|
||||
description:
|
||||
- URL to a gateway that should handle matching packets.
|
||||
- 'Currently, you can only specify the internet gateway, using a full or partial
|
||||
valid URL: * U(https://www.googleapis.com/compute/v1/projects/project/global/gateways/default-internet-gateway)
|
||||
* projects/project/global/gateways/default-internet-gateway * global/gateways/default-internet-gateway
|
||||
.'
|
||||
required: false
|
||||
next_hop_instance:
|
||||
description:
|
||||
- URL to an instance that should handle matching packets.
|
||||
- 'You can specify this as a full or partial URL. For example: * U(https://www.googleapis.com/compute/v1/projects/project/zones/zone/)
|
||||
instances/instance * projects/project/zones/zone/instances/instance * zones/zone/instances/instance
|
||||
.'
|
||||
required: false
|
||||
next_hop_ip:
|
||||
description:
|
||||
- Network IP address of an instance that should handle matching packets.
|
||||
required: false
|
||||
next_hop_vpn_tunnel:
|
||||
description:
|
||||
- URL to a VpnTunnel that should handle matching packets.
|
||||
required: false
|
||||
extends_documentation_fragment: gcp
|
||||
notes:
|
||||
- 'API Reference: U(https://cloud.google.com/compute/docs/reference/rest/v1/routes)'
|
||||
|
|
@ -147,79 +158,79 @@ EXAMPLES = '''
|
|||
'''
|
||||
|
||||
RETURN = '''
|
||||
destRange:
|
||||
description:
|
||||
- The destination range of outgoing packets that this route applies to.
|
||||
- Only IPv4 is supported.
|
||||
returned: success
|
||||
type: str
|
||||
description:
|
||||
description:
|
||||
- An optional description of this resource. Provide this property when you create
|
||||
the resource.
|
||||
returned: success
|
||||
type: str
|
||||
name:
|
||||
description:
|
||||
- Name of the resource. Provided by the client when the resource is created. 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 that this route applies to.
|
||||
returned: success
|
||||
type: dict
|
||||
priority:
|
||||
description:
|
||||
- The priority of this route. Priority is used to break ties in cases where there
|
||||
is more than one matching route of equal prefix length.
|
||||
- In the case of two routes with equal prefix length, the one with the lowest-numbered
|
||||
priority value wins.
|
||||
- Default value is 1000. Valid range is 0 through 65535.
|
||||
returned: success
|
||||
type: int
|
||||
tags:
|
||||
description:
|
||||
- A list of instance tags to which this route applies.
|
||||
returned: success
|
||||
type: list
|
||||
nextHopGateway:
|
||||
description:
|
||||
- URL to a gateway that should handle matching packets.
|
||||
- 'Currently, you can only specify the internet gateway, using a full or partial valid
|
||||
URL: * U(https://www.googleapis.com/compute/v1/projects/project/global/gateways/default-internet-gateway)
|
||||
* projects/project/global/gateways/default-internet-gateway * global/gateways/default-internet-gateway
|
||||
.'
|
||||
returned: success
|
||||
type: str
|
||||
nextHopInstance:
|
||||
description:
|
||||
- URL to an instance that should handle matching packets.
|
||||
- 'You can specify this as a full or partial URL. For example: * U(https://www.googleapis.com/compute/v1/projects/project/zones/zone/)
|
||||
instances/instance * projects/project/zones/zone/instances/instance * zones/zone/instances/instance
|
||||
.'
|
||||
returned: success
|
||||
type: str
|
||||
nextHopIp:
|
||||
description:
|
||||
- Network IP address of an instance that should handle matching packets.
|
||||
returned: success
|
||||
type: str
|
||||
nextHopVpnTunnel:
|
||||
description:
|
||||
- URL to a VpnTunnel that should handle matching packets.
|
||||
returned: success
|
||||
type: str
|
||||
nextHopNetwork:
|
||||
description:
|
||||
- URL to a Network that should handle matching packets.
|
||||
returned: success
|
||||
type: str
|
||||
destRange:
|
||||
description:
|
||||
- The destination range of outgoing packets that this route applies to.
|
||||
- Only IPv4 is supported.
|
||||
returned: success
|
||||
type: str
|
||||
description:
|
||||
description:
|
||||
- An optional description of this resource. Provide this property when you create
|
||||
the resource.
|
||||
returned: success
|
||||
type: str
|
||||
name:
|
||||
description:
|
||||
- Name of the resource. Provided by the client when the resource is created. 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 that this route applies to.
|
||||
returned: success
|
||||
type: dict
|
||||
priority:
|
||||
description:
|
||||
- The priority of this route. Priority is used to break ties in cases where there
|
||||
is more than one matching route of equal prefix length.
|
||||
- In the case of two routes with equal prefix length, the one with the lowest-numbered
|
||||
priority value wins.
|
||||
- Default value is 1000. Valid range is 0 through 65535.
|
||||
returned: success
|
||||
type: int
|
||||
tags:
|
||||
description:
|
||||
- A list of instance tags to which this route applies.
|
||||
returned: success
|
||||
type: list
|
||||
nextHopGateway:
|
||||
description:
|
||||
- URL to a gateway that should handle matching packets.
|
||||
- 'Currently, you can only specify the internet gateway, using a full or partial
|
||||
valid URL: * U(https://www.googleapis.com/compute/v1/projects/project/global/gateways/default-internet-gateway)
|
||||
* projects/project/global/gateways/default-internet-gateway * global/gateways/default-internet-gateway
|
||||
.'
|
||||
returned: success
|
||||
type: str
|
||||
nextHopInstance:
|
||||
description:
|
||||
- URL to an instance that should handle matching packets.
|
||||
- 'You can specify this as a full or partial URL. For example: * U(https://www.googleapis.com/compute/v1/projects/project/zones/zone/)
|
||||
instances/instance * projects/project/zones/zone/instances/instance * zones/zone/instances/instance
|
||||
.'
|
||||
returned: success
|
||||
type: str
|
||||
nextHopIp:
|
||||
description:
|
||||
- Network IP address of an instance that should handle matching packets.
|
||||
returned: success
|
||||
type: str
|
||||
nextHopVpnTunnel:
|
||||
description:
|
||||
- URL to a VpnTunnel that should handle matching packets.
|
||||
returned: success
|
||||
type: str
|
||||
nextHopNetwork:
|
||||
description:
|
||||
- URL to a Network that should handle matching packets.
|
||||
returned: success
|
||||
type: str
|
||||
'''
|
||||
|
||||
################################################################################
|
||||
|
|
|
|||
Loading…
Add table
Add a link
Reference in a new issue