Blame - docs/dyn/compute_v1.routers.html - platform/external/python/google-api-python-client

2016-08-16 12:44:29 -0700

[diff] [blame]

79

<p class="firstline">Retrieves an aggregated list of routers.</p>

80

81

<code><a href="#aggregatedList_next">aggregatedList_next(previous_request, previous_response)</a></code></p>

82

<p class="firstline">Retrieves the next page of results.</p>

83

Dmitry Frenkel

3e17f89

2020-10-06 16:46:05 -0700

[diff] [blame]

84

<code><a href="#close">close()</a></code></p>

85

<p class="firstline">Close httplib2 connections.</p>

86

yoshi-code-bot

2021-06-11 00:22:02 -0700

[diff] [blame^]

87

<code><a href="#delete">delete(project, region, router, requestId=None, x__xgafv=None)</a></code></p>

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

88

<p class="firstline">Deletes the specified Router resource.</p>

89

yoshi-code-bot

2021-06-11 00:22:02 -0700

[diff] [blame^]

90

<code><a href="#get">get(project, region, router, x__xgafv=None)</a></code></p>

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

91

<p class="firstline">Returns the specified Router resource. Gets a list of available routers by making a list() request.</p>

92

yoshi-code-bot

2021-06-11 00:22:02 -0700

[diff] [blame^]

93

<code><a href="#getNatMappingInfo">getNatMappingInfo(project, region, router, filter=None, maxResults=None, orderBy=None, pageToken=None, returnPartialSuccess=None, x__xgafv=None)</a></code></p>

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

94

<p class="firstline">Retrieves runtime Nat mapping information of VM endpoints.</p>

95

96

<code><a href="#getNatMappingInfo_next">getNatMappingInfo_next(previous_request, previous_response)</a></code></p>

97

<p class="firstline">Retrieves the next page of results.</p>

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

98

yoshi-code-bot

2021-06-11 00:22:02 -0700

[diff] [blame^]

99

<code><a href="#getRouterStatus">getRouterStatus(project, region, router, x__xgafv=None)</a></code></p>

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

100

<p class="firstline">Retrieves runtime information of the specified router.</p>

101

yoshi-code-bot

2021-06-11 00:22:02 -0700

[diff] [blame^]

102

<code><a href="#insert">insert(project, region, body=None, requestId=None, x__xgafv=None)</a></code></p>

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

103

<p class="firstline">Creates a Router resource in the specified project and region using the data included in the request.</p>

104

yoshi-code-bot

2021-06-11 00:22:02 -0700

[diff] [blame^]

105

<code><a href="#list">list(project, region, filter=None, maxResults=None, orderBy=None, pageToken=None, returnPartialSuccess=None, x__xgafv=None)</a></code></p>

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

106

<p class="firstline">Retrieves a list of Router resources available to the specified project.</p>

107

108

<code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p>

109

<p class="firstline">Retrieves the next page of results.</p>

110

yoshi-code-bot

2021-06-11 00:22:02 -0700

[diff] [blame^]

111

<code><a href="#patch">patch(project, region, router, body=None, requestId=None, x__xgafv=None)</a></code></p>

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

112

<p class="firstline">Patches the specified Router resource with the data included in the request. This method supports PATCH semantics and uses JSON merge patch format and processing rules.</p>

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

113

yoshi-code-bot

2021-06-11 00:22:02 -0700

[diff] [blame^]

114

<code><a href="#preview">preview(project, region, router, body=None, x__xgafv=None)</a></code></p>

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

115

<p class="firstline">Preview fields auto-generated during router create and update operations. Calling this method does NOT create or update the router.</p>

116

yoshi-code-bot

2021-06-11 00:22:02 -0700

[diff] [blame^]

117

<code><a href="#update">update(project, region, router, body=None, requestId=None, x__xgafv=None)</a></code></p>

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

118

<p class="firstline">Updates the specified Router resource with the data included in the request. This method conforms to PUT semantics, which requests that the state of the target resource be created or replaced with the state defined by the representation enclosed in the request message payload.</p>

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

119

<h3>Method Details</h3>

120

yoshi-code-bot

2021-06-11 00:22:02 -0700

[diff] [blame^]

121

<code class="details" id="aggregatedList">aggregatedList(project, filter=None, includeAllScopes=None, maxResults=None, orderBy=None, pageToken=None, returnPartialSuccess=None, x__xgafv=None)</code>

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

122

<pre>Retrieves an aggregated list of routers.

123

124

Args:

125

project: string, Project ID for this request. (required)

yoshi-code-bot

2021-06-11 00:22:02 -0700

[diff] [blame^]

126

filter: string, A filter expression that filters resources listed in the response. The expression must specify the field name, a comparison operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The comparison operator must be either `=`, `!=`, `>`, or `<`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true) ```

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

127

includeAllScopes: boolean, Indicates whether every visible scope for each scope type (zone, region, global) should be included in the response. For new resource types added after this field, the flag has no effect as new resource types will always include every visible scope for each scope type in response. For resource types which predate this field, if this flag is omitted or false, only scopes of the scope types where the resource type is expected to be found will be included.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

128

maxResults: integer, The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`)

yoshi-code-bot

2021-06-11 00:22:02 -0700

[diff] [blame^]

129

orderBy: string, Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using `orderBy="creationTimestamp desc"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by `name` or `creationTimestamp desc` is supported.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

130

pageToken: string, Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results.

yoshi-code-bot

2021-03-02 11:49:08 -0800

[diff] [blame]

131

returnPartialSuccess: boolean, Opt-in for partial success behavior which provides partial results in case of failure. The default value is false.

yoshi-code-bot

2021-06-11 00:22:02 -0700

[diff] [blame^]

132

x__xgafv: string, V1 error format.

133

Allowed values

134

1 - v1 error format

135

2 - v2 error format

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

136

137

Returns:

138

An object of the form:

139

140

{ # Contains a list of routers.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

141

"id": "A String", # [Output Only] Unique identifier for the resource; defined by the server.

142

"items": { # A list of Router resources.

143

"a_key": { # Name of the scope containing this set of routers.

144

"routers": [ # A list of routers contained in this scope.

yoshi-code-bot

2021-06-11 00:22:02 -0700

[diff] [blame^]

145

{ # Represents a Cloud Router resource. For more information about Cloud Router, read the Cloud Router overview.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

146

"bgp": { # BGP information specific to this router.

147

"advertiseMode": "A String", # User-specified flag to indicate which mode to use for advertisement. The options are DEFAULT or CUSTOM.

148

"advertisedGroups": [ # User-specified list of prefix groups to advertise in custom mode. This field can only be populated if advertise_mode is CUSTOM and is advertised to all peers of the router. These groups will be advertised in addition to any specified prefixes. Leave this field blank to advertise no custom groups.

149

"A String",

150

],

151

"advertisedIpRanges": [ # User-specified list of individual IP ranges to advertise in custom mode. This field can only be populated if advertise_mode is CUSTOM and is advertised to all peers of the router. These IP ranges will be advertised in addition to any specified groups. Leave this field blank to advertise no custom IP ranges.

152

{ # Description-tagged IP ranges for the router to advertise.

153

"description": "A String", # User-specified description for the IP range.

154

"range": "A String", # The IP range to advertise. The value must be a CIDR-formatted string.

155

},

156

],

157

"asn": 42, # Local BGP Autonomous System Number (ASN). Must be an RFC6996 private ASN, either 16-bit or 32-bit. The value will be fixed for this router resource. All VPN tunnels that link to this router will have the same local ASN.

yoshi-code-bot

2021-06-11 00:22:02 -0700

[diff] [blame^]

158

"keepaliveInterval": 42, # The interval in seconds between BGP keepalive messages that are sent to the peer. Hold time is three times the interval at which keepalive messages are sent, and the hold time is the maximum number of seconds allowed to elapse between successive keepalive messages that BGP receives from a peer. BGP will use the smaller of either the local hold time value or the peer's hold time value as the hold time for the BGP connection between the two peers. If set, this value must be between 20 and 60. The default is 20.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

159

},

160

"bgpPeers": [ # BGP information that must be configured into the routing stack to establish BGP peering. This information must specify the peer ASN and either the interface name, IP address, or peer IP address. Please refer to RFC4273.

161

{

162

"advertiseMode": "A String", # User-specified flag to indicate which mode to use for advertisement.

yoshi-code-bot

2021-06-11 00:22:02 -0700

[diff] [blame^]

163

"advertisedGroups": [ # User-specified list of prefix groups to advertise in custom mode, which can take one of the following options: - ALL_SUBNETS: Advertises all available subnets, including peer VPC subnets. - ALL_VPC_SUBNETS: Advertises the router's own VPC subnets. Note that this field can only be populated if advertise_mode is CUSTOM and overrides the list defined for the router (in the "bgp" message). These groups are advertised in addition to any specified prefixes. Leave this field blank to advertise no custom groups.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

164

"A String",

165

],

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

166

"advertisedIpRanges": [ # User-specified list of individual IP ranges to advertise in custom mode. This field can only be populated if advertise_mode is CUSTOM and overrides the list defined for the router (in the "bgp" message). These IP ranges are advertised in addition to any specified groups. Leave this field blank to advertise no custom IP ranges.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

167

{ # Description-tagged IP ranges for the router to advertise.

168

"description": "A String", # User-specified description for the IP range.

169

"range": "A String", # The IP range to advertise. The value must be a CIDR-formatted string.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

170

},

171

],

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

172

"advertisedRoutePriority": 42, # The priority of routes advertised to this BGP peer. Where there is more than one matching route of maximum length, the routes with the lowest priority value win.

yoshi-code-bot

2021-06-11 00:22:02 -0700

[diff] [blame^]

173

"enable": "A String", # The status of the BGP peer connection. If set to FALSE, any active session with the peer is terminated and all associated routing information is removed. If set to TRUE, the peer connection can be established with routing information. The default is TRUE.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

174

"interfaceName": "A String", # Name of the interface the BGP peer is associated with.

175

"ipAddress": "A String", # IP address of the interface inside Google Cloud Platform. Only IPv4 is supported.

yoshi-code-bot

2021-06-11 00:22:02 -0700

[diff] [blame^]

176

"managementType": "A String", # [Output Only] The resource that configures and manages this BGP peer. - MANAGED_BY_USER is the default value and can be managed by you or other users - MANAGED_BY_ATTACHMENT is a BGP peer that is configured and managed by Cloud Interconnect, specifically by an InterconnectAttachment of type PARTNER. Google automatically creates, updates, and deletes this type of BGP peer when the PARTNER InterconnectAttachment is created, updated, or deleted.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

177

"name": "A String", # Name of this BGP peer. 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.

178

"peerAsn": 42, # Peer BGP Autonomous System Number (ASN). Each BGP interface may use a different value.

179

"peerIpAddress": "A String", # IP address of the BGP interface outside Google Cloud Platform. Only IPv4 is supported.

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

180

},

181

],

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

182

"creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.

183

"description": "A String", # An optional description of this resource. Provide this property when you create the resource.

yoshi-code-bot

2021-06-11 00:22:02 -0700

[diff] [blame^]

184

"encryptedInterconnectRouter": True or False, # Indicates if a router is dedicated for use with encrypted VLAN attachments (interconnectAttachments). Not currently available publicly.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

185

"id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.

186

"interfaces": [ # Router interfaces. Each interface requires either one linked resource, (for example, linkedVpnTunnel), or IP address and IP address range (for example, ipRange), or both.

187

{

188

"ipRange": "A String", # IP address and range of the interface. The IP range must be in the RFC3927 link-local IP address space. The value must be a CIDR-formatted string, for example: 169.254.0.1/30. NOTE: Do not truncate the address as it represents the IP address of the interface.

189

"linkedInterconnectAttachment": "A String", # URI of the linked Interconnect attachment. It must be in the same region as the router. Each interface can have one linked resource, which can be a VPN tunnel, an Interconnect attachment, or a virtual machine instance.

190

"linkedVpnTunnel": "A String", # URI of the linked VPN tunnel, which must be in the same region as the router. Each interface can have one linked resource, which can be a VPN tunnel, an Interconnect attachment, or a virtual machine instance.

yoshi-code-bot

2021-06-11 00:22:02 -0700

[diff] [blame^]

191

"managementType": "A String", # [Output Only] The resource that configures and manages this interface. - MANAGED_BY_USER is the default value and can be managed directly by users. - MANAGED_BY_ATTACHMENT is an interface that is configured and managed by Cloud Interconnect, specifically, by an InterconnectAttachment of type PARTNER. Google automatically creates, updates, and deletes this type of interface when the PARTNER InterconnectAttachment is created, updated, or deleted.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

192

"name": "A String", # Name of this interface entry. 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.

193

},

194

],

195

"kind": "compute#router", # [Output Only] Type of resource. Always compute#router for routers.

196

"name": "A String", # 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.

197

"nats": [ # A list of NAT services created in this router.

198

{ # Represents a Nat resource. It enables the VMs within the specified subnetworks to access Internet without external IP addresses. It specifies a list of subnetworks (and the ranges within) that want to use NAT. Customers can also provide the external IPs that would be used for NAT. GCP would auto-allocate ephemeral IPs if no external IPs are provided.

199

"drainNatIps": [ # A list of URLs of the IP resources to be drained. These IPs must be valid static external IPs that have been assigned to the NAT. These IPs should be used for updating/patching a NAT only.

200

"A String",

201

],

202

"enableEndpointIndependentMapping": True or False,

203

"icmpIdleTimeoutSec": 42, # Timeout (in seconds) for ICMP connections. Defaults to 30s if not set.

204

"logConfig": { # Configuration of logging on a NAT. # Configure logging on this NAT.

205

"enable": True or False, # Indicates whether or not to export logs. This is false by default.

yoshi-code-bot

2021-06-11 00:22:02 -0700

[diff] [blame^]

206

"filter": "A String", # Specify the desired filtering of logs on this NAT. If unspecified, logs are exported for all connections handled by this NAT. This option can take one of the following values: - ERRORS_ONLY: Export logs only for connection failures. - TRANSLATIONS_ONLY: Export logs only for successful connections. - ALL: Export logs for all connections, successful and unsuccessful.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

207

},

208

"minPortsPerVm": 42, # Minimum number of ports allocated to a VM from this NAT config. If not set, a default number of ports is allocated to a VM. This is rounded up to the nearest power of 2. For example, if the value of this field is 50, at least 64 ports are allocated to a VM.

209

"name": "A String", # Unique name of this Nat service. The name must be 1-63 characters long and comply with RFC1035.

yoshi-code-bot

2021-06-11 00:22:02 -0700

[diff] [blame^]

210

"natIpAllocateOption": "A String", # Specify the NatIpAllocateOption, which can take one of the following values: - MANUAL_ONLY: Uses only Nat IP addresses provided by customers. When there are not enough specified Nat IPs, the Nat service fails for new VMs. - AUTO_ONLY: Nat IPs are allocated by Google Cloud Platform; customers can't specify any Nat IPs. When choosing AUTO_ONLY, then nat_ip should be empty.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

211

"natIps": [ # A list of URLs of the IP resources used for this Nat service. These IP addresses must be valid static external IP addresses assigned to the project.

212

"A String",

213

],

yoshi-code-bot

2021-06-11 00:22:02 -0700

[diff] [blame^]

214

"sourceSubnetworkIpRangesToNat": "A String", # Specify the Nat option, which can take one of the following values: - ALL_SUBNETWORKS_ALL_IP_RANGES: All of the IP ranges in every Subnetwork are allowed to Nat. - ALL_SUBNETWORKS_ALL_PRIMARY_IP_RANGES: All of the primary IP ranges in every Subnetwork are allowed to Nat. - LIST_OF_SUBNETWORKS: A list of Subnetworks are allowed to Nat (specified in the field subnetwork below) The default is SUBNETWORK_IP_RANGE_TO_NAT_OPTION_UNSPECIFIED. Note that if this field contains ALL_SUBNETWORKS_ALL_IP_RANGES or ALL_SUBNETWORKS_ALL_PRIMARY_IP_RANGES, then there should not be any other Router.Nat section in any Router for this network in this region.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

215

"subnetworks": [ # A list of Subnetwork resources whose traffic should be translated by NAT Gateway. It is used only when LIST_OF_SUBNETWORKS is selected for the SubnetworkIpRangeToNatOption above.

216

{ # Defines the IP ranges that want to use NAT for a subnetwork.

217

"name": "A String", # URL for the subnetwork resource that will use NAT.

218

"secondaryIpRangeNames": [ # A list of the secondary ranges of the Subnetwork that are allowed to use NAT. This can be populated only if "LIST_OF_SECONDARY_IP_RANGES" is one of the values in source_ip_ranges_to_nat.

219

"A String",

220

],

221

"sourceIpRangesToNat": [ # Specify the options for NAT ranges in the Subnetwork. All options of a single value are valid except NAT_IP_RANGE_OPTION_UNSPECIFIED. The only valid option with multiple values is: ["PRIMARY_IP_RANGE", "LIST_OF_SECONDARY_IP_RANGES"] Default: [ALL_IP_RANGES]

"A String",

],

},

],

"tcpEstablishedIdleTimeoutSec": 42, # Timeout (in seconds) for TCP established connections. Defaults to 1200s if not set.

227

"tcpTransitoryIdleTimeoutSec": 42, # Timeout (in seconds) for TCP transitory connections. Defaults to 30s if not set.

228

"udpIdleTimeoutSec": 42, # Timeout (in seconds) for UDP connections. Defaults to 30s if not set.

229

},

230

],

231

"network": "A String", # URI of the network to which this router belongs.

232

"region": "A String", # [Output Only] URI of the region where the router resides. You must specify this field as part of the HTTP request URL. It is not settable as a field in the request body.

233

"selfLink": "A String", # [Output Only] Server-defined URL for the resource.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

234

},

235

],

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

236

"warning": { # Informational warning which replaces the list of routers when the list is empty.

237

"code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.

yoshi-code-bot

2021-06-11 00:22:02 -0700

[diff] [blame^]

238

"data": [ # [Output Only] Metadata about this warning in key: value format. For example: "data": [ { "key": "scope", "value": "zones/us-east1-d" }

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

239

{

240

"key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).

241

"value": "A String", # [Output Only] A warning data value corresponding to the key.

242

},

243

],

244

"message": "A String", # [Output Only] A human-readable description of the warning code.

245

},

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

246

},

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

247

},

248

"kind": "compute#routerAggregatedList", # Type of resource.

249

"nextPageToken": "A String", # [Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results.

250

"selfLink": "A String", # [Output Only] Server-defined URL for this resource.

251

"unreachables": [ # [Output Only] Unreachable resources.

252

"A String",

253

],

254

"warning": { # [Output Only] Informational warning message.

255

"code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.

yoshi-code-bot

2021-06-11 00:22:02 -0700

[diff] [blame^]

256

"data": [ # [Output Only] Metadata about this warning in key: value format. For example: "data": [ { "key": "scope", "value": "zones/us-east1-d" }

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

257

{

258

"key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).

259

"value": "A String", # [Output Only] A warning data value corresponding to the key.

260

},

261

],

262

"message": "A String", # [Output Only] A human-readable description of the warning code.

263

},

264

}</pre>

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

</div>

<code class="details" id="aggregatedList_next">aggregatedList_next(previous_request, previous_response)</code>

269

<pre>Retrieves the next page of results.

270

271

Args:

272

previous_request: The request for the previous page. (required)

273

previous_response: The response from the request for the previous page. (required)

274

275

Returns:

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

276

A request object that you can call 'execute()' on to request the next

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

277

page. Returns None if there are no more items in the collection.

</pre>

</div>

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

282

<code class="details" id="close">close()</code>

283

<pre>Close httplib2 connections.</pre>

</div>

yoshi-code-bot

2021-06-11 00:22:02 -0700

[diff] [blame^]

287

<code class="details" id="delete">delete(project, region, router, requestId=None, x__xgafv=None)</code>

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

288

<pre>Deletes the specified Router resource.

289

290

Args:

291

project: string, Project ID for this request. (required)

292

region: string, Name of the region for this request. (required)

293

router: string, Name of the Router resource to delete. (required)

yoshi-code-bot

2021-06-11 00:22:02 -0700

[diff] [blame^]

294

requestId: string, An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000).

295

x__xgafv: string, V1 error format.

296

Allowed values

297

1 - v1 error format

298

2 - v2 error format

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

299

300

Returns:

301

An object of the form:

302

yoshi-code-bot

2021-06-11 00:22:02 -0700

[diff] [blame^]

303

{ # Represents an Operation resource. Google Compute Engine has three Operation resources: * [Global](/compute/docs/reference/rest/v1/globalOperations) * [Regional](/compute/docs/reference/rest/v1/regionOperations) * [Zonal](/compute/docs/reference/rest/v1/zoneOperations) You can use an operation resource to manage asynchronous API requests. For more information, read Handling API responses. Operations can be global, regional or zonal. - For global operations, use the `globalOperations` resource. - For regional operations, use the `regionOperations` resource. - For zonal operations, use the `zonalOperations` resource. For more information, read Global, Regional, and Zonal Resources.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

304

"clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise.

305

"creationTimestamp": "A String", # [Deprecated] This field is deprecated.

306

"description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.

307

"endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.

308

"error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.

309

"errors": [ # [Output Only] The array of errors encountered while processing this operation.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

310

{

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

311

"code": "A String", # [Output Only] The error type identifier for this error.

312

"location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.

313

"message": "A String", # [Output Only] An optional, human-readable error message.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

314

},

315

],

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

316

},

317

"httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as `NOT FOUND`.

318

"httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error status code that was returned. For example, a `404` means the resource was not found.

319

"id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server.

320

"insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.

321

"kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources.

322

"name": "A String", # [Output Only] Name of the operation.

yoshi-code-bot

2021-03-02 11:49:08 -0800

[diff] [blame]

323

"operationGroupId": "A String", # [Output Only] An ID that represents a group of operations, such as when a group of operations results from a `bulkInsert` API request.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

324

"operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on.

325

"progress": 42, # [Output Only] An optional progress indicator that ranges from 0 to 100. There is no requirement that this be linear or support any granularity of operations. This should not be used to guess when the operation will be complete. This number should monotonically increase as the operation progresses.

326

"region": "A String", # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations.

327

"selfLink": "A String", # [Output Only] Server-defined URL for the resource.

328

"startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.

329

"status": "A String", # [Output Only] The status of the operation, which can be one of the following: `PENDING`, `RUNNING`, or `DONE`.

330

"statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.

331

"targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.

332

"targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. For operations related to creating a snapshot, this points to the persistent disk that the snapshot was created from.

333

"user": "A String", # [Output Only] User who requested the operation, for example: `user@example.com`.

334

"warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.

335

{

336

"code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.

yoshi-code-bot

2021-06-11 00:22:02 -0700

[diff] [blame^]

337

"data": [ # [Output Only] Metadata about this warning in key: value format. For example: "data": [ { "key": "scope", "value": "zones/us-east1-d" }

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

338

{

339

"key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).

340

"value": "A String", # [Output Only] A warning data value corresponding to the key.

341

},

342

],

343

"message": "A String", # [Output Only] A human-readable description of the warning code.

344

},

345

],

346

"zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only applicable when performing per-zone operations.

347

}</pre>

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

</div>

yoshi-code-bot

2021-06-11 00:22:02 -0700

[diff] [blame^]

351

<code class="details" id="get">get(project, region, router, x__xgafv=None)</code>

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

352

<pre>Returns the specified Router resource. Gets a list of available routers by making a list() request.

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

353

354

Args:

355

project: string, Project ID for this request. (required)

356

region: string, Name of the region for this request. (required)

357

router: string, Name of the Router resource to return. (required)

yoshi-code-bot

2021-06-11 00:22:02 -0700

[diff] [blame^]

358

x__xgafv: string, V1 error format.

359

Allowed values

360

1 - v1 error format

361

2 - v2 error format

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

362

363

Returns:

364

An object of the form:

365

yoshi-code-bot

2021-06-11 00:22:02 -0700

[diff] [blame^]

366

{ # Represents a Cloud Router resource. For more information about Cloud Router, read the Cloud Router overview.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

367

"bgp": { # BGP information specific to this router.

368

"advertiseMode": "A String", # User-specified flag to indicate which mode to use for advertisement. The options are DEFAULT or CUSTOM.

369

"advertisedGroups": [ # User-specified list of prefix groups to advertise in custom mode. This field can only be populated if advertise_mode is CUSTOM and is advertised to all peers of the router. These groups will be advertised in addition to any specified prefixes. Leave this field blank to advertise no custom groups.

370

"A String",

371

],

372

"advertisedIpRanges": [ # User-specified list of individual IP ranges to advertise in custom mode. This field can only be populated if advertise_mode is CUSTOM and is advertised to all peers of the router. These IP ranges will be advertised in addition to any specified groups. Leave this field blank to advertise no custom IP ranges.

373

{ # Description-tagged IP ranges for the router to advertise.

374

"description": "A String", # User-specified description for the IP range.

375

"range": "A String", # The IP range to advertise. The value must be a CIDR-formatted string.

376

},

377

],

378

"asn": 42, # Local BGP Autonomous System Number (ASN). Must be an RFC6996 private ASN, either 16-bit or 32-bit. The value will be fixed for this router resource. All VPN tunnels that link to this router will have the same local ASN.

yoshi-code-bot

2021-06-11 00:22:02 -0700

[diff] [blame^]

379

"keepaliveInterval": 42, # The interval in seconds between BGP keepalive messages that are sent to the peer. Hold time is three times the interval at which keepalive messages are sent, and the hold time is the maximum number of seconds allowed to elapse between successive keepalive messages that BGP receives from a peer. BGP will use the smaller of either the local hold time value or the peer's hold time value as the hold time for the BGP connection between the two peers. If set, this value must be between 20 and 60. The default is 20.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

380

},

381

"bgpPeers": [ # BGP information that must be configured into the routing stack to establish BGP peering. This information must specify the peer ASN and either the interface name, IP address, or peer IP address. Please refer to RFC4273.

382

{

383

"advertiseMode": "A String", # User-specified flag to indicate which mode to use for advertisement.

yoshi-code-bot

2021-06-11 00:22:02 -0700

[diff] [blame^]

384

"advertisedGroups": [ # User-specified list of prefix groups to advertise in custom mode, which can take one of the following options: - ALL_SUBNETS: Advertises all available subnets, including peer VPC subnets. - ALL_VPC_SUBNETS: Advertises the router's own VPC subnets. Note that this field can only be populated if advertise_mode is CUSTOM and overrides the list defined for the router (in the "bgp" message). These groups are advertised in addition to any specified prefixes. Leave this field blank to advertise no custom groups.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

385

"A String",

386

],

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

387

"advertisedIpRanges": [ # User-specified list of individual IP ranges to advertise in custom mode. This field can only be populated if advertise_mode is CUSTOM and overrides the list defined for the router (in the "bgp" message). These IP ranges are advertised in addition to any specified groups. Leave this field blank to advertise no custom IP ranges.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

388

{ # Description-tagged IP ranges for the router to advertise.

389

"description": "A String", # User-specified description for the IP range.

390

"range": "A String", # The IP range to advertise. The value must be a CIDR-formatted string.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

391

},

392

],

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

393

"advertisedRoutePriority": 42, # The priority of routes advertised to this BGP peer. Where there is more than one matching route of maximum length, the routes with the lowest priority value win.

yoshi-code-bot

2021-06-11 00:22:02 -0700

[diff] [blame^]

394

"enable": "A String", # The status of the BGP peer connection. If set to FALSE, any active session with the peer is terminated and all associated routing information is removed. If set to TRUE, the peer connection can be established with routing information. The default is TRUE.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

395

"interfaceName": "A String", # Name of the interface the BGP peer is associated with.

396

"ipAddress": "A String", # IP address of the interface inside Google Cloud Platform. Only IPv4 is supported.

yoshi-code-bot

2021-06-11 00:22:02 -0700

[diff] [blame^]

397

"managementType": "A String", # [Output Only] The resource that configures and manages this BGP peer. - MANAGED_BY_USER is the default value and can be managed by you or other users - MANAGED_BY_ATTACHMENT is a BGP peer that is configured and managed by Cloud Interconnect, specifically by an InterconnectAttachment of type PARTNER. Google automatically creates, updates, and deletes this type of BGP peer when the PARTNER InterconnectAttachment is created, updated, or deleted.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

398

"name": "A String", # Name of this BGP peer. 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.

399

"peerAsn": 42, # Peer BGP Autonomous System Number (ASN). Each BGP interface may use a different value.

400

"peerIpAddress": "A String", # IP address of the BGP interface outside Google Cloud Platform. Only IPv4 is supported.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

401

},

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

402

],

403

"creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.

404

"description": "A String", # An optional description of this resource. Provide this property when you create the resource.

yoshi-code-bot

2021-06-11 00:22:02 -0700

[diff] [blame^]

405

"encryptedInterconnectRouter": True or False, # Indicates if a router is dedicated for use with encrypted VLAN attachments (interconnectAttachments). Not currently available publicly.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

406

"id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.

407

"interfaces": [ # Router interfaces. Each interface requires either one linked resource, (for example, linkedVpnTunnel), or IP address and IP address range (for example, ipRange), or both.

408

{

409

"ipRange": "A String", # IP address and range of the interface. The IP range must be in the RFC3927 link-local IP address space. The value must be a CIDR-formatted string, for example: 169.254.0.1/30. NOTE: Do not truncate the address as it represents the IP address of the interface.

410

"linkedInterconnectAttachment": "A String", # URI of the linked Interconnect attachment. It must be in the same region as the router. Each interface can have one linked resource, which can be a VPN tunnel, an Interconnect attachment, or a virtual machine instance.

411

"linkedVpnTunnel": "A String", # URI of the linked VPN tunnel, which must be in the same region as the router. Each interface can have one linked resource, which can be a VPN tunnel, an Interconnect attachment, or a virtual machine instance.

yoshi-code-bot

2021-06-11 00:22:02 -0700

[diff] [blame^]

412

"managementType": "A String", # [Output Only] The resource that configures and manages this interface. - MANAGED_BY_USER is the default value and can be managed directly by users. - MANAGED_BY_ATTACHMENT is an interface that is configured and managed by Cloud Interconnect, specifically, by an InterconnectAttachment of type PARTNER. Google automatically creates, updates, and deletes this type of interface when the PARTNER InterconnectAttachment is created, updated, or deleted.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

413

"name": "A String", # Name of this interface entry. 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.

414

},

415

],

416

"kind": "compute#router", # [Output Only] Type of resource. Always compute#router for routers.

417

"name": "A String", # 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.

418

"nats": [ # A list of NAT services created in this router.

419

{ # Represents a Nat resource. It enables the VMs within the specified subnetworks to access Internet without external IP addresses. It specifies a list of subnetworks (and the ranges within) that want to use NAT. Customers can also provide the external IPs that would be used for NAT. GCP would auto-allocate ephemeral IPs if no external IPs are provided.

420

"drainNatIps": [ # A list of URLs of the IP resources to be drained. These IPs must be valid static external IPs that have been assigned to the NAT. These IPs should be used for updating/patching a NAT only.

421

"A String",

422

],

423

"enableEndpointIndependentMapping": True or False,

424

"icmpIdleTimeoutSec": 42, # Timeout (in seconds) for ICMP connections. Defaults to 30s if not set.

425

"logConfig": { # Configuration of logging on a NAT. # Configure logging on this NAT.

426

"enable": True or False, # Indicates whether or not to export logs. This is false by default.

yoshi-code-bot

2021-06-11 00:22:02 -0700

[diff] [blame^]

427

"filter": "A String", # Specify the desired filtering of logs on this NAT. If unspecified, logs are exported for all connections handled by this NAT. This option can take one of the following values: - ERRORS_ONLY: Export logs only for connection failures. - TRANSLATIONS_ONLY: Export logs only for successful connections. - ALL: Export logs for all connections, successful and unsuccessful.

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

428

},

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

429

"minPortsPerVm": 42, # Minimum number of ports allocated to a VM from this NAT config. If not set, a default number of ports is allocated to a VM. This is rounded up to the nearest power of 2. For example, if the value of this field is 50, at least 64 ports are allocated to a VM.

430

"name": "A String", # Unique name of this Nat service. The name must be 1-63 characters long and comply with RFC1035.

yoshi-code-bot

2021-06-11 00:22:02 -0700

[diff] [blame^]

431

"natIpAllocateOption": "A String", # Specify the NatIpAllocateOption, which can take one of the following values: - MANUAL_ONLY: Uses only Nat IP addresses provided by customers. When there are not enough specified Nat IPs, the Nat service fails for new VMs. - AUTO_ONLY: Nat IPs are allocated by Google Cloud Platform; customers can't specify any Nat IPs. When choosing AUTO_ONLY, then nat_ip should be empty.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

432

"natIps": [ # A list of URLs of the IP resources used for this Nat service. These IP addresses must be valid static external IP addresses assigned to the project.

433

"A String",

434

],

yoshi-code-bot

2021-06-11 00:22:02 -0700

[diff] [blame^]

435

"sourceSubnetworkIpRangesToNat": "A String", # Specify the Nat option, which can take one of the following values: - ALL_SUBNETWORKS_ALL_IP_RANGES: All of the IP ranges in every Subnetwork are allowed to Nat. - ALL_SUBNETWORKS_ALL_PRIMARY_IP_RANGES: All of the primary IP ranges in every Subnetwork are allowed to Nat. - LIST_OF_SUBNETWORKS: A list of Subnetworks are allowed to Nat (specified in the field subnetwork below) The default is SUBNETWORK_IP_RANGE_TO_NAT_OPTION_UNSPECIFIED. Note that if this field contains ALL_SUBNETWORKS_ALL_IP_RANGES or ALL_SUBNETWORKS_ALL_PRIMARY_IP_RANGES, then there should not be any other Router.Nat section in any Router for this network in this region.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

436

"subnetworks": [ # A list of Subnetwork resources whose traffic should be translated by NAT Gateway. It is used only when LIST_OF_SUBNETWORKS is selected for the SubnetworkIpRangeToNatOption above.

437

{ # Defines the IP ranges that want to use NAT for a subnetwork.

438

"name": "A String", # URL for the subnetwork resource that will use NAT.

439

"secondaryIpRangeNames": [ # A list of the secondary ranges of the Subnetwork that are allowed to use NAT. This can be populated only if "LIST_OF_SECONDARY_IP_RANGES" is one of the values in source_ip_ranges_to_nat.

440

"A String",

441

],

442

"sourceIpRangesToNat": [ # Specify the options for NAT ranges in the Subnetwork. All options of a single value are valid except NAT_IP_RANGE_OPTION_UNSPECIFIED. The only valid option with multiple values is: ["PRIMARY_IP_RANGE", "LIST_OF_SECONDARY_IP_RANGES"] Default: [ALL_IP_RANGES]

443

"A String",

444

],

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

445

},

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

446

],

447

"tcpEstablishedIdleTimeoutSec": 42, # Timeout (in seconds) for TCP established connections. Defaults to 1200s if not set.

448

"tcpTransitoryIdleTimeoutSec": 42, # Timeout (in seconds) for TCP transitory connections. Defaults to 30s if not set.

449

"udpIdleTimeoutSec": 42, # Timeout (in seconds) for UDP connections. Defaults to 30s if not set.

450

},

451

],

452

"network": "A String", # URI of the network to which this router belongs.

453

"region": "A String", # [Output Only] URI of the region where the router resides. You must specify this field as part of the HTTP request URL. It is not settable as a field in the request body.

454

"selfLink": "A String", # [Output Only] Server-defined URL for the resource.

455

}</pre>

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

</div>

yoshi-code-bot

2021-06-11 00:22:02 -0700

[diff] [blame^]

459

<code class="details" id="getNatMappingInfo">getNatMappingInfo(project, region, router, filter=None, maxResults=None, orderBy=None, pageToken=None, returnPartialSuccess=None, x__xgafv=None)</code>

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

460

<pre>Retrieves runtime Nat mapping information of VM endpoints.

461

462

Args:

463

project: string, Project ID for this request. (required)

464

region: string, Name of the region for this request. (required)

465

router: string, Name of the Router resource to query for Nat Mapping information of VM endpoints. (required)

yoshi-code-bot

2021-06-11 00:22:02 -0700

[diff] [blame^]

466

filter: string, A filter expression that filters resources listed in the response. The expression must specify the field name, a comparison operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The comparison operator must be either `=`, `!=`, `>`, or `<`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true) ```

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

467

maxResults: integer, The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`)

yoshi-code-bot

2021-06-11 00:22:02 -0700

[diff] [blame^]

468

orderBy: string, Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using `orderBy="creationTimestamp desc"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by `name` or `creationTimestamp desc` is supported.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

469

pageToken: string, Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results.

yoshi-code-bot

2021-03-02 11:49:08 -0800

[diff] [blame]

470

returnPartialSuccess: boolean, Opt-in for partial success behavior which provides partial results in case of failure. The default value is false.

yoshi-code-bot

2021-06-11 00:22:02 -0700

[diff] [blame^]

471

x__xgafv: string, V1 error format.

472

Allowed values

473

1 - v1 error format

474

2 - v2 error format

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

475

476

Returns:

477

An object of the form:

478

479

{ # Contains a list of VmEndpointNatMappings.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

480

"id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.

481

"kind": "compute#vmEndpointNatMappingsList", # [Output Only] Type of resource. Always compute#vmEndpointNatMappingsList for lists of Nat mappings of VM endpoints.

482

"nextPageToken": "A String", # [Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results.

483

"result": [ # [Output Only] A list of Nat mapping information of VM endpoints.

484

{ # Contain information of Nat mapping for a VM endpoint (i.e., NIC).

485

"instanceName": "A String", # Name of the VM instance which the endpoint belongs to

486

"interfaceNatMappings": [

487

{ # Contain information of Nat mapping for an interface of this endpoint.

488

"drainNatIpPortRanges": [ # List of all drain IP:port-range mappings assigned to this interface. These ranges are inclusive, that is, both the first and the last ports can be used for NAT. Example: ["2.2.2.2:12345-12355", "1.1.1.1:2234-2234"].

489

"A String",

490

],

491

"natIpPortRanges": [ # A list of all IP:port-range mappings assigned to this interface. These ranges are inclusive, that is, both the first and the last ports can be used for NAT. Example: ["2.2.2.2:12345-12355", "1.1.1.1:2234-2234"].

492

"A String",

493

],

494

"numTotalDrainNatPorts": 42, # Total number of drain ports across all NAT IPs allocated to this interface. It equals to the aggregated port number in the field drain_nat_ip_port_ranges.

495

"numTotalNatPorts": 42, # Total number of ports across all NAT IPs allocated to this interface. It equals to the aggregated port number in the field nat_ip_port_ranges.

496

"sourceAliasIpRange": "A String", # Alias IP range for this interface endpoint. It will be a private (RFC 1918) IP range. Examples: "10.33.4.55/32", or "192.168.5.0/24".

497

"sourceVirtualIp": "A String", # Primary IP of the VM for this NIC.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

498

},

499

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

500

},

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

501

],

502

"selfLink": "A String", # [Output Only] Server-defined URL for this resource.

503

"warning": { # [Output Only] Informational warning message.

504

"code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.

yoshi-code-bot

2021-06-11 00:22:02 -0700

[diff] [blame^]

505

"data": [ # [Output Only] Metadata about this warning in key: value format. For example: "data": [ { "key": "scope", "value": "zones/us-east1-d" }

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

506

{

507

"key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).

508

"value": "A String", # [Output Only] A warning data value corresponding to the key.

509

},

510

],

511

"message": "A String", # [Output Only] A human-readable description of the warning code.

512

},

513

}</pre>

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

</div>

<code class="details" id="getNatMappingInfo_next">getNatMappingInfo_next(previous_request, previous_response)</code>

518

<pre>Retrieves the next page of results.

519

520

Args:

521

previous_request: The request for the previous page. (required)

522

previous_response: The response from the request for the previous page. (required)

523

524

Returns:

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

525

A request object that you can call 'execute()' on to request the next

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

526

page. Returns None if there are no more items in the collection.

</pre>

</div>

yoshi-code-bot

2021-06-11 00:22:02 -0700

[diff] [blame^]

531

<code class="details" id="getRouterStatus">getRouterStatus(project, region, router, x__xgafv=None)</code>

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

532

<pre>Retrieves runtime information of the specified router.

533

534

Args:

535

project: string, Project ID for this request. (required)

536

region: string, Name of the region for this request. (required)

537

router: string, Name of the Router resource to query. (required)

yoshi-code-bot

2021-06-11 00:22:02 -0700

[diff] [blame^]

538

x__xgafv: string, V1 error format.

539

Allowed values

540

1 - v1 error format

541

2 - v2 error format

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

542

543

Returns:

544

An object of the form:

545

546

{

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

547

"kind": "compute#routerStatusResponse", # Type of resource.

548

"result": {

549

"bestRoutes": [ # Best routes for this router's network.

yoshi-code-bot

2021-06-11 00:22:02 -0700

[diff] [blame^]

550

{ # Represents a Route resource. A route defines a path from VM instances in the VPC network to a specific destination. This destination can be inside or outside the VPC network. For more information, read the Routes overview.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

551

"creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.

552

"description": "A String", # An optional description of this resource. Provide this field when you create the resource.

yoshi-code-bot

2021-03-02 11:49:08 -0800

[diff] [blame]

553

"destRange": "A String", # The destination range of outgoing packets that this route applies to. Both IPv4 and IPv6 are supported.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

554

"id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.

555

"kind": "compute#route", # [Output Only] Type of this resource. Always compute#routes for Route resources.

556

"name": "A String", # 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])?`. The first character must be a lowercase letter, and all following characters (except for the last character) must be a dash, lowercase letter, or digit. The last character must be a lowercase letter or digit.

557

"network": "A String", # Fully-qualified URL of the network that this route applies to.

yoshi-code-bot

2021-06-11 00:22:02 -0700

[diff] [blame^]

558

"nextHopGateway": "A String", # The URL to a gateway that should handle matching packets. You can only specify the internet gateway using a full or partial valid URL: projects/ project/global/gateways/default-internet-gateway

559

"nextHopIlb": "A String", # The URL to a forwarding rule of type loadBalancingScheme=INTERNAL that should handle matching packets or the IP address of the forwarding Rule. For example, the following are all valid URLs: - 10.128.0.56 - https://www.googleapis.com/compute/v1/projects/project/regions/region /forwardingRules/forwardingRule - regions/region/forwardingRules/forwardingRule

560

"nextHopInstance": "A String", # The URL to an instance that should handle matching packets. You can specify this as a full or partial URL. For example: https://www.googleapis.com/compute/v1/projects/project/zones/zone/instances/

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

561

"nextHopIp": "A String", # The network IP address of an instance that should handle matching packets. Only IPv4 is supported.

562

"nextHopNetwork": "A String", # The URL of the local network if it should handle matching packets.

563

"nextHopPeering": "A String", # [Output Only] The network peering name that should handle matching packets, which should conform to RFC1035.

564

"nextHopVpnTunnel": "A String", # The URL to a VpnTunnel that should handle matching packets.

565

"priority": 42, # 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 cases where multiple routes have equal prefix length, the one with the lowest-numbered priority value wins. The default value is `1000`. The priority value must be from `0` to `65535`, inclusive.

566

"selfLink": "A String", # [Output Only] Server-defined fully-qualified URL for this resource.

567

"tags": [ # A list of instance tags to which this route applies.

568

"A String",

569

],

570

"warnings": [ # [Output Only] If potential misconfigurations are detected for this route, this field will be populated with warning messages.

571

{

572

"code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.

yoshi-code-bot

2021-06-11 00:22:02 -0700

[diff] [blame^]

573

"data": [ # [Output Only] Metadata about this warning in key: value format. For example: "data": [ { "key": "scope", "value": "zones/us-east1-d" }

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

574

{

575

"key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).

576

"value": "A String", # [Output Only] A warning data value corresponding to the key.

577

},

578

],

579

"message": "A String", # [Output Only] A human-readable description of the warning code.

},

],

},

],

"bestRoutesForRouter": [ # Best routes learned by this router.

yoshi-code-bot

2021-06-11 00:22:02 -0700

[diff] [blame^]

585

{ # Represents a Route resource. A route defines a path from VM instances in the VPC network to a specific destination. This destination can be inside or outside the VPC network. For more information, read the Routes overview.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

586

"creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.

587

"description": "A String", # An optional description of this resource. Provide this field when you create the resource.

yoshi-code-bot

2021-03-02 11:49:08 -0800

[diff] [blame]

588

"destRange": "A String", # The destination range of outgoing packets that this route applies to. Both IPv4 and IPv6 are supported.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

589

"id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.

590

"kind": "compute#route", # [Output Only] Type of this resource. Always compute#routes for Route resources.

591

"name": "A String", # 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])?`. The first character must be a lowercase letter, and all following characters (except for the last character) must be a dash, lowercase letter, or digit. The last character must be a lowercase letter or digit.

592

"network": "A String", # Fully-qualified URL of the network that this route applies to.

yoshi-code-bot

2021-06-11 00:22:02 -0700

[diff] [blame^]

593

"nextHopGateway": "A String", # The URL to a gateway that should handle matching packets. You can only specify the internet gateway using a full or partial valid URL: projects/ project/global/gateways/default-internet-gateway

594

"nextHopIlb": "A String", # The URL to a forwarding rule of type loadBalancingScheme=INTERNAL that should handle matching packets or the IP address of the forwarding Rule. For example, the following are all valid URLs: - 10.128.0.56 - https://www.googleapis.com/compute/v1/projects/project/regions/region /forwardingRules/forwardingRule - regions/region/forwardingRules/forwardingRule

595

"nextHopInstance": "A String", # The URL to an instance that should handle matching packets. You can specify this as a full or partial URL. For example: https://www.googleapis.com/compute/v1/projects/project/zones/zone/instances/

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

596

"nextHopIp": "A String", # The network IP address of an instance that should handle matching packets. Only IPv4 is supported.

597

"nextHopNetwork": "A String", # The URL of the local network if it should handle matching packets.

598

"nextHopPeering": "A String", # [Output Only] The network peering name that should handle matching packets, which should conform to RFC1035.

599

"nextHopVpnTunnel": "A String", # The URL to a VpnTunnel that should handle matching packets.

600

"priority": 42, # 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 cases where multiple routes have equal prefix length, the one with the lowest-numbered priority value wins. The default value is `1000`. The priority value must be from `0` to `65535`, inclusive.

601

"selfLink": "A String", # [Output Only] Server-defined fully-qualified URL for this resource.

602

"tags": [ # A list of instance tags to which this route applies.

603

"A String",

604

],

605

"warnings": [ # [Output Only] If potential misconfigurations are detected for this route, this field will be populated with warning messages.

606

{

607

"code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.

yoshi-code-bot

2021-06-11 00:22:02 -0700

[diff] [blame^]

608

"data": [ # [Output Only] Metadata about this warning in key: value format. For example: "data": [ { "key": "scope", "value": "zones/us-east1-d" }

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

609

{

610

"key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).

611

"value": "A String", # [Output Only] A warning data value corresponding to the key.

612

},

613

],

614

"message": "A String", # [Output Only] A human-readable description of the warning code.

},

],

},

],

"bgpPeerStatus": [

{

"advertisedRoutes": [ # Routes that were advertised to the remote BGP peer

yoshi-code-bot

2021-06-11 00:22:02 -0700

[diff] [blame^]

622

{ # Represents a Route resource. A route defines a path from VM instances in the VPC network to a specific destination. This destination can be inside or outside the VPC network. For more information, read the Routes overview.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

623

"creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.

624

"description": "A String", # An optional description of this resource. Provide this field when you create the resource.

yoshi-code-bot

2021-03-02 11:49:08 -0800

[diff] [blame]

625

"destRange": "A String", # The destination range of outgoing packets that this route applies to. Both IPv4 and IPv6 are supported.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

626

"id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.

627

"kind": "compute#route", # [Output Only] Type of this resource. Always compute#routes for Route resources.

628

"name": "A String", # 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])?`. The first character must be a lowercase letter, and all following characters (except for the last character) must be a dash, lowercase letter, or digit. The last character must be a lowercase letter or digit.

629

"network": "A String", # Fully-qualified URL of the network that this route applies to.

yoshi-code-bot

2021-06-11 00:22:02 -0700

[diff] [blame^]

630

"nextHopGateway": "A String", # The URL to a gateway that should handle matching packets. You can only specify the internet gateway using a full or partial valid URL: projects/ project/global/gateways/default-internet-gateway

631

"nextHopIlb": "A String", # The URL to a forwarding rule of type loadBalancingScheme=INTERNAL that should handle matching packets or the IP address of the forwarding Rule. For example, the following are all valid URLs: - 10.128.0.56 - https://www.googleapis.com/compute/v1/projects/project/regions/region /forwardingRules/forwardingRule - regions/region/forwardingRules/forwardingRule

632

"nextHopInstance": "A String", # The URL to an instance that should handle matching packets. You can specify this as a full or partial URL. For example: https://www.googleapis.com/compute/v1/projects/project/zones/zone/instances/

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

633

"nextHopIp": "A String", # The network IP address of an instance that should handle matching packets. Only IPv4 is supported.

634

"nextHopNetwork": "A String", # The URL of the local network if it should handle matching packets.

635

"nextHopPeering": "A String", # [Output Only] The network peering name that should handle matching packets, which should conform to RFC1035.

636

"nextHopVpnTunnel": "A String", # The URL to a VpnTunnel that should handle matching packets.

637

"priority": 42, # 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 cases where multiple routes have equal prefix length, the one with the lowest-numbered priority value wins. The default value is `1000`. The priority value must be from `0` to `65535`, inclusive.

638

"selfLink": "A String", # [Output Only] Server-defined fully-qualified URL for this resource.

639

"tags": [ # A list of instance tags to which this route applies.

640

"A String",

641

],

642

"warnings": [ # [Output Only] If potential misconfigurations are detected for this route, this field will be populated with warning messages.

643

{

644

"code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.

yoshi-code-bot

2021-06-11 00:22:02 -0700

[diff] [blame^]

645

"data": [ # [Output Only] Metadata about this warning in key: value format. For example: "data": [ { "key": "scope", "value": "zones/us-east1-d" }

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

646

{

647

"key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).

648

"value": "A String", # [Output Only] A warning data value corresponding to the key.

649

},

650

],

651

"message": "A String", # [Output Only] A human-readable description of the warning code.

},

],

},

],

"ipAddress": "A String", # IP address of the local BGP interface.

657

"linkedVpnTunnel": "A String", # URL of the VPN tunnel that this BGP peer controls.

658

"name": "A String", # Name of this BGP peer. Unique within the Routers resource.

659

"numLearnedRoutes": 42, # Number of routes learned from the remote BGP Peer.

660

"peerIpAddress": "A String", # IP address of the remote BGP interface.

661

"state": "A String", # BGP state as specified in RFC1771.

662

"status": "A String", # Status of the BGP peer: {UP, DOWN}

663

"uptime": "A String", # Time this session has been up. Format: 14 years, 51 weeks, 6 days, 23 hours, 59 minutes, 59 seconds

664

"uptimeSeconds": "A String", # Time this session has been up, in seconds. Format: 145

},

],

"natStatus": [

{ # Status of a NAT contained in this router.

669

"autoAllocatedNatIps": [ # A list of IPs auto-allocated for NAT. Example: ["1.1.1.1", "129.2.16.89"]

670

"A String",

671

],

672

"drainAutoAllocatedNatIps": [ # A list of IPs auto-allocated for NAT that are in drain mode. Example: ["1.1.1.1", "179.12.26.133"].

673

"A String",

674

],

675

"drainUserAllocatedNatIps": [ # A list of IPs user-allocated for NAT that are in drain mode. Example: ["1.1.1.1", "179.12.26.133"].

676

"A String",

677

],

678

"minExtraNatIpsNeeded": 42, # The number of extra IPs to allocate. This will be greater than 0 only if user-specified IPs are NOT enough to allow all configured VMs to use NAT. This value is meaningful only when auto-allocation of NAT IPs is *not* used.

679

"name": "A String", # Unique name of this NAT.

680

"numVmEndpointsWithNatMappings": 42, # Number of VM endpoints (i.e., Nics) that can use NAT.

681

"userAllocatedNatIpResources": [ # A list of fully qualified URLs of reserved IP address resources.

682

"A String",

683

],

684

"userAllocatedNatIps": [ # A list of IPs user-allocated for NAT. They will be raw IP strings like "179.12.26.133".

"A String",

],

},

],

"network": "A String", # URI of the network to which this router belongs.

690

},

691

}</pre>

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

</div>

yoshi-code-bot

2021-06-11 00:22:02 -0700

[diff] [blame^]

695

<code class="details" id="insert">insert(project, region, body=None, requestId=None, x__xgafv=None)</code>

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

696

<pre>Creates a Router resource in the specified project and region using the data included in the request.

697

698

Args:

699

project: string, Project ID for this request. (required)

700

region: string, Name of the region for this request. (required)

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

701

body: object, The request body.

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

702

The object takes the form of:

703

yoshi-code-bot

2021-06-11 00:22:02 -0700

[diff] [blame^]

704

{ # Represents a Cloud Router resource. For more information about Cloud Router, read the Cloud Router overview.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

705

"bgp": { # BGP information specific to this router.

706

"advertiseMode": "A String", # User-specified flag to indicate which mode to use for advertisement. The options are DEFAULT or CUSTOM.

707

"advertisedGroups": [ # User-specified list of prefix groups to advertise in custom mode. This field can only be populated if advertise_mode is CUSTOM and is advertised to all peers of the router. These groups will be advertised in addition to any specified prefixes. Leave this field blank to advertise no custom groups.

708

"A String",

709

],

710

"advertisedIpRanges": [ # User-specified list of individual IP ranges to advertise in custom mode. This field can only be populated if advertise_mode is CUSTOM and is advertised to all peers of the router. These IP ranges will be advertised in addition to any specified groups. Leave this field blank to advertise no custom IP ranges.

711

{ # Description-tagged IP ranges for the router to advertise.

712

"description": "A String", # User-specified description for the IP range.

713

"range": "A String", # The IP range to advertise. The value must be a CIDR-formatted string.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

714

},

715

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

716

"asn": 42, # Local BGP Autonomous System Number (ASN). Must be an RFC6996 private ASN, either 16-bit or 32-bit. The value will be fixed for this router resource. All VPN tunnels that link to this router will have the same local ASN.

yoshi-code-bot

2021-06-11 00:22:02 -0700

[diff] [blame^]

717

"keepaliveInterval": 42, # The interval in seconds between BGP keepalive messages that are sent to the peer. Hold time is three times the interval at which keepalive messages are sent, and the hold time is the maximum number of seconds allowed to elapse between successive keepalive messages that BGP receives from a peer. BGP will use the smaller of either the local hold time value or the peer's hold time value as the hold time for the BGP connection between the two peers. If set, this value must be between 20 and 60. The default is 20.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

718

},

719

"bgpPeers": [ # BGP information that must be configured into the routing stack to establish BGP peering. This information must specify the peer ASN and either the interface name, IP address, or peer IP address. Please refer to RFC4273.

720

{

721

"advertiseMode": "A String", # User-specified flag to indicate which mode to use for advertisement.

yoshi-code-bot

2021-06-11 00:22:02 -0700

[diff] [blame^]

722

"advertisedGroups": [ # User-specified list of prefix groups to advertise in custom mode, which can take one of the following options: - ALL_SUBNETS: Advertises all available subnets, including peer VPC subnets. - ALL_VPC_SUBNETS: Advertises the router's own VPC subnets. Note that this field can only be populated if advertise_mode is CUSTOM and overrides the list defined for the router (in the "bgp" message). These groups are advertised in addition to any specified prefixes. Leave this field blank to advertise no custom groups.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

723

"A String",

724

],

725

"advertisedIpRanges": [ # User-specified list of individual IP ranges to advertise in custom mode. This field can only be populated if advertise_mode is CUSTOM and overrides the list defined for the router (in the "bgp" message). These IP ranges are advertised in addition to any specified groups. Leave this field blank to advertise no custom IP ranges.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

726

{ # Description-tagged IP ranges for the router to advertise.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

727

"description": "A String", # User-specified description for the IP range.

728

"range": "A String", # The IP range to advertise. The value must be a CIDR-formatted string.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

729

},

730

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

731

"advertisedRoutePriority": 42, # The priority of routes advertised to this BGP peer. Where there is more than one matching route of maximum length, the routes with the lowest priority value win.

yoshi-code-bot

2021-06-11 00:22:02 -0700

[diff] [blame^]

732

"enable": "A String", # The status of the BGP peer connection. If set to FALSE, any active session with the peer is terminated and all associated routing information is removed. If set to TRUE, the peer connection can be established with routing information. The default is TRUE.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

733

"interfaceName": "A String", # Name of the interface the BGP peer is associated with.

734

"ipAddress": "A String", # IP address of the interface inside Google Cloud Platform. Only IPv4 is supported.

yoshi-code-bot

2021-06-11 00:22:02 -0700

[diff] [blame^]

735

"managementType": "A String", # [Output Only] The resource that configures and manages this BGP peer. - MANAGED_BY_USER is the default value and can be managed by you or other users - MANAGED_BY_ATTACHMENT is a BGP peer that is configured and managed by Cloud Interconnect, specifically by an InterconnectAttachment of type PARTNER. Google automatically creates, updates, and deletes this type of BGP peer when the PARTNER InterconnectAttachment is created, updated, or deleted.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

736

"name": "A String", # Name of this BGP peer. 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.

737

"peerAsn": 42, # Peer BGP Autonomous System Number (ASN). Each BGP interface may use a different value.

738

"peerIpAddress": "A String", # IP address of the BGP interface outside Google Cloud Platform. Only IPv4 is supported.

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

739

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

740

],

741

"creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.

742

"description": "A String", # An optional description of this resource. Provide this property when you create the resource.

yoshi-code-bot

2021-06-11 00:22:02 -0700

[diff] [blame^]

743

"encryptedInterconnectRouter": True or False, # Indicates if a router is dedicated for use with encrypted VLAN attachments (interconnectAttachments). Not currently available publicly.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

744

"id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.

745

"interfaces": [ # Router interfaces. Each interface requires either one linked resource, (for example, linkedVpnTunnel), or IP address and IP address range (for example, ipRange), or both.

746

{

747

"ipRange": "A String", # IP address and range of the interface. The IP range must be in the RFC3927 link-local IP address space. The value must be a CIDR-formatted string, for example: 169.254.0.1/30. NOTE: Do not truncate the address as it represents the IP address of the interface.

748

"linkedInterconnectAttachment": "A String", # URI of the linked Interconnect attachment. It must be in the same region as the router. Each interface can have one linked resource, which can be a VPN tunnel, an Interconnect attachment, or a virtual machine instance.

749

"linkedVpnTunnel": "A String", # URI of the linked VPN tunnel, which must be in the same region as the router. Each interface can have one linked resource, which can be a VPN tunnel, an Interconnect attachment, or a virtual machine instance.

yoshi-code-bot

2021-06-11 00:22:02 -0700

[diff] [blame^]

750

"managementType": "A String", # [Output Only] The resource that configures and manages this interface. - MANAGED_BY_USER is the default value and can be managed directly by users. - MANAGED_BY_ATTACHMENT is an interface that is configured and managed by Cloud Interconnect, specifically, by an InterconnectAttachment of type PARTNER. Google automatically creates, updates, and deletes this type of interface when the PARTNER InterconnectAttachment is created, updated, or deleted.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

751

"name": "A String", # Name of this interface entry. 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.

752

},

753

],

754

"kind": "compute#router", # [Output Only] Type of resource. Always compute#router for routers.

755

"name": "A String", # 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.

756

"nats": [ # A list of NAT services created in this router.

757

{ # Represents a Nat resource. It enables the VMs within the specified subnetworks to access Internet without external IP addresses. It specifies a list of subnetworks (and the ranges within) that want to use NAT. Customers can also provide the external IPs that would be used for NAT. GCP would auto-allocate ephemeral IPs if no external IPs are provided.

758

"drainNatIps": [ # A list of URLs of the IP resources to be drained. These IPs must be valid static external IPs that have been assigned to the NAT. These IPs should be used for updating/patching a NAT only.

759

"A String",

760

],

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

761

"enableEndpointIndependentMapping": True or False,

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

762

"icmpIdleTimeoutSec": 42, # Timeout (in seconds) for ICMP connections. Defaults to 30s if not set.

763

"logConfig": { # Configuration of logging on a NAT. # Configure logging on this NAT.

764

"enable": True or False, # Indicates whether or not to export logs. This is false by default.

yoshi-code-bot

2021-06-11 00:22:02 -0700

[diff] [blame^]

765

"filter": "A String", # Specify the desired filtering of logs on this NAT. If unspecified, logs are exported for all connections handled by this NAT. This option can take one of the following values: - ERRORS_ONLY: Export logs only for connection failures. - TRANSLATIONS_ONLY: Export logs only for successful connections. - ALL: Export logs for all connections, successful and unsuccessful.

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

766

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

767

"minPortsPerVm": 42, # Minimum number of ports allocated to a VM from this NAT config. If not set, a default number of ports is allocated to a VM. This is rounded up to the nearest power of 2. For example, if the value of this field is 50, at least 64 ports are allocated to a VM.

768

"name": "A String", # Unique name of this Nat service. The name must be 1-63 characters long and comply with RFC1035.

yoshi-code-bot

2021-06-11 00:22:02 -0700

[diff] [blame^]

769

"natIpAllocateOption": "A String", # Specify the NatIpAllocateOption, which can take one of the following values: - MANUAL_ONLY: Uses only Nat IP addresses provided by customers. When there are not enough specified Nat IPs, the Nat service fails for new VMs. - AUTO_ONLY: Nat IPs are allocated by Google Cloud Platform; customers can't specify any Nat IPs. When choosing AUTO_ONLY, then nat_ip should be empty.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

770

"natIps": [ # A list of URLs of the IP resources used for this Nat service. These IP addresses must be valid static external IP addresses assigned to the project.

771

"A String",

772

],

yoshi-code-bot

2021-06-11 00:22:02 -0700

[diff] [blame^]

773

"sourceSubnetworkIpRangesToNat": "A String", # Specify the Nat option, which can take one of the following values: - ALL_SUBNETWORKS_ALL_IP_RANGES: All of the IP ranges in every Subnetwork are allowed to Nat. - ALL_SUBNETWORKS_ALL_PRIMARY_IP_RANGES: All of the primary IP ranges in every Subnetwork are allowed to Nat. - LIST_OF_SUBNETWORKS: A list of Subnetworks are allowed to Nat (specified in the field subnetwork below) The default is SUBNETWORK_IP_RANGE_TO_NAT_OPTION_UNSPECIFIED. Note that if this field contains ALL_SUBNETWORKS_ALL_IP_RANGES or ALL_SUBNETWORKS_ALL_PRIMARY_IP_RANGES, then there should not be any other Router.Nat section in any Router for this network in this region.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

774

"subnetworks": [ # A list of Subnetwork resources whose traffic should be translated by NAT Gateway. It is used only when LIST_OF_SUBNETWORKS is selected for the SubnetworkIpRangeToNatOption above.

775

{ # Defines the IP ranges that want to use NAT for a subnetwork.

776

"name": "A String", # URL for the subnetwork resource that will use NAT.

777

"secondaryIpRangeNames": [ # A list of the secondary ranges of the Subnetwork that are allowed to use NAT. This can be populated only if "LIST_OF_SECONDARY_IP_RANGES" is one of the values in source_ip_ranges_to_nat.

778

"A String",

779

],

780

"sourceIpRangesToNat": [ # Specify the options for NAT ranges in the Subnetwork. All options of a single value are valid except NAT_IP_RANGE_OPTION_UNSPECIFIED. The only valid option with multiple values is: ["PRIMARY_IP_RANGE", "LIST_OF_SECONDARY_IP_RANGES"] Default: [ALL_IP_RANGES]

"A String",

],

},

],

"tcpEstablishedIdleTimeoutSec": 42, # Timeout (in seconds) for TCP established connections. Defaults to 1200s if not set.

786

"tcpTransitoryIdleTimeoutSec": 42, # Timeout (in seconds) for TCP transitory connections. Defaults to 30s if not set.

787

"udpIdleTimeoutSec": 42, # Timeout (in seconds) for UDP connections. Defaults to 30s if not set.

788

},

789

],

790

"network": "A String", # URI of the network to which this router belongs.

791

"region": "A String", # [Output Only] URI of the region where the router resides. You must specify this field as part of the HTTP request URL. It is not settable as a field in the request body.

792

"selfLink": "A String", # [Output Only] Server-defined URL for the resource.

793

}

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

794

yoshi-code-bot

2021-06-11 00:22:02 -0700

[diff] [blame^]

795

requestId: string, An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000).

796

x__xgafv: string, V1 error format.

797

Allowed values

798

1 - v1 error format

799

2 - v2 error format

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

800

801

Returns:

802

An object of the form:

803

yoshi-code-bot

2021-06-11 00:22:02 -0700

[diff] [blame^]

804

{ # Represents an Operation resource. Google Compute Engine has three Operation resources: * [Global](/compute/docs/reference/rest/v1/globalOperations) * [Regional](/compute/docs/reference/rest/v1/regionOperations) * [Zonal](/compute/docs/reference/rest/v1/zoneOperations) You can use an operation resource to manage asynchronous API requests. For more information, read Handling API responses. Operations can be global, regional or zonal. - For global operations, use the `globalOperations` resource. - For regional operations, use the `regionOperations` resource. - For zonal operations, use the `zonalOperations` resource. For more information, read Global, Regional, and Zonal Resources.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

805

"clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise.

806

"creationTimestamp": "A String", # [Deprecated] This field is deprecated.

807

"description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.

808

"endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.

809

"error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.

810

"errors": [ # [Output Only] The array of errors encountered while processing this operation.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

811

{

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

812

"code": "A String", # [Output Only] The error type identifier for this error.

813

"location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.

814

"message": "A String", # [Output Only] An optional, human-readable error message.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

815

},

816

],

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

817

},

818

"httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as `NOT FOUND`.

819

"httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error status code that was returned. For example, a `404` means the resource was not found.

820

"id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server.

821

"insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.

822

"kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources.

823

"name": "A String", # [Output Only] Name of the operation.

yoshi-code-bot

2021-03-02 11:49:08 -0800

[diff] [blame]

824

"operationGroupId": "A String", # [Output Only] An ID that represents a group of operations, such as when a group of operations results from a `bulkInsert` API request.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

825

"operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on.

826

"progress": 42, # [Output Only] An optional progress indicator that ranges from 0 to 100. There is no requirement that this be linear or support any granularity of operations. This should not be used to guess when the operation will be complete. This number should monotonically increase as the operation progresses.

827

"region": "A String", # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations.

828

"selfLink": "A String", # [Output Only] Server-defined URL for the resource.

829

"startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.

830

"status": "A String", # [Output Only] The status of the operation, which can be one of the following: `PENDING`, `RUNNING`, or `DONE`.

831

"statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.

832

"targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.

833

"targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. For operations related to creating a snapshot, this points to the persistent disk that the snapshot was created from.

834

"user": "A String", # [Output Only] User who requested the operation, for example: `user@example.com`.

835

"warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.

836

{

837

"code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.

yoshi-code-bot

2021-06-11 00:22:02 -0700

[diff] [blame^]

838

"data": [ # [Output Only] Metadata about this warning in key: value format. For example: "data": [ { "key": "scope", "value": "zones/us-east1-d" }

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

839

{

840

"key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).

841

"value": "A String", # [Output Only] A warning data value corresponding to the key.

842

},

843

],

844

"message": "A String", # [Output Only] A human-readable description of the warning code.

845

},

846

],

847

"zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only applicable when performing per-zone operations.

848

}</pre>

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

</div>

yoshi-code-bot

2021-06-11 00:22:02 -0700

[diff] [blame^]

852

<code class="details" id="list">list(project, region, filter=None, maxResults=None, orderBy=None, pageToken=None, returnPartialSuccess=None, x__xgafv=None)</code>

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

853

<pre>Retrieves a list of Router resources available to the specified project.

854

855

Args:

856

project: string, Project ID for this request. (required)

857

region: string, Name of the region for this request. (required)

yoshi-code-bot

2021-06-11 00:22:02 -0700

[diff] [blame^]

858

filter: string, A filter expression that filters resources listed in the response. The expression must specify the field name, a comparison operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The comparison operator must be either `=`, `!=`, `>`, or `<`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true) ```

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

859

maxResults: integer, The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`)

yoshi-code-bot

2021-06-11 00:22:02 -0700

[diff] [blame^]

860

orderBy: string, Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using `orderBy="creationTimestamp desc"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by `name` or `creationTimestamp desc` is supported.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

861

pageToken: string, Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results.

yoshi-code-bot

2021-03-02 11:49:08 -0800

[diff] [blame]

862

returnPartialSuccess: boolean, Opt-in for partial success behavior which provides partial results in case of failure. The default value is false.

yoshi-code-bot

2021-06-11 00:22:02 -0700

[diff] [blame^]

863

x__xgafv: string, V1 error format.

864

Allowed values

865

1 - v1 error format

866

2 - v2 error format

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

867

868

Returns:

869

An object of the form:

870

871

{ # Contains a list of Router resources.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

872

"id": "A String", # [Output Only] Unique identifier for the resource; defined by the server.

873

"items": [ # A list of Router resources.

yoshi-code-bot

2021-06-11 00:22:02 -0700

[diff] [blame^]

874

{ # Represents a Cloud Router resource. For more information about Cloud Router, read the Cloud Router overview.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

875

"bgp": { # BGP information specific to this router.

876

"advertiseMode": "A String", # User-specified flag to indicate which mode to use for advertisement. The options are DEFAULT or CUSTOM.

877

"advertisedGroups": [ # User-specified list of prefix groups to advertise in custom mode. This field can only be populated if advertise_mode is CUSTOM and is advertised to all peers of the router. These groups will be advertised in addition to any specified prefixes. Leave this field blank to advertise no custom groups.

878

"A String",

879

],

880

"advertisedIpRanges": [ # User-specified list of individual IP ranges to advertise in custom mode. This field can only be populated if advertise_mode is CUSTOM and is advertised to all peers of the router. These IP ranges will be advertised in addition to any specified groups. Leave this field blank to advertise no custom IP ranges.

881

{ # Description-tagged IP ranges for the router to advertise.

882

"description": "A String", # User-specified description for the IP range.

883

"range": "A String", # The IP range to advertise. The value must be a CIDR-formatted string.

884

},

885

],

886

"asn": 42, # Local BGP Autonomous System Number (ASN). Must be an RFC6996 private ASN, either 16-bit or 32-bit. The value will be fixed for this router resource. All VPN tunnels that link to this router will have the same local ASN.

yoshi-code-bot

2021-06-11 00:22:02 -0700

[diff] [blame^]

887

"keepaliveInterval": 42, # The interval in seconds between BGP keepalive messages that are sent to the peer. Hold time is three times the interval at which keepalive messages are sent, and the hold time is the maximum number of seconds allowed to elapse between successive keepalive messages that BGP receives from a peer. BGP will use the smaller of either the local hold time value or the peer's hold time value as the hold time for the BGP connection between the two peers. If set, this value must be between 20 and 60. The default is 20.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

888

},

889

"bgpPeers": [ # BGP information that must be configured into the routing stack to establish BGP peering. This information must specify the peer ASN and either the interface name, IP address, or peer IP address. Please refer to RFC4273.

890

{

891

"advertiseMode": "A String", # User-specified flag to indicate which mode to use for advertisement.

yoshi-code-bot

2021-06-11 00:22:02 -0700

[diff] [blame^]

892

"advertisedGroups": [ # User-specified list of prefix groups to advertise in custom mode, which can take one of the following options: - ALL_SUBNETS: Advertises all available subnets, including peer VPC subnets. - ALL_VPC_SUBNETS: Advertises the router's own VPC subnets. Note that this field can only be populated if advertise_mode is CUSTOM and overrides the list defined for the router (in the "bgp" message). These groups are advertised in addition to any specified prefixes. Leave this field blank to advertise no custom groups.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

893

"A String",

894

],

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

895

"advertisedIpRanges": [ # User-specified list of individual IP ranges to advertise in custom mode. This field can only be populated if advertise_mode is CUSTOM and overrides the list defined for the router (in the "bgp" message). These IP ranges are advertised in addition to any specified groups. Leave this field blank to advertise no custom IP ranges.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

896

{ # Description-tagged IP ranges for the router to advertise.

897

"description": "A String", # User-specified description for the IP range.

898

"range": "A String", # The IP range to advertise. The value must be a CIDR-formatted string.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

899

},

900

],

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

901

"advertisedRoutePriority": 42, # The priority of routes advertised to this BGP peer. Where there is more than one matching route of maximum length, the routes with the lowest priority value win.

yoshi-code-bot

2021-06-11 00:22:02 -0700

[diff] [blame^]

902

"enable": "A String", # The status of the BGP peer connection. If set to FALSE, any active session with the peer is terminated and all associated routing information is removed. If set to TRUE, the peer connection can be established with routing information. The default is TRUE.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

903

"interfaceName": "A String", # Name of the interface the BGP peer is associated with.

904

"ipAddress": "A String", # IP address of the interface inside Google Cloud Platform. Only IPv4 is supported.

yoshi-code-bot

2021-06-11 00:22:02 -0700

[diff] [blame^]

905

"managementType": "A String", # [Output Only] The resource that configures and manages this BGP peer. - MANAGED_BY_USER is the default value and can be managed by you or other users - MANAGED_BY_ATTACHMENT is a BGP peer that is configured and managed by Cloud Interconnect, specifically by an InterconnectAttachment of type PARTNER. Google automatically creates, updates, and deletes this type of BGP peer when the PARTNER InterconnectAttachment is created, updated, or deleted.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

906

"name": "A String", # Name of this BGP peer. 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.

907

"peerAsn": 42, # Peer BGP Autonomous System Number (ASN). Each BGP interface may use a different value.

908

"peerIpAddress": "A String", # IP address of the BGP interface outside Google Cloud Platform. Only IPv4 is supported.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

909

},

910

],

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

911

"creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.

912

"description": "A String", # An optional description of this resource. Provide this property when you create the resource.

yoshi-code-bot

2021-06-11 00:22:02 -0700

[diff] [blame^]

913

"encryptedInterconnectRouter": True or False, # Indicates if a router is dedicated for use with encrypted VLAN attachments (interconnectAttachments). Not currently available publicly.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

914

"id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.

915

"interfaces": [ # Router interfaces. Each interface requires either one linked resource, (for example, linkedVpnTunnel), or IP address and IP address range (for example, ipRange), or both.

916

{

917

"ipRange": "A String", # IP address and range of the interface. The IP range must be in the RFC3927 link-local IP address space. The value must be a CIDR-formatted string, for example: 169.254.0.1/30. NOTE: Do not truncate the address as it represents the IP address of the interface.

918

"linkedInterconnectAttachment": "A String", # URI of the linked Interconnect attachment. It must be in the same region as the router. Each interface can have one linked resource, which can be a VPN tunnel, an Interconnect attachment, or a virtual machine instance.

919

"linkedVpnTunnel": "A String", # URI of the linked VPN tunnel, which must be in the same region as the router. Each interface can have one linked resource, which can be a VPN tunnel, an Interconnect attachment, or a virtual machine instance.

yoshi-code-bot

2021-06-11 00:22:02 -0700

[diff] [blame^]

920

"managementType": "A String", # [Output Only] The resource that configures and manages this interface. - MANAGED_BY_USER is the default value and can be managed directly by users. - MANAGED_BY_ATTACHMENT is an interface that is configured and managed by Cloud Interconnect, specifically, by an InterconnectAttachment of type PARTNER. Google automatically creates, updates, and deletes this type of interface when the PARTNER InterconnectAttachment is created, updated, or deleted.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

921

"name": "A String", # Name of this interface entry. 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.

922

},

923

],

924

"kind": "compute#router", # [Output Only] Type of resource. Always compute#router for routers.

925

"name": "A String", # 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.

926

"nats": [ # A list of NAT services created in this router.

927

{ # Represents a Nat resource. It enables the VMs within the specified subnetworks to access Internet without external IP addresses. It specifies a list of subnetworks (and the ranges within) that want to use NAT. Customers can also provide the external IPs that would be used for NAT. GCP would auto-allocate ephemeral IPs if no external IPs are provided.

928

"drainNatIps": [ # A list of URLs of the IP resources to be drained. These IPs must be valid static external IPs that have been assigned to the NAT. These IPs should be used for updating/patching a NAT only.

929

"A String",

930

],

931

"enableEndpointIndependentMapping": True or False,

932

"icmpIdleTimeoutSec": 42, # Timeout (in seconds) for ICMP connections. Defaults to 30s if not set.

933

"logConfig": { # Configuration of logging on a NAT. # Configure logging on this NAT.

934

"enable": True or False, # Indicates whether or not to export logs. This is false by default.

yoshi-code-bot

2021-06-11 00:22:02 -0700

[diff] [blame^]

935

"filter": "A String", # Specify the desired filtering of logs on this NAT. If unspecified, logs are exported for all connections handled by this NAT. This option can take one of the following values: - ERRORS_ONLY: Export logs only for connection failures. - TRANSLATIONS_ONLY: Export logs only for successful connections. - ALL: Export logs for all connections, successful and unsuccessful.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

936

},

937

"minPortsPerVm": 42, # Minimum number of ports allocated to a VM from this NAT config. If not set, a default number of ports is allocated to a VM. This is rounded up to the nearest power of 2. For example, if the value of this field is 50, at least 64 ports are allocated to a VM.

938

"name": "A String", # Unique name of this Nat service. The name must be 1-63 characters long and comply with RFC1035.

yoshi-code-bot

2021-06-11 00:22:02 -0700

[diff] [blame^]

939

"natIpAllocateOption": "A String", # Specify the NatIpAllocateOption, which can take one of the following values: - MANUAL_ONLY: Uses only Nat IP addresses provided by customers. When there are not enough specified Nat IPs, the Nat service fails for new VMs. - AUTO_ONLY: Nat IPs are allocated by Google Cloud Platform; customers can't specify any Nat IPs. When choosing AUTO_ONLY, then nat_ip should be empty.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

940

"natIps": [ # A list of URLs of the IP resources used for this Nat service. These IP addresses must be valid static external IP addresses assigned to the project.

941

"A String",

942

],

yoshi-code-bot

2021-06-11 00:22:02 -0700

[diff] [blame^]

943

"sourceSubnetworkIpRangesToNat": "A String", # Specify the Nat option, which can take one of the following values: - ALL_SUBNETWORKS_ALL_IP_RANGES: All of the IP ranges in every Subnetwork are allowed to Nat. - ALL_SUBNETWORKS_ALL_PRIMARY_IP_RANGES: All of the primary IP ranges in every Subnetwork are allowed to Nat. - LIST_OF_SUBNETWORKS: A list of Subnetworks are allowed to Nat (specified in the field subnetwork below) The default is SUBNETWORK_IP_RANGE_TO_NAT_OPTION_UNSPECIFIED. Note that if this field contains ALL_SUBNETWORKS_ALL_IP_RANGES or ALL_SUBNETWORKS_ALL_PRIMARY_IP_RANGES, then there should not be any other Router.Nat section in any Router for this network in this region.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

944

"subnetworks": [ # A list of Subnetwork resources whose traffic should be translated by NAT Gateway. It is used only when LIST_OF_SUBNETWORKS is selected for the SubnetworkIpRangeToNatOption above.

945

{ # Defines the IP ranges that want to use NAT for a subnetwork.

946

"name": "A String", # URL for the subnetwork resource that will use NAT.

947

"secondaryIpRangeNames": [ # A list of the secondary ranges of the Subnetwork that are allowed to use NAT. This can be populated only if "LIST_OF_SECONDARY_IP_RANGES" is one of the values in source_ip_ranges_to_nat.

948

"A String",

949

],

950

"sourceIpRangesToNat": [ # Specify the options for NAT ranges in the Subnetwork. All options of a single value are valid except NAT_IP_RANGE_OPTION_UNSPECIFIED. The only valid option with multiple values is: ["PRIMARY_IP_RANGE", "LIST_OF_SECONDARY_IP_RANGES"] Default: [ALL_IP_RANGES]

"A String",

],

},

],

"tcpEstablishedIdleTimeoutSec": 42, # Timeout (in seconds) for TCP established connections. Defaults to 1200s if not set.

956

"tcpTransitoryIdleTimeoutSec": 42, # Timeout (in seconds) for TCP transitory connections. Defaults to 30s if not set.

957

"udpIdleTimeoutSec": 42, # Timeout (in seconds) for UDP connections. Defaults to 30s if not set.

958

},

959

],

960

"network": "A String", # URI of the network to which this router belongs.

961

"region": "A String", # [Output Only] URI of the region where the router resides. You must specify this field as part of the HTTP request URL. It is not settable as a field in the request body.

962

"selfLink": "A String", # [Output Only] Server-defined URL for the resource.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

963

},

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

964

],

965

"kind": "compute#routerList", # [Output Only] Type of resource. Always compute#router for routers.

966

"nextPageToken": "A String", # [Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results.

967

"selfLink": "A String", # [Output Only] Server-defined URL for this resource.

968

"warning": { # [Output Only] Informational warning message.

969

"code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.

yoshi-code-bot

2021-06-11 00:22:02 -0700

[diff] [blame^]

970

"data": [ # [Output Only] Metadata about this warning in key: value format. For example: "data": [ { "key": "scope", "value": "zones/us-east1-d" }

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

971

{

972

"key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).

973

"value": "A String", # [Output Only] A warning data value corresponding to the key.

974

},

975

],

976

"message": "A String", # [Output Only] A human-readable description of the warning code.

977

},

978

}</pre>

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

</div>

<code class="details" id="list_next">list_next(previous_request, previous_response)</code>

983

<pre>Retrieves the next page of results.

984

985

Args:

986

previous_request: The request for the previous page. (required)

987

previous_response: The response from the request for the previous page. (required)

988

989

Returns:

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

990

A request object that you can call 'execute()' on to request the next

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

991

page. Returns None if there are no more items in the collection.

</pre>

</div>

yoshi-code-bot

2021-06-11 00:22:02 -0700

[diff] [blame^]

996

<code class="details" id="patch">patch(project, region, router, body=None, requestId=None, x__xgafv=None)</code>

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

997

<pre>Patches the specified Router resource with the data included in the request. This method supports PATCH semantics and uses JSON merge patch format and processing rules.

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

998

999

Args:

1000

project: string, Project ID for this request. (required)

1001

region: string, Name of the region for this request. (required)

Sai Cheemalapati

4ba8c23

2017-06-06 18:46:08 -0400

[diff] [blame]

1002

router: string, Name of the Router resource to patch. (required)

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

1003

body: object, The request body.

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

1004

The object takes the form of:

1005

yoshi-code-bot

2021-06-11 00:22:02 -0700

[diff] [blame^]

1006

{ # Represents a Cloud Router resource. For more information about Cloud Router, read the Cloud Router overview.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1007

"bgp": { # BGP information specific to this router.

1008

"advertiseMode": "A String", # User-specified flag to indicate which mode to use for advertisement. The options are DEFAULT or CUSTOM.

1009

"advertisedGroups": [ # User-specified list of prefix groups to advertise in custom mode. This field can only be populated if advertise_mode is CUSTOM and is advertised to all peers of the router. These groups will be advertised in addition to any specified prefixes. Leave this field blank to advertise no custom groups.

1010

"A String",

1011

],

1012

"advertisedIpRanges": [ # User-specified list of individual IP ranges to advertise in custom mode. This field can only be populated if advertise_mode is CUSTOM and is advertised to all peers of the router. These IP ranges will be advertised in addition to any specified groups. Leave this field blank to advertise no custom IP ranges.

1013

{ # Description-tagged IP ranges for the router to advertise.

1014

"description": "A String", # User-specified description for the IP range.

1015

"range": "A String", # The IP range to advertise. The value must be a CIDR-formatted string.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1016

},

1017

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1018

"asn": 42, # Local BGP Autonomous System Number (ASN). Must be an RFC6996 private ASN, either 16-bit or 32-bit. The value will be fixed for this router resource. All VPN tunnels that link to this router will have the same local ASN.

yoshi-code-bot

2021-06-11 00:22:02 -0700

[diff] [blame^]

1019

"keepaliveInterval": 42, # The interval in seconds between BGP keepalive messages that are sent to the peer. Hold time is three times the interval at which keepalive messages are sent, and the hold time is the maximum number of seconds allowed to elapse between successive keepalive messages that BGP receives from a peer. BGP will use the smaller of either the local hold time value or the peer's hold time value as the hold time for the BGP connection between the two peers. If set, this value must be between 20 and 60. The default is 20.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1020

},

1021

"bgpPeers": [ # BGP information that must be configured into the routing stack to establish BGP peering. This information must specify the peer ASN and either the interface name, IP address, or peer IP address. Please refer to RFC4273.

1022

{

1023

"advertiseMode": "A String", # User-specified flag to indicate which mode to use for advertisement.

yoshi-code-bot

2021-06-11 00:22:02 -0700

[diff] [blame^]

1024

"advertisedGroups": [ # User-specified list of prefix groups to advertise in custom mode, which can take one of the following options: - ALL_SUBNETS: Advertises all available subnets, including peer VPC subnets. - ALL_VPC_SUBNETS: Advertises the router's own VPC subnets. Note that this field can only be populated if advertise_mode is CUSTOM and overrides the list defined for the router (in the "bgp" message). These groups are advertised in addition to any specified prefixes. Leave this field blank to advertise no custom groups.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1025

"A String",

1026

],

1027

"advertisedIpRanges": [ # User-specified list of individual IP ranges to advertise in custom mode. This field can only be populated if advertise_mode is CUSTOM and overrides the list defined for the router (in the "bgp" message). These IP ranges are advertised in addition to any specified groups. Leave this field blank to advertise no custom IP ranges.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1028

{ # Description-tagged IP ranges for the router to advertise.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1029

"description": "A String", # User-specified description for the IP range.

1030

"range": "A String", # The IP range to advertise. The value must be a CIDR-formatted string.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1031

},

1032

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1033

"advertisedRoutePriority": 42, # The priority of routes advertised to this BGP peer. Where there is more than one matching route of maximum length, the routes with the lowest priority value win.

yoshi-code-bot

2021-06-11 00:22:02 -0700

[diff] [blame^]

1034

"enable": "A String", # The status of the BGP peer connection. If set to FALSE, any active session with the peer is terminated and all associated routing information is removed. If set to TRUE, the peer connection can be established with routing information. The default is TRUE.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1035

"interfaceName": "A String", # Name of the interface the BGP peer is associated with.

1036

"ipAddress": "A String", # IP address of the interface inside Google Cloud Platform. Only IPv4 is supported.

yoshi-code-bot

2021-06-11 00:22:02 -0700

[diff] [blame^]

1037

"managementType": "A String", # [Output Only] The resource that configures and manages this BGP peer. - MANAGED_BY_USER is the default value and can be managed by you or other users - MANAGED_BY_ATTACHMENT is a BGP peer that is configured and managed by Cloud Interconnect, specifically by an InterconnectAttachment of type PARTNER. Google automatically creates, updates, and deletes this type of BGP peer when the PARTNER InterconnectAttachment is created, updated, or deleted.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1038

"name": "A String", # Name of this BGP peer. 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.

1039

"peerAsn": 42, # Peer BGP Autonomous System Number (ASN). Each BGP interface may use a different value.

1040

"peerIpAddress": "A String", # IP address of the BGP interface outside Google Cloud Platform. Only IPv4 is supported.

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

1041

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1042

],

1043

"creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.

1044

"description": "A String", # An optional description of this resource. Provide this property when you create the resource.

yoshi-code-bot

2021-06-11 00:22:02 -0700

[diff] [blame^]

1045

"encryptedInterconnectRouter": True or False, # Indicates if a router is dedicated for use with encrypted VLAN attachments (interconnectAttachments). Not currently available publicly.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1046

"id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.

1047

"interfaces": [ # Router interfaces. Each interface requires either one linked resource, (for example, linkedVpnTunnel), or IP address and IP address range (for example, ipRange), or both.

1048

{

1049

"ipRange": "A String", # IP address and range of the interface. The IP range must be in the RFC3927 link-local IP address space. The value must be a CIDR-formatted string, for example: 169.254.0.1/30. NOTE: Do not truncate the address as it represents the IP address of the interface.

1050

"linkedInterconnectAttachment": "A String", # URI of the linked Interconnect attachment. It must be in the same region as the router. Each interface can have one linked resource, which can be a VPN tunnel, an Interconnect attachment, or a virtual machine instance.

1051

"linkedVpnTunnel": "A String", # URI of the linked VPN tunnel, which must be in the same region as the router. Each interface can have one linked resource, which can be a VPN tunnel, an Interconnect attachment, or a virtual machine instance.

yoshi-code-bot

2021-06-11 00:22:02 -0700

[diff] [blame^]

1052

"managementType": "A String", # [Output Only] The resource that configures and manages this interface. - MANAGED_BY_USER is the default value and can be managed directly by users. - MANAGED_BY_ATTACHMENT is an interface that is configured and managed by Cloud Interconnect, specifically, by an InterconnectAttachment of type PARTNER. Google automatically creates, updates, and deletes this type of interface when the PARTNER InterconnectAttachment is created, updated, or deleted.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1053

"name": "A String", # Name of this interface entry. 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.

1054

},

1055

],

1056

"kind": "compute#router", # [Output Only] Type of resource. Always compute#router for routers.

1057

"name": "A String", # 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.

1058

"nats": [ # A list of NAT services created in this router.

1059

{ # Represents a Nat resource. It enables the VMs within the specified subnetworks to access Internet without external IP addresses. It specifies a list of subnetworks (and the ranges within) that want to use NAT. Customers can also provide the external IPs that would be used for NAT. GCP would auto-allocate ephemeral IPs if no external IPs are provided.

1060

"drainNatIps": [ # A list of URLs of the IP resources to be drained. These IPs must be valid static external IPs that have been assigned to the NAT. These IPs should be used for updating/patching a NAT only.

1061

"A String",

1062

],

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

1063

"enableEndpointIndependentMapping": True or False,

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1064

"icmpIdleTimeoutSec": 42, # Timeout (in seconds) for ICMP connections. Defaults to 30s if not set.

1065

"logConfig": { # Configuration of logging on a NAT. # Configure logging on this NAT.

1066

"enable": True or False, # Indicates whether or not to export logs. This is false by default.

yoshi-code-bot

2021-06-11 00:22:02 -0700

[diff] [blame^]

1067

"filter": "A String", # Specify the desired filtering of logs on this NAT. If unspecified, logs are exported for all connections handled by this NAT. This option can take one of the following values: - ERRORS_ONLY: Export logs only for connection failures. - TRANSLATIONS_ONLY: Export logs only for successful connections. - ALL: Export logs for all connections, successful and unsuccessful.

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

1068

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1069

"minPortsPerVm": 42, # Minimum number of ports allocated to a VM from this NAT config. If not set, a default number of ports is allocated to a VM. This is rounded up to the nearest power of 2. For example, if the value of this field is 50, at least 64 ports are allocated to a VM.

1070

"name": "A String", # Unique name of this Nat service. The name must be 1-63 characters long and comply with RFC1035.

yoshi-code-bot

2021-06-11 00:22:02 -0700

[diff] [blame^]

1071

"natIpAllocateOption": "A String", # Specify the NatIpAllocateOption, which can take one of the following values: - MANUAL_ONLY: Uses only Nat IP addresses provided by customers. When there are not enough specified Nat IPs, the Nat service fails for new VMs. - AUTO_ONLY: Nat IPs are allocated by Google Cloud Platform; customers can't specify any Nat IPs. When choosing AUTO_ONLY, then nat_ip should be empty.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1072

"natIps": [ # A list of URLs of the IP resources used for this Nat service. These IP addresses must be valid static external IP addresses assigned to the project.

1073

"A String",

1074

],

yoshi-code-bot

2021-06-11 00:22:02 -0700

[diff] [blame^]

1075

"sourceSubnetworkIpRangesToNat": "A String", # Specify the Nat option, which can take one of the following values: - ALL_SUBNETWORKS_ALL_IP_RANGES: All of the IP ranges in every Subnetwork are allowed to Nat. - ALL_SUBNETWORKS_ALL_PRIMARY_IP_RANGES: All of the primary IP ranges in every Subnetwork are allowed to Nat. - LIST_OF_SUBNETWORKS: A list of Subnetworks are allowed to Nat (specified in the field subnetwork below) The default is SUBNETWORK_IP_RANGE_TO_NAT_OPTION_UNSPECIFIED. Note that if this field contains ALL_SUBNETWORKS_ALL_IP_RANGES or ALL_SUBNETWORKS_ALL_PRIMARY_IP_RANGES, then there should not be any other Router.Nat section in any Router for this network in this region.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1076

"subnetworks": [ # A list of Subnetwork resources whose traffic should be translated by NAT Gateway. It is used only when LIST_OF_SUBNETWORKS is selected for the SubnetworkIpRangeToNatOption above.

1077

{ # Defines the IP ranges that want to use NAT for a subnetwork.

1078

"name": "A String", # URL for the subnetwork resource that will use NAT.

1079

"secondaryIpRangeNames": [ # A list of the secondary ranges of the Subnetwork that are allowed to use NAT. This can be populated only if "LIST_OF_SECONDARY_IP_RANGES" is one of the values in source_ip_ranges_to_nat.

1080

"A String",

1081

],

1082

"sourceIpRangesToNat": [ # Specify the options for NAT ranges in the Subnetwork. All options of a single value are valid except NAT_IP_RANGE_OPTION_UNSPECIFIED. The only valid option with multiple values is: ["PRIMARY_IP_RANGE", "LIST_OF_SECONDARY_IP_RANGES"] Default: [ALL_IP_RANGES]

"A String",

],

},

],

"tcpEstablishedIdleTimeoutSec": 42, # Timeout (in seconds) for TCP established connections. Defaults to 1200s if not set.

1088

"tcpTransitoryIdleTimeoutSec": 42, # Timeout (in seconds) for TCP transitory connections. Defaults to 30s if not set.

1089

"udpIdleTimeoutSec": 42, # Timeout (in seconds) for UDP connections. Defaults to 30s if not set.

1090

},

1091

],

1092

"network": "A String", # URI of the network to which this router belongs.

1093

"region": "A String", # [Output Only] URI of the region where the router resides. You must specify this field as part of the HTTP request URL. It is not settable as a field in the request body.

1094

"selfLink": "A String", # [Output Only] Server-defined URL for the resource.

1095

}

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

1096

yoshi-code-bot

2021-06-11 00:22:02 -0700

[diff] [blame^]

1097

requestId: string, An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000).

1098

x__xgafv: string, V1 error format.

1099

Allowed values

1100

1 - v1 error format

1101

2 - v2 error format

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

1102

1103

Returns:

1104

An object of the form:

1105

yoshi-code-bot

2021-06-11 00:22:02 -0700

[diff] [blame^]

1106

{ # Represents an Operation resource. Google Compute Engine has three Operation resources: * [Global](/compute/docs/reference/rest/v1/globalOperations) * [Regional](/compute/docs/reference/rest/v1/regionOperations) * [Zonal](/compute/docs/reference/rest/v1/zoneOperations) You can use an operation resource to manage asynchronous API requests. For more information, read Handling API responses. Operations can be global, regional or zonal. - For global operations, use the `globalOperations` resource. - For regional operations, use the `regionOperations` resource. - For zonal operations, use the `zonalOperations` resource. For more information, read Global, Regional, and Zonal Resources.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

1107

"clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise.

1108

"creationTimestamp": "A String", # [Deprecated] This field is deprecated.

1109

"description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.

1110

"endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.

1111

"error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.

1112

"errors": [ # [Output Only] The array of errors encountered while processing this operation.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1113

{

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

1114

"code": "A String", # [Output Only] The error type identifier for this error.

1115

"location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.

1116

"message": "A String", # [Output Only] An optional, human-readable error message.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1117

},

1118

],

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

1119

},

1120

"httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as `NOT FOUND`.

1121

"httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error status code that was returned. For example, a `404` means the resource was not found.

1122

"id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server.

1123

"insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.

1124

"kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources.

1125

"name": "A String", # [Output Only] Name of the operation.

yoshi-code-bot

2021-03-02 11:49:08 -0800

[diff] [blame]

1126

"operationGroupId": "A String", # [Output Only] An ID that represents a group of operations, such as when a group of operations results from a `bulkInsert` API request.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

1127

"operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on.

1128

"progress": 42, # [Output Only] An optional progress indicator that ranges from 0 to 100. There is no requirement that this be linear or support any granularity of operations. This should not be used to guess when the operation will be complete. This number should monotonically increase as the operation progresses.

1129

"region": "A String", # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations.

1130

"selfLink": "A String", # [Output Only] Server-defined URL for the resource.

1131

"startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.

1132

"status": "A String", # [Output Only] The status of the operation, which can be one of the following: `PENDING`, `RUNNING`, or `DONE`.

1133

"statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.

1134

"targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.

1135

"targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. For operations related to creating a snapshot, this points to the persistent disk that the snapshot was created from.

1136

"user": "A String", # [Output Only] User who requested the operation, for example: `user@example.com`.

1137

"warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.

1138

{

1139

"code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.

yoshi-code-bot

2021-06-11 00:22:02 -0700

[diff] [blame^]

1140

"data": [ # [Output Only] Metadata about this warning in key: value format. For example: "data": [ { "key": "scope", "value": "zones/us-east1-d" }

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

1141

{

1142

"key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).

1143

"value": "A String", # [Output Only] A warning data value corresponding to the key.

1144

},

1145

],

1146

"message": "A String", # [Output Only] A human-readable description of the warning code.

1147

},

1148

],

1149

"zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only applicable when performing per-zone operations.

1150

}</pre>

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

</div>

yoshi-code-bot

2021-06-11 00:22:02 -0700

[diff] [blame^]

1154

<code class="details" id="preview">preview(project, region, router, body=None, x__xgafv=None)</code>

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

1155

<pre>Preview fields auto-generated during router create and update operations. Calling this method does NOT create or update the router.

1156

1157

Args:

1158

project: string, Project ID for this request. (required)

1159

region: string, Name of the region for this request. (required)

1160

router: string, Name of the Router resource to query. (required)

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

1161

body: object, The request body.

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

1162

The object takes the form of:

1163

yoshi-code-bot

2021-06-11 00:22:02 -0700

[diff] [blame^]

1164

{ # Represents a Cloud Router resource. For more information about Cloud Router, read the Cloud Router overview.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1165

"bgp": { # BGP information specific to this router.

1166

"advertiseMode": "A String", # User-specified flag to indicate which mode to use for advertisement. The options are DEFAULT or CUSTOM.

1167

"advertisedGroups": [ # User-specified list of prefix groups to advertise in custom mode. This field can only be populated if advertise_mode is CUSTOM and is advertised to all peers of the router. These groups will be advertised in addition to any specified prefixes. Leave this field blank to advertise no custom groups.

1168

"A String",

1169

],

1170

"advertisedIpRanges": [ # User-specified list of individual IP ranges to advertise in custom mode. This field can only be populated if advertise_mode is CUSTOM and is advertised to all peers of the router. These IP ranges will be advertised in addition to any specified groups. Leave this field blank to advertise no custom IP ranges.

1171

{ # Description-tagged IP ranges for the router to advertise.

1172

"description": "A String", # User-specified description for the IP range.

1173

"range": "A String", # The IP range to advertise. The value must be a CIDR-formatted string.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1174

},

1175

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1176

"asn": 42, # Local BGP Autonomous System Number (ASN). Must be an RFC6996 private ASN, either 16-bit or 32-bit. The value will be fixed for this router resource. All VPN tunnels that link to this router will have the same local ASN.

yoshi-code-bot

2021-06-11 00:22:02 -0700

[diff] [blame^]

1177

"keepaliveInterval": 42, # The interval in seconds between BGP keepalive messages that are sent to the peer. Hold time is three times the interval at which keepalive messages are sent, and the hold time is the maximum number of seconds allowed to elapse between successive keepalive messages that BGP receives from a peer. BGP will use the smaller of either the local hold time value or the peer's hold time value as the hold time for the BGP connection between the two peers. If set, this value must be between 20 and 60. The default is 20.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1178

},

1179

"bgpPeers": [ # BGP information that must be configured into the routing stack to establish BGP peering. This information must specify the peer ASN and either the interface name, IP address, or peer IP address. Please refer to RFC4273.

1180

{

1181

"advertiseMode": "A String", # User-specified flag to indicate which mode to use for advertisement.

yoshi-code-bot

2021-06-11 00:22:02 -0700

[diff] [blame^]

1182

"advertisedGroups": [ # User-specified list of prefix groups to advertise in custom mode, which can take one of the following options: - ALL_SUBNETS: Advertises all available subnets, including peer VPC subnets. - ALL_VPC_SUBNETS: Advertises the router's own VPC subnets. Note that this field can only be populated if advertise_mode is CUSTOM and overrides the list defined for the router (in the "bgp" message). These groups are advertised in addition to any specified prefixes. Leave this field blank to advertise no custom groups.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1183

"A String",

1184

],

1185

"advertisedIpRanges": [ # User-specified list of individual IP ranges to advertise in custom mode. This field can only be populated if advertise_mode is CUSTOM and overrides the list defined for the router (in the "bgp" message). These IP ranges are advertised in addition to any specified groups. Leave this field blank to advertise no custom IP ranges.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1186

{ # Description-tagged IP ranges for the router to advertise.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1187

"description": "A String", # User-specified description for the IP range.

1188

"range": "A String", # The IP range to advertise. The value must be a CIDR-formatted string.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1189

},

1190

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1191

"advertisedRoutePriority": 42, # The priority of routes advertised to this BGP peer. Where there is more than one matching route of maximum length, the routes with the lowest priority value win.

yoshi-code-bot

2021-06-11 00:22:02 -0700

[diff] [blame^]

1192

"enable": "A String", # The status of the BGP peer connection. If set to FALSE, any active session with the peer is terminated and all associated routing information is removed. If set to TRUE, the peer connection can be established with routing information. The default is TRUE.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1193

"interfaceName": "A String", # Name of the interface the BGP peer is associated with.

1194

"ipAddress": "A String", # IP address of the interface inside Google Cloud Platform. Only IPv4 is supported.

yoshi-code-bot

2021-06-11 00:22:02 -0700

[diff] [blame^]

1195

"managementType": "A String", # [Output Only] The resource that configures and manages this BGP peer. - MANAGED_BY_USER is the default value and can be managed by you or other users - MANAGED_BY_ATTACHMENT is a BGP peer that is configured and managed by Cloud Interconnect, specifically by an InterconnectAttachment of type PARTNER. Google automatically creates, updates, and deletes this type of BGP peer when the PARTNER InterconnectAttachment is created, updated, or deleted.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1196

"name": "A String", # Name of this BGP peer. 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.

1197

"peerAsn": 42, # Peer BGP Autonomous System Number (ASN). Each BGP interface may use a different value.

1198

"peerIpAddress": "A String", # IP address of the BGP interface outside Google Cloud Platform. Only IPv4 is supported.

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

1199

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1200

],

1201

"creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.

1202

"description": "A String", # An optional description of this resource. Provide this property when you create the resource.

yoshi-code-bot

2021-06-11 00:22:02 -0700

[diff] [blame^]

1203

"encryptedInterconnectRouter": True or False, # Indicates if a router is dedicated for use with encrypted VLAN attachments (interconnectAttachments). Not currently available publicly.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1204

"id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.

1205

"interfaces": [ # Router interfaces. Each interface requires either one linked resource, (for example, linkedVpnTunnel), or IP address and IP address range (for example, ipRange), or both.

1206

{

1207

"ipRange": "A String", # IP address and range of the interface. The IP range must be in the RFC3927 link-local IP address space. The value must be a CIDR-formatted string, for example: 169.254.0.1/30. NOTE: Do not truncate the address as it represents the IP address of the interface.

1208

"linkedInterconnectAttachment": "A String", # URI of the linked Interconnect attachment. It must be in the same region as the router. Each interface can have one linked resource, which can be a VPN tunnel, an Interconnect attachment, or a virtual machine instance.

1209

"linkedVpnTunnel": "A String", # URI of the linked VPN tunnel, which must be in the same region as the router. Each interface can have one linked resource, which can be a VPN tunnel, an Interconnect attachment, or a virtual machine instance.

yoshi-code-bot

2021-06-11 00:22:02 -0700

[diff] [blame^]

1210

"managementType": "A String", # [Output Only] The resource that configures and manages this interface. - MANAGED_BY_USER is the default value and can be managed directly by users. - MANAGED_BY_ATTACHMENT is an interface that is configured and managed by Cloud Interconnect, specifically, by an InterconnectAttachment of type PARTNER. Google automatically creates, updates, and deletes this type of interface when the PARTNER InterconnectAttachment is created, updated, or deleted.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1211

"name": "A String", # Name of this interface entry. 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.

1212

},

1213

],

1214

"kind": "compute#router", # [Output Only] Type of resource. Always compute#router for routers.

1215

"name": "A String", # 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.

1216

"nats": [ # A list of NAT services created in this router.

1217

{ # Represents a Nat resource. It enables the VMs within the specified subnetworks to access Internet without external IP addresses. It specifies a list of subnetworks (and the ranges within) that want to use NAT. Customers can also provide the external IPs that would be used for NAT. GCP would auto-allocate ephemeral IPs if no external IPs are provided.

1218

"drainNatIps": [ # A list of URLs of the IP resources to be drained. These IPs must be valid static external IPs that have been assigned to the NAT. These IPs should be used for updating/patching a NAT only.

1219

"A String",

1220

],

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

1221

"enableEndpointIndependentMapping": True or False,

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1222

"icmpIdleTimeoutSec": 42, # Timeout (in seconds) for ICMP connections. Defaults to 30s if not set.

1223

"logConfig": { # Configuration of logging on a NAT. # Configure logging on this NAT.

1224

"enable": True or False, # Indicates whether or not to export logs. This is false by default.

yoshi-code-bot

2021-06-11 00:22:02 -0700

[diff] [blame^]

1225

"filter": "A String", # Specify the desired filtering of logs on this NAT. If unspecified, logs are exported for all connections handled by this NAT. This option can take one of the following values: - ERRORS_ONLY: Export logs only for connection failures. - TRANSLATIONS_ONLY: Export logs only for successful connections. - ALL: Export logs for all connections, successful and unsuccessful.

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

1226

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1227

"minPortsPerVm": 42, # Minimum number of ports allocated to a VM from this NAT config. If not set, a default number of ports is allocated to a VM. This is rounded up to the nearest power of 2. For example, if the value of this field is 50, at least 64 ports are allocated to a VM.

1228

"name": "A String", # Unique name of this Nat service. The name must be 1-63 characters long and comply with RFC1035.

yoshi-code-bot

2021-06-11 00:22:02 -0700

[diff] [blame^]

1229

"natIpAllocateOption": "A String", # Specify the NatIpAllocateOption, which can take one of the following values: - MANUAL_ONLY: Uses only Nat IP addresses provided by customers. When there are not enough specified Nat IPs, the Nat service fails for new VMs. - AUTO_ONLY: Nat IPs are allocated by Google Cloud Platform; customers can't specify any Nat IPs. When choosing AUTO_ONLY, then nat_ip should be empty.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1230

"natIps": [ # A list of URLs of the IP resources used for this Nat service. These IP addresses must be valid static external IP addresses assigned to the project.

1231

"A String",

1232

],

yoshi-code-bot

2021-06-11 00:22:02 -0700

[diff] [blame^]

1233

"sourceSubnetworkIpRangesToNat": "A String", # Specify the Nat option, which can take one of the following values: - ALL_SUBNETWORKS_ALL_IP_RANGES: All of the IP ranges in every Subnetwork are allowed to Nat. - ALL_SUBNETWORKS_ALL_PRIMARY_IP_RANGES: All of the primary IP ranges in every Subnetwork are allowed to Nat. - LIST_OF_SUBNETWORKS: A list of Subnetworks are allowed to Nat (specified in the field subnetwork below) The default is SUBNETWORK_IP_RANGE_TO_NAT_OPTION_UNSPECIFIED. Note that if this field contains ALL_SUBNETWORKS_ALL_IP_RANGES or ALL_SUBNETWORKS_ALL_PRIMARY_IP_RANGES, then there should not be any other Router.Nat section in any Router for this network in this region.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1234

"subnetworks": [ # A list of Subnetwork resources whose traffic should be translated by NAT Gateway. It is used only when LIST_OF_SUBNETWORKS is selected for the SubnetworkIpRangeToNatOption above.

1235

{ # Defines the IP ranges that want to use NAT for a subnetwork.

1236

"name": "A String", # URL for the subnetwork resource that will use NAT.

1237

"secondaryIpRangeNames": [ # A list of the secondary ranges of the Subnetwork that are allowed to use NAT. This can be populated only if "LIST_OF_SECONDARY_IP_RANGES" is one of the values in source_ip_ranges_to_nat.

1238

"A String",

1239

],

1240

"sourceIpRangesToNat": [ # Specify the options for NAT ranges in the Subnetwork. All options of a single value are valid except NAT_IP_RANGE_OPTION_UNSPECIFIED. The only valid option with multiple values is: ["PRIMARY_IP_RANGE", "LIST_OF_SECONDARY_IP_RANGES"] Default: [ALL_IP_RANGES]

"A String",

],

},

],

"tcpEstablishedIdleTimeoutSec": 42, # Timeout (in seconds) for TCP established connections. Defaults to 1200s if not set.

1246

"tcpTransitoryIdleTimeoutSec": 42, # Timeout (in seconds) for TCP transitory connections. Defaults to 30s if not set.

1247

"udpIdleTimeoutSec": 42, # Timeout (in seconds) for UDP connections. Defaults to 30s if not set.

1248

},

1249

],

1250

"network": "A String", # URI of the network to which this router belongs.

1251

"region": "A String", # [Output Only] URI of the region where the router resides. You must specify this field as part of the HTTP request URL. It is not settable as a field in the request body.

1252

"selfLink": "A String", # [Output Only] Server-defined URL for the resource.

1253

}

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

1254

yoshi-code-bot

2021-06-11 00:22:02 -0700

[diff] [blame^]

1255

x__xgafv: string, V1 error format.

1256

Allowed values

1257

1 - v1 error format

1258

2 - v2 error format

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

1259

1260

Returns:

1261

An object of the form:

1262

1263

{

yoshi-code-bot

2021-06-11 00:22:02 -0700

[diff] [blame^]

1264

"resource": { # Represents a Cloud Router resource. For more information about Cloud Router, read the Cloud Router overview. # Preview of given router.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

1265

"bgp": { # BGP information specific to this router.

1266

"advertiseMode": "A String", # User-specified flag to indicate which mode to use for advertisement. The options are DEFAULT or CUSTOM.

1267

"advertisedGroups": [ # User-specified list of prefix groups to advertise in custom mode. This field can only be populated if advertise_mode is CUSTOM and is advertised to all peers of the router. These groups will be advertised in addition to any specified prefixes. Leave this field blank to advertise no custom groups.

1268

"A String",

1269

],

1270

"advertisedIpRanges": [ # User-specified list of individual IP ranges to advertise in custom mode. This field can only be populated if advertise_mode is CUSTOM and is advertised to all peers of the router. These IP ranges will be advertised in addition to any specified groups. Leave this field blank to advertise no custom IP ranges.

1271

{ # Description-tagged IP ranges for the router to advertise.

1272

"description": "A String", # User-specified description for the IP range.

1273

"range": "A String", # The IP range to advertise. The value must be a CIDR-formatted string.

1274

},

1275

],

1276

"asn": 42, # Local BGP Autonomous System Number (ASN). Must be an RFC6996 private ASN, either 16-bit or 32-bit. The value will be fixed for this router resource. All VPN tunnels that link to this router will have the same local ASN.

yoshi-code-bot

2021-06-11 00:22:02 -0700

[diff] [blame^]

1277

"keepaliveInterval": 42, # The interval in seconds between BGP keepalive messages that are sent to the peer. Hold time is three times the interval at which keepalive messages are sent, and the hold time is the maximum number of seconds allowed to elapse between successive keepalive messages that BGP receives from a peer. BGP will use the smaller of either the local hold time value or the peer's hold time value as the hold time for the BGP connection between the two peers. If set, this value must be between 20 and 60. The default is 20.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

1278

},

1279

"bgpPeers": [ # BGP information that must be configured into the routing stack to establish BGP peering. This information must specify the peer ASN and either the interface name, IP address, or peer IP address. Please refer to RFC4273.

1280

{

1281

"advertiseMode": "A String", # User-specified flag to indicate which mode to use for advertisement.

yoshi-code-bot

2021-06-11 00:22:02 -0700

[diff] [blame^]

1282

"advertisedGroups": [ # User-specified list of prefix groups to advertise in custom mode, which can take one of the following options: - ALL_SUBNETS: Advertises all available subnets, including peer VPC subnets. - ALL_VPC_SUBNETS: Advertises the router's own VPC subnets. Note that this field can only be populated if advertise_mode is CUSTOM and overrides the list defined for the router (in the "bgp" message). These groups are advertised in addition to any specified prefixes. Leave this field blank to advertise no custom groups.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1283

"A String",

1284

],

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

1285

"advertisedIpRanges": [ # User-specified list of individual IP ranges to advertise in custom mode. This field can only be populated if advertise_mode is CUSTOM and overrides the list defined for the router (in the "bgp" message). These IP ranges are advertised in addition to any specified groups. Leave this field blank to advertise no custom IP ranges.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1286

{ # Description-tagged IP ranges for the router to advertise.

1287

"description": "A String", # User-specified description for the IP range.

1288

"range": "A String", # The IP range to advertise. The value must be a CIDR-formatted string.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1289

},

1290

],

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

1291

"advertisedRoutePriority": 42, # The priority of routes advertised to this BGP peer. Where there is more than one matching route of maximum length, the routes with the lowest priority value win.

yoshi-code-bot

2021-06-11 00:22:02 -0700

[diff] [blame^]

1292

"enable": "A String", # The status of the BGP peer connection. If set to FALSE, any active session with the peer is terminated and all associated routing information is removed. If set to TRUE, the peer connection can be established with routing information. The default is TRUE.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

1293

"interfaceName": "A String", # Name of the interface the BGP peer is associated with.

1294

"ipAddress": "A String", # IP address of the interface inside Google Cloud Platform. Only IPv4 is supported.

yoshi-code-bot

2021-06-11 00:22:02 -0700

[diff] [blame^]

1295

"managementType": "A String", # [Output Only] The resource that configures and manages this BGP peer. - MANAGED_BY_USER is the default value and can be managed by you or other users - MANAGED_BY_ATTACHMENT is a BGP peer that is configured and managed by Cloud Interconnect, specifically by an InterconnectAttachment of type PARTNER. Google automatically creates, updates, and deletes this type of BGP peer when the PARTNER InterconnectAttachment is created, updated, or deleted.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

1296

"name": "A String", # Name of this BGP peer. 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.

1297

"peerAsn": 42, # Peer BGP Autonomous System Number (ASN). Each BGP interface may use a different value.

1298

"peerIpAddress": "A String", # IP address of the BGP interface outside Google Cloud Platform. Only IPv4 is supported.

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

1299

},

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

1300

],

1301

"creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.

1302

"description": "A String", # An optional description of this resource. Provide this property when you create the resource.

yoshi-code-bot

2021-06-11 00:22:02 -0700

[diff] [blame^]

1303

"encryptedInterconnectRouter": True or False, # Indicates if a router is dedicated for use with encrypted VLAN attachments (interconnectAttachments). Not currently available publicly.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

1304

"id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.

1305

"interfaces": [ # Router interfaces. Each interface requires either one linked resource, (for example, linkedVpnTunnel), or IP address and IP address range (for example, ipRange), or both.

1306

{

1307

"ipRange": "A String", # IP address and range of the interface. The IP range must be in the RFC3927 link-local IP address space. The value must be a CIDR-formatted string, for example: 169.254.0.1/30. NOTE: Do not truncate the address as it represents the IP address of the interface.

1308

"linkedInterconnectAttachment": "A String", # URI of the linked Interconnect attachment. It must be in the same region as the router. Each interface can have one linked resource, which can be a VPN tunnel, an Interconnect attachment, or a virtual machine instance.

1309

"linkedVpnTunnel": "A String", # URI of the linked VPN tunnel, which must be in the same region as the router. Each interface can have one linked resource, which can be a VPN tunnel, an Interconnect attachment, or a virtual machine instance.

yoshi-code-bot

2021-06-11 00:22:02 -0700

[diff] [blame^]

1310

"managementType": "A String", # [Output Only] The resource that configures and manages this interface. - MANAGED_BY_USER is the default value and can be managed directly by users. - MANAGED_BY_ATTACHMENT is an interface that is configured and managed by Cloud Interconnect, specifically, by an InterconnectAttachment of type PARTNER. Google automatically creates, updates, and deletes this type of interface when the PARTNER InterconnectAttachment is created, updated, or deleted.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

1311

"name": "A String", # Name of this interface entry. 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.

1312

},

1313

],

1314

"kind": "compute#router", # [Output Only] Type of resource. Always compute#router for routers.

1315

"name": "A String", # 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.

1316

"nats": [ # A list of NAT services created in this router.

1317

{ # Represents a Nat resource. It enables the VMs within the specified subnetworks to access Internet without external IP addresses. It specifies a list of subnetworks (and the ranges within) that want to use NAT. Customers can also provide the external IPs that would be used for NAT. GCP would auto-allocate ephemeral IPs if no external IPs are provided.

1318

"drainNatIps": [ # A list of URLs of the IP resources to be drained. These IPs must be valid static external IPs that have been assigned to the NAT. These IPs should be used for updating/patching a NAT only.

1319

"A String",

1320

],

1321

"enableEndpointIndependentMapping": True or False,

1322

"icmpIdleTimeoutSec": 42, # Timeout (in seconds) for ICMP connections. Defaults to 30s if not set.

1323

"logConfig": { # Configuration of logging on a NAT. # Configure logging on this NAT.

1324

"enable": True or False, # Indicates whether or not to export logs. This is false by default.

yoshi-code-bot

2021-06-11 00:22:02 -0700

[diff] [blame^]

1325

"filter": "A String", # Specify the desired filtering of logs on this NAT. If unspecified, logs are exported for all connections handled by this NAT. This option can take one of the following values: - ERRORS_ONLY: Export logs only for connection failures. - TRANSLATIONS_ONLY: Export logs only for successful connections. - ALL: Export logs for all connections, successful and unsuccessful.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1326

},

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

1327

"minPortsPerVm": 42, # Minimum number of ports allocated to a VM from this NAT config. If not set, a default number of ports is allocated to a VM. This is rounded up to the nearest power of 2. For example, if the value of this field is 50, at least 64 ports are allocated to a VM.

1328

"name": "A String", # Unique name of this Nat service. The name must be 1-63 characters long and comply with RFC1035.

yoshi-code-bot

2021-06-11 00:22:02 -0700

[diff] [blame^]

1329

"natIpAllocateOption": "A String", # Specify the NatIpAllocateOption, which can take one of the following values: - MANUAL_ONLY: Uses only Nat IP addresses provided by customers. When there are not enough specified Nat IPs, the Nat service fails for new VMs. - AUTO_ONLY: Nat IPs are allocated by Google Cloud Platform; customers can't specify any Nat IPs. When choosing AUTO_ONLY, then nat_ip should be empty.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

1330

"natIps": [ # A list of URLs of the IP resources used for this Nat service. These IP addresses must be valid static external IP addresses assigned to the project.

1331

"A String",

1332

],

yoshi-code-bot

2021-06-11 00:22:02 -0700

[diff] [blame^]

1333

"sourceSubnetworkIpRangesToNat": "A String", # Specify the Nat option, which can take one of the following values: - ALL_SUBNETWORKS_ALL_IP_RANGES: All of the IP ranges in every Subnetwork are allowed to Nat. - ALL_SUBNETWORKS_ALL_PRIMARY_IP_RANGES: All of the primary IP ranges in every Subnetwork are allowed to Nat. - LIST_OF_SUBNETWORKS: A list of Subnetworks are allowed to Nat (specified in the field subnetwork below) The default is SUBNETWORK_IP_RANGE_TO_NAT_OPTION_UNSPECIFIED. Note that if this field contains ALL_SUBNETWORKS_ALL_IP_RANGES or ALL_SUBNETWORKS_ALL_PRIMARY_IP_RANGES, then there should not be any other Router.Nat section in any Router for this network in this region.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

1334

"subnetworks": [ # A list of Subnetwork resources whose traffic should be translated by NAT Gateway. It is used only when LIST_OF_SUBNETWORKS is selected for the SubnetworkIpRangeToNatOption above.

1335

{ # Defines the IP ranges that want to use NAT for a subnetwork.

1336

"name": "A String", # URL for the subnetwork resource that will use NAT.

1337

"secondaryIpRangeNames": [ # A list of the secondary ranges of the Subnetwork that are allowed to use NAT. This can be populated only if "LIST_OF_SECONDARY_IP_RANGES" is one of the values in source_ip_ranges_to_nat.

1338

"A String",

1339

],

1340

"sourceIpRangesToNat": [ # Specify the options for NAT ranges in the Subnetwork. All options of a single value are valid except NAT_IP_RANGE_OPTION_UNSPECIFIED. The only valid option with multiple values is: ["PRIMARY_IP_RANGE", "LIST_OF_SECONDARY_IP_RANGES"] Default: [ALL_IP_RANGES]

1341

"A String",

1342

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1343

},

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

1344

],

1345

"tcpEstablishedIdleTimeoutSec": 42, # Timeout (in seconds) for TCP established connections. Defaults to 1200s if not set.

1346

"tcpTransitoryIdleTimeoutSec": 42, # Timeout (in seconds) for TCP transitory connections. Defaults to 30s if not set.

1347

"udpIdleTimeoutSec": 42, # Timeout (in seconds) for UDP connections. Defaults to 30s if not set.

1348

},

1349

],

1350

"network": "A String", # URI of the network to which this router belongs.

1351

"region": "A String", # [Output Only] URI of the region where the router resides. You must specify this field as part of the HTTP request URL. It is not settable as a field in the request body.

1352

"selfLink": "A String", # [Output Only] Server-defined URL for the resource.

1353

},

1354

}</pre>

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

</div>

yoshi-code-bot

2021-06-11 00:22:02 -0700

[diff] [blame^]

1358

<code class="details" id="update">update(project, region, router, body=None, requestId=None, x__xgafv=None)</code>

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

1359

<pre>Updates the specified Router resource with the data included in the request. This method conforms to PUT semantics, which requests that the state of the target resource be created or replaced with the state defined by the representation enclosed in the request message payload.

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

1360

1361

Args:

1362

project: string, Project ID for this request. (required)

1363

region: string, Name of the region for this request. (required)

1364

router: string, Name of the Router resource to update. (required)

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

1365

body: object, The request body.

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

1366

The object takes the form of:

1367

yoshi-code-bot

2021-06-11 00:22:02 -0700

[diff] [blame^]

1368

{ # Represents a Cloud Router resource. For more information about Cloud Router, read the Cloud Router overview.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1369

"bgp": { # BGP information specific to this router.

1370

"advertiseMode": "A String", # User-specified flag to indicate which mode to use for advertisement. The options are DEFAULT or CUSTOM.

1371

"advertisedGroups": [ # User-specified list of prefix groups to advertise in custom mode. This field can only be populated if advertise_mode is CUSTOM and is advertised to all peers of the router. These groups will be advertised in addition to any specified prefixes. Leave this field blank to advertise no custom groups.

1372

"A String",

1373

],

1374

"advertisedIpRanges": [ # User-specified list of individual IP ranges to advertise in custom mode. This field can only be populated if advertise_mode is CUSTOM and is advertised to all peers of the router. These IP ranges will be advertised in addition to any specified groups. Leave this field blank to advertise no custom IP ranges.

1375

{ # Description-tagged IP ranges for the router to advertise.

1376

"description": "A String", # User-specified description for the IP range.

1377

"range": "A String", # The IP range to advertise. The value must be a CIDR-formatted string.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1378

},

1379

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1380

"asn": 42, # Local BGP Autonomous System Number (ASN). Must be an RFC6996 private ASN, either 16-bit or 32-bit. The value will be fixed for this router resource. All VPN tunnels that link to this router will have the same local ASN.

yoshi-code-bot

2021-06-11 00:22:02 -0700

[diff] [blame^]

1381

"keepaliveInterval": 42, # The interval in seconds between BGP keepalive messages that are sent to the peer. Hold time is three times the interval at which keepalive messages are sent, and the hold time is the maximum number of seconds allowed to elapse between successive keepalive messages that BGP receives from a peer. BGP will use the smaller of either the local hold time value or the peer's hold time value as the hold time for the BGP connection between the two peers. If set, this value must be between 20 and 60. The default is 20.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1382

},

1383

"bgpPeers": [ # BGP information that must be configured into the routing stack to establish BGP peering. This information must specify the peer ASN and either the interface name, IP address, or peer IP address. Please refer to RFC4273.

1384

{

1385

"advertiseMode": "A String", # User-specified flag to indicate which mode to use for advertisement.

yoshi-code-bot

2021-06-11 00:22:02 -0700

[diff] [blame^]

1386

"advertisedGroups": [ # User-specified list of prefix groups to advertise in custom mode, which can take one of the following options: - ALL_SUBNETS: Advertises all available subnets, including peer VPC subnets. - ALL_VPC_SUBNETS: Advertises the router's own VPC subnets. Note that this field can only be populated if advertise_mode is CUSTOM and overrides the list defined for the router (in the "bgp" message). These groups are advertised in addition to any specified prefixes. Leave this field blank to advertise no custom groups.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1387

"A String",

1388

],

1389

"advertisedIpRanges": [ # User-specified list of individual IP ranges to advertise in custom mode. This field can only be populated if advertise_mode is CUSTOM and overrides the list defined for the router (in the "bgp" message). These IP ranges are advertised in addition to any specified groups. Leave this field blank to advertise no custom IP ranges.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1390

{ # Description-tagged IP ranges for the router to advertise.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1391

"description": "A String", # User-specified description for the IP range.

1392

"range": "A String", # The IP range to advertise. The value must be a CIDR-formatted string.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1393

},

1394

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1395

"advertisedRoutePriority": 42, # The priority of routes advertised to this BGP peer. Where there is more than one matching route of maximum length, the routes with the lowest priority value win.

yoshi-code-bot

2021-06-11 00:22:02 -0700

[diff] [blame^]

1396

"enable": "A String", # The status of the BGP peer connection. If set to FALSE, any active session with the peer is terminated and all associated routing information is removed. If set to TRUE, the peer connection can be established with routing information. The default is TRUE.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1397

"interfaceName": "A String", # Name of the interface the BGP peer is associated with.

1398

"ipAddress": "A String", # IP address of the interface inside Google Cloud Platform. Only IPv4 is supported.

yoshi-code-bot

2021-06-11 00:22:02 -0700

[diff] [blame^]

1399

"managementType": "A String", # [Output Only] The resource that configures and manages this BGP peer. - MANAGED_BY_USER is the default value and can be managed by you or other users - MANAGED_BY_ATTACHMENT is a BGP peer that is configured and managed by Cloud Interconnect, specifically by an InterconnectAttachment of type PARTNER. Google automatically creates, updates, and deletes this type of BGP peer when the PARTNER InterconnectAttachment is created, updated, or deleted.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1400

"name": "A String", # Name of this BGP peer. 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.

1401

"peerAsn": 42, # Peer BGP Autonomous System Number (ASN). Each BGP interface may use a different value.

1402

"peerIpAddress": "A String", # IP address of the BGP interface outside Google Cloud Platform. Only IPv4 is supported.

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

1403

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1404

],

1405

"creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.

1406

"description": "A String", # An optional description of this resource. Provide this property when you create the resource.

yoshi-code-bot

2021-06-11 00:22:02 -0700

[diff] [blame^]

1407

"encryptedInterconnectRouter": True or False, # Indicates if a router is dedicated for use with encrypted VLAN attachments (interconnectAttachments). Not currently available publicly.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1408

"id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.

1409

"interfaces": [ # Router interfaces. Each interface requires either one linked resource, (for example, linkedVpnTunnel), or IP address and IP address range (for example, ipRange), or both.

1410

{

1411

"ipRange": "A String", # IP address and range of the interface. The IP range must be in the RFC3927 link-local IP address space. The value must be a CIDR-formatted string, for example: 169.254.0.1/30. NOTE: Do not truncate the address as it represents the IP address of the interface.

1412

"linkedInterconnectAttachment": "A String", # URI of the linked Interconnect attachment. It must be in the same region as the router. Each interface can have one linked resource, which can be a VPN tunnel, an Interconnect attachment, or a virtual machine instance.

1413

"linkedVpnTunnel": "A String", # URI of the linked VPN tunnel, which must be in the same region as the router. Each interface can have one linked resource, which can be a VPN tunnel, an Interconnect attachment, or a virtual machine instance.

yoshi-code-bot

2021-06-11 00:22:02 -0700

[diff] [blame^]

1414

"managementType": "A String", # [Output Only] The resource that configures and manages this interface. - MANAGED_BY_USER is the default value and can be managed directly by users. - MANAGED_BY_ATTACHMENT is an interface that is configured and managed by Cloud Interconnect, specifically, by an InterconnectAttachment of type PARTNER. Google automatically creates, updates, and deletes this type of interface when the PARTNER InterconnectAttachment is created, updated, or deleted.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1415

"name": "A String", # Name of this interface entry. 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.

1416

},

1417

],

1418

"kind": "compute#router", # [Output Only] Type of resource. Always compute#router for routers.

1419

"name": "A String", # 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.

1420

"nats": [ # A list of NAT services created in this router.

1421

{ # Represents a Nat resource. It enables the VMs within the specified subnetworks to access Internet without external IP addresses. It specifies a list of subnetworks (and the ranges within) that want to use NAT. Customers can also provide the external IPs that would be used for NAT. GCP would auto-allocate ephemeral IPs if no external IPs are provided.

1422

"drainNatIps": [ # A list of URLs of the IP resources to be drained. These IPs must be valid static external IPs that have been assigned to the NAT. These IPs should be used for updating/patching a NAT only.

1423

"A String",

1424

],

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

1425

"enableEndpointIndependentMapping": True or False,

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1426

"icmpIdleTimeoutSec": 42, # Timeout (in seconds) for ICMP connections. Defaults to 30s if not set.

1427

"logConfig": { # Configuration of logging on a NAT. # Configure logging on this NAT.

1428

"enable": True or False, # Indicates whether or not to export logs. This is false by default.

yoshi-code-bot

2021-06-11 00:22:02 -0700

[diff] [blame^]

1429

"filter": "A String", # Specify the desired filtering of logs on this NAT. If unspecified, logs are exported for all connections handled by this NAT. This option can take one of the following values: - ERRORS_ONLY: Export logs only for connection failures. - TRANSLATIONS_ONLY: Export logs only for successful connections. - ALL: Export logs for all connections, successful and unsuccessful.

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

1430

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1431

"minPortsPerVm": 42, # Minimum number of ports allocated to a VM from this NAT config. If not set, a default number of ports is allocated to a VM. This is rounded up to the nearest power of 2. For example, if the value of this field is 50, at least 64 ports are allocated to a VM.

1432

"name": "A String", # Unique name of this Nat service. The name must be 1-63 characters long and comply with RFC1035.

yoshi-code-bot

2021-06-11 00:22:02 -0700

[diff] [blame^]

1433

"natIpAllocateOption": "A String", # Specify the NatIpAllocateOption, which can take one of the following values: - MANUAL_ONLY: Uses only Nat IP addresses provided by customers. When there are not enough specified Nat IPs, the Nat service fails for new VMs. - AUTO_ONLY: Nat IPs are allocated by Google Cloud Platform; customers can't specify any Nat IPs. When choosing AUTO_ONLY, then nat_ip should be empty.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1434

"natIps": [ # A list of URLs of the IP resources used for this Nat service. These IP addresses must be valid static external IP addresses assigned to the project.

1435

"A String",

1436

],

yoshi-code-bot

2021-06-11 00:22:02 -0700

[diff] [blame^]

1437

"sourceSubnetworkIpRangesToNat": "A String", # Specify the Nat option, which can take one of the following values: - ALL_SUBNETWORKS_ALL_IP_RANGES: All of the IP ranges in every Subnetwork are allowed to Nat. - ALL_SUBNETWORKS_ALL_PRIMARY_IP_RANGES: All of the primary IP ranges in every Subnetwork are allowed to Nat. - LIST_OF_SUBNETWORKS: A list of Subnetworks are allowed to Nat (specified in the field subnetwork below) The default is SUBNETWORK_IP_RANGE_TO_NAT_OPTION_UNSPECIFIED. Note that if this field contains ALL_SUBNETWORKS_ALL_IP_RANGES or ALL_SUBNETWORKS_ALL_PRIMARY_IP_RANGES, then there should not be any other Router.Nat section in any Router for this network in this region.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1438

"subnetworks": [ # A list of Subnetwork resources whose traffic should be translated by NAT Gateway. It is used only when LIST_OF_SUBNETWORKS is selected for the SubnetworkIpRangeToNatOption above.

1439

{ # Defines the IP ranges that want to use NAT for a subnetwork.

1440

"name": "A String", # URL for the subnetwork resource that will use NAT.

1441

"secondaryIpRangeNames": [ # A list of the secondary ranges of the Subnetwork that are allowed to use NAT. This can be populated only if "LIST_OF_SECONDARY_IP_RANGES" is one of the values in source_ip_ranges_to_nat.

1442

"A String",

1443

],

1444

"sourceIpRangesToNat": [ # Specify the options for NAT ranges in the Subnetwork. All options of a single value are valid except NAT_IP_RANGE_OPTION_UNSPECIFIED. The only valid option with multiple values is: ["PRIMARY_IP_RANGE", "LIST_OF_SECONDARY_IP_RANGES"] Default: [ALL_IP_RANGES]

"A String",

],

},

],

"tcpEstablishedIdleTimeoutSec": 42, # Timeout (in seconds) for TCP established connections. Defaults to 1200s if not set.

1450

"tcpTransitoryIdleTimeoutSec": 42, # Timeout (in seconds) for TCP transitory connections. Defaults to 30s if not set.

1451

"udpIdleTimeoutSec": 42, # Timeout (in seconds) for UDP connections. Defaults to 30s if not set.

1452

},

1453

],

1454

"network": "A String", # URI of the network to which this router belongs.

1455

"region": "A String", # [Output Only] URI of the region where the router resides. You must specify this field as part of the HTTP request URL. It is not settable as a field in the request body.

1456

"selfLink": "A String", # [Output Only] Server-defined URL for the resource.

1457

}

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

1458

yoshi-code-bot

2021-06-11 00:22:02 -0700

[diff] [blame^]

1459

requestId: string, An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000).

1460

x__xgafv: string, V1 error format.

1461

Allowed values

1462

1 - v1 error format

1463

2 - v2 error format

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

1464

1465

Returns:

1466

An object of the form:

1467

yoshi-code-bot

2021-06-11 00:22:02 -0700

[diff] [blame^]

1468

{ # Represents an Operation resource. Google Compute Engine has three Operation resources: * [Global](/compute/docs/reference/rest/v1/globalOperations) * [Regional](/compute/docs/reference/rest/v1/regionOperations) * [Zonal](/compute/docs/reference/rest/v1/zoneOperations) You can use an operation resource to manage asynchronous API requests. For more information, read Handling API responses. Operations can be global, regional or zonal. - For global operations, use the `globalOperations` resource. - For regional operations, use the `regionOperations` resource. - For zonal operations, use the `zonalOperations` resource. For more information, read Global, Regional, and Zonal Resources.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

1469

"clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise.

1470

"creationTimestamp": "A String", # [Deprecated] This field is deprecated.

1471

"description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.

1472

"endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.

1473

"error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.

1474

"errors": [ # [Output Only] The array of errors encountered while processing this operation.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1475

{

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

1476

"code": "A String", # [Output Only] The error type identifier for this error.

1477

"location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.

1478

"message": "A String", # [Output Only] An optional, human-readable error message.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1479

},

1480

],

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

1481

},

1482

"httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as `NOT FOUND`.

1483

"httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error status code that was returned. For example, a `404` means the resource was not found.

1484

"id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server.

1485

"insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.

1486

"kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources.

1487

"name": "A String", # [Output Only] Name of the operation.

yoshi-code-bot

2021-03-02 11:49:08 -0800

[diff] [blame]

1488

"operationGroupId": "A String", # [Output Only] An ID that represents a group of operations, such as when a group of operations results from a `bulkInsert` API request.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

1489

"operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on.

1490

"progress": 42, # [Output Only] An optional progress indicator that ranges from 0 to 100. There is no requirement that this be linear or support any granularity of operations. This should not be used to guess when the operation will be complete. This number should monotonically increase as the operation progresses.

1491

"region": "A String", # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations.

1492

"selfLink": "A String", # [Output Only] Server-defined URL for the resource.

1493

"startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.

1494

"status": "A String", # [Output Only] The status of the operation, which can be one of the following: `PENDING`, `RUNNING`, or `DONE`.

1495

"statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.

1496

"targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.

1497

"targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. For operations related to creating a snapshot, this points to the persistent disk that the snapshot was created from.

1498

"user": "A String", # [Output Only] User who requested the operation, for example: `user@example.com`.

1499

"warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.

1500

{

1501

"code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.

yoshi-code-bot

2021-06-11 00:22:02 -0700

[diff] [blame^]

1502

"data": [ # [Output Only] Metadata about this warning in key: value format. For example: "data": [ { "key": "scope", "value": "zones/us-east1-d" }

Yoshi Automation Bot