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

2016-10-21 13:59:49 -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

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

Sai Cheemalapati

c30d2b5

2017-03-13 12:12:03 -0400

[diff] [blame]

87

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

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

88

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

89

90

<code><a href="#get">get(project, region, router)</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

Bu Sun Kim

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

[diff] [blame]

93

<code><a href="#getNatMappingInfo">getNatMappingInfo(project, region, router, filter=None, maxResults=None, natName=None, orderBy=None, pageToken=None, returnPartialSuccess=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>

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

98

99

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

100

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

101

Dan O'Meara

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

[diff] [blame]

102

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

Sai Cheemalapati

2016-10-21 13:59:49 -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

Bu Sun Kim

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

[diff] [blame]

105

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

Sai Cheemalapati

2016-10-21 13:59:49 -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

Dan O'Meara

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

[diff] [blame]

111

<code><a href="#patch">patch(project, region, router, body=None, requestId=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>

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

113

Dan O'Meara

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

[diff] [blame]

114

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

Sai Cheemalapati

2016-10-21 13:59:49 -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

Dan O'Meara

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

[diff] [blame]

117

<code><a href="#testIamPermissions">testIamPermissions(project, region, resource, body=None)</a></code></p>

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

118

<p class="firstline">Returns permissions that a caller has on the specified resource.</p>

119

Dan O'Meara

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

[diff] [blame]

120

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

121

<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>

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

122

<h3>Method Details</h3>

123

Bu Sun Kim

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

[diff] [blame]

124

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

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

125

<pre>Retrieves an aggregated list of routers.

126

127

Args:

128

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

Dan O'Meara

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

[diff] [blame]

129

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 `<`.

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

130

Dan O'Meara

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

[diff] [blame]

131

For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`.

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

132

Dan O'Meara

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

[diff] [blame]

133

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.

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

134

Bu Sun Kim

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

[diff] [blame]

135

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]

136

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]

137

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`)

138

orderBy: string, Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name.

139

140

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.

141

142

Currently, only sorting by `name` or `creationTimestamp desc` is supported.

143

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.

144

returnPartialSuccess: boolean, Opt-in for partial success behavior which provides partial results in case of failure. The default value is false and the logic is the same as today.

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

145

146

Returns:

147

An object of the form:

148

149

{ # Contains a list of routers.

Bu Sun Kim

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

[diff] [blame]

150

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

151

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

152

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

153

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

Bu Sun Kim

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

[diff] [blame]

154

{ # Represents a Cloud Router resource.

Bu Sun Kim

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

[diff] [blame]

155

#

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

156

# For more information about Cloud Router, read the Cloud Router overview.

Bu Sun Kim

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

[diff] [blame]

157

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

158

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

159

"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.

160

"A String",

161

],

162

"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.

163

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

164

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

165

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

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

166

},

167

],

Bu Sun Kim

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

[diff] [blame]

168

"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.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

169

"keepaliveInterval": 42, # The interval in seconds between BGP keepalive messages that are sent to the peer.

170

# Not currently available publicly.

171

# 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.

172

# 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.

173

# If set, this value must be between 1 and 120. The default is 20.

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

174

},

Bu Sun Kim

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

[diff] [blame]

175

"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.

176

{

177

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

178

"advertisedGroups": [ # User-specified list of prefix groups to advertise in custom mode, which can take one of the following options:

179

# - ALL_SUBNETS: Advertises all available subnets, including peer VPC subnets.

180

# - ALL_VPC_SUBNETS: Advertises the router's own VPC subnets.

181

# - ALL_PEER_VPC_SUBNETS: Advertises peer subnets of the router's VPC network. 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.

182

"A String",

183

],

184

"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.

185

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

186

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

187

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

188

},

189

],

190

"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.

191

"bfd": { # BFD configuration for the BGP peering.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

192

# Not currently available publicly.

193

"minReceiveInterval": 42, # The minimum interval, in milliseconds, between BFD control packets received from the peer router. The actual value is negotiated between the two routers and is equal to the greater of this value and the transmit interval of the other router.

194

# Not currently available publicly.

195

# If set, this value must be between 100 and 30000.

196

# The default is 300.

197

"minTransmitInterval": 42, # The minimum interval, in milliseconds, between BFD control packets transmitted to the peer router. The actual value is negotiated between the two routers and is equal to the greater of this value and the corresponding receive interval of the other router.

198

# Not currently available publicly.

199

# If set, this value must be between 100 and 30000.

200

# The default is 300.

Bu Sun Kim

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

[diff] [blame]

201

"mode": "A String", # The BFD session initialization mode for this BGP peer. If set to ACTIVE, the Cloud Router will initiate the BFD session for this BGP peer. If set to PASSIVE, the Cloud Router will wait for the peer router to initiate the BFD session for this BGP peer. If set to DISABLED, BFD is disabled for this BGP peer. The default is PASSIVE.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

202

"multiplier": 42, # The number of consecutive BFD packets that must be missed before BFD declares that a peer is unavailable.

203

# Not currently available publicly.

204

# If set, the value must be a value between 2 and 16.

205

# The default is 3.

Bu Sun Kim

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

[diff] [blame]

206

"packetMode": "A String", # The BFD packet mode for this BGP peer. If set to CONTROL_AND_ECHO, BFD echo mode is enabled for this BGP peer. In this mode, if the peer router also has BFD echo mode enabled, BFD echo packets will be sent to the other router. If the peer router does not have BFD echo mode enabled, only control packets will be sent. If set to CONTROL_ONLY, BFD echo mode is disabled for this BGP peer. If this router and the peer router have a multihop connection, this should be set to CONTROL_ONLY as BFD echo mode is only supported on singlehop connections. The default is CONTROL_AND_ECHO.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

207

"sessionInitializationMode": "A String", # The BFD session initialization mode for this BGP peer.

208

# Not currently available publicly.

209

# If set to ACTIVE, the Cloud Router will initiate the BFD session for this BGP peer. If set to PASSIVE, the Cloud Router will wait for the peer router to initiate the BFD session for this BGP peer. If set to DISABLED, BFD is disabled for this BGP peer. The default is PASSIVE.

Bu Sun Kim

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

[diff] [blame]

210

"slowTimerInterval": 42, # The minimum interval, in milliseconds, between BFD control packets transmitted to and received from the peer router when BFD echo mode is enabled on both routers. The actual transmit and receive intervals are negotiated between the two routers and are equal to the greater of this value and the corresponding interval on the other router. If set, this value must be between 1000 and 30000. The default is 5000.

211

},

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

212

"enable": "A String", # The status of the BGP peer connection.

213

# Not currently available publicly.

214

# 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]

215

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

216

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

217

"managementType": "A String", # [Output Only] The resource that configures and manages this BGP peer.

218

# - MANAGED_BY_USER is the default value and can be managed by you or other users

219

# - 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.

220

"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.

221

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

222

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

223

},

224

],

225

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

226

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

227

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

228

"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.

229

{

230

"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.

231

"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.

232

"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.

233

"managementType": "A String", # [Output Only] The resource that configures and manages this interface.

234

# - MANAGED_BY_USER is the default value and can be managed directly by users.

235

# - 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.

236

"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.

237

},

238

],

239

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

240

"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.

241

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

242

{ # 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.

243

"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.

244

"A String",

245

],

246

"enableEndpointIndependentMapping": True or False,

247

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

248

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

249

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

250

"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:

251

# - ERRORS_ONLY: Export logs only for connection failures.

252

# - TRANSLATIONS_ONLY: Export logs only for successful connections.

253

# - ALL: Export logs for all connections, successful and unsuccessful.

254

},

255

"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.

256

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

257

"natIpAllocateOption": "A String", # Specify the NatIpAllocateOption, which can take one of the following values:

258

# - 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.

259

# - 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.

260

"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.

261

"A String",

262

],

263

"rules": [ # A list of rules associated with this NAT.

264

{

265

"action": { # The action to be enforced for traffic that matches this rule.

266

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

267

"A String",

268

],

269

"sourceNatDrainIps": [ # 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 rule only.

"A String",

],

},

"description": "A String", # An optional description of this rule.

274

"match": "A String", # CEL expression that specifies the match condition that egress traffic from a VM is evaluated against. If it evaluates to true, the corresponding ?action? is enforced.

275

#

276

# The following examples are valid match expressions:

277

#

278

# "inIpRange(destination.ip, '1.1.0.0/16') || inIpRange(destination.ip, '2.2.0.0/16')"

279

#

280

# "destination.ip == '1.1.0.1' || destination.ip == '8.8.8.8'"

Dmitry Frenkel

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

[diff] [blame]

281

"ruleNumber": 42, # An integer uniquely identifying a rule in the list. The rule number must be a positive value between 0 and 65000, and must be unique among rules within a NAT.

Bu Sun Kim

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

[diff] [blame]

282

},

283

],

284

"sourceSubnetworkIpRangesToNat": "A String", # Specify the Nat option, which can take one of the following values:

285

# - ALL_SUBNETWORKS_ALL_IP_RANGES: All of the IP ranges in every Subnetwork are allowed to Nat.

286

# - ALL_SUBNETWORKS_ALL_PRIMARY_IP_RANGES: All of the primary IP ranges in every Subnetwork are allowed to Nat.

287

# - 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.

288

"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.

289

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

290

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

291

"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.

292

"A String",

293

],

294

"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.

300

"tcpTimeWaitTimeoutSec": 42, # Timeout (in seconds) for TCP connections that are in TIME_WAIT state. Defaults to 120s if not set.

301

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

302

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

303

},

304

],

305

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

306

"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.

307

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

308

"selfLinkWithId": "A String", # [Output Only] Server-defined URL for this resource with the resource id.

309

},

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

310

],

Bu Sun Kim

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

[diff] [blame]

311

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

312

"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.

313

"data": [ # [Output Only] Metadata about this warning in key: value format. For example:

314

# "data": [ { "key": "scope", "value": "zones/us-east1-d" }

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

315

{

Bu Sun Kim

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

[diff] [blame]

316

"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).

317

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

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

318

},

319

],

Bu Sun Kim

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

[diff] [blame]

320

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

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

321

},

322

},

323

},

Bu Sun Kim

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

[diff] [blame]

324

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

325

"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.

326

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

327

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

328

"A String",

329

],

330

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

331

"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.

332

"data": [ # [Output Only] Metadata about this warning in key: value format. For example:

333

# "data": [ { "key": "scope", "value": "zones/us-east1-d" }

Bu Sun Kim

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

[diff] [blame]

334

{

Bu Sun Kim

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

[diff] [blame]

335

"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).

336

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

Bu Sun Kim

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

[diff] [blame]

337

},

338

],

Bu Sun Kim

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

[diff] [blame]

339

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

Bu Sun Kim

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

[diff] [blame]

340

},

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

}</pre>

</div>

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

346

<pre>Retrieves the next page of results.

347

348

Args:

349

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

350

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

351

352

Returns:

Bu Sun Kim

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

[diff] [blame]

353

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

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

354

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]

359

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

360

<pre>Close httplib2 connections.</pre>

</div>

Sai Cheemalapati

2017-03-13 12:12:03 -0400

[diff] [blame]

364

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

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

365

<pre>Deletes the specified Router resource.

366

367

Args:

368

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

369

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

370

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

Bu Sun Kim

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

[diff] [blame]

371

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.

372

373

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.

374

375

The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

376

377

Returns:

378

An object of the form:

379

Bu Sun Kim

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

[diff] [blame]

380

{ # Represents an Operation resource.

381

#

Dan O'Meara

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

[diff] [blame]

382

# Google Compute Engine has three Operation resources:

383

#

384

# * [Global](/compute/docs/reference/rest/{$api_version}/globalOperations) * [Regional](/compute/docs/reference/rest/{$api_version}/regionOperations) * [Zonal](/compute/docs/reference/rest/{$api_version}/zoneOperations)

385

#

Bu Sun Kim

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

[diff] [blame]

386

# You can use an operation resource to manage asynchronous API requests. For more information, read Handling API responses.

387

#

388

# Operations can be global, regional or zonal.

Dan O'Meara

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

[diff] [blame]

389

# - For global operations, use the `globalOperations` resource.

390

# - For regional operations, use the `regionOperations` resource.

391

# - For zonal operations, use the `zonalOperations` resource.

Bu Sun Kim

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

[diff] [blame]

392

#

Dan O'Meara

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

[diff] [blame]

393

# For more information, read Global, Regional, and Zonal Resources. (== resource_for {$api_version}.globalOperations ==) (== resource_for {$api_version}.regionOperations ==) (== resource_for {$api_version}.zoneOperations ==)

Bu Sun Kim

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

[diff] [blame]

394

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

395

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

396

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

397

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

398

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

399

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

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

400

{

Bu Sun Kim

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

[diff] [blame]

401

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

402

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

403

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

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

404

},

405

],

406

},

Bu Sun Kim

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

[diff] [blame]

407

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

408

"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.

409

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

410

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

411

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

412

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

413

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

414

"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.

415

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

416

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

417

"selfLinkWithId": "A String", # [Output Only] Server-defined URL for this resource with the resource id.

418

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

419

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

420

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

421

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

422

"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.

423

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

424

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

425

{

426

"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.

427

"data": [ # [Output Only] Metadata about this warning in key: value format. For example:

428

# "data": [ { "key": "scope", "value": "zones/us-east1-d" }

429

{

430

"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).

431

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

432

},

433

],

434

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

435

},

436

],

437

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

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

}</pre>

</div>

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

Bu Sun Kim

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

[diff] [blame]

443

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

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

444

445

Args:

446

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

447

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

448

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

449

450

Returns:

451

An object of the form:

452

Bu Sun Kim

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

[diff] [blame]

453

{ # Represents a Cloud Router resource.

Bu Sun Kim

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

[diff] [blame]

454

#

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

455

# For more information about Cloud Router, read the Cloud Router overview.

Bu Sun Kim

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

[diff] [blame]

456

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

457

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

458

"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.

459

"A String",

460

],

461

"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.

462

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

463

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

464

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

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

465

},

466

],

Bu Sun Kim

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

[diff] [blame]

467

"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.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

468

"keepaliveInterval": 42, # The interval in seconds between BGP keepalive messages that are sent to the peer.

469

# Not currently available publicly.

470

# 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.

471

# 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.

472

# If set, this value must be between 1 and 120. The default is 20.

Bu Sun Kim

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

[diff] [blame]

473

},

474

"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.

475

{

476

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

477

"advertisedGroups": [ # User-specified list of prefix groups to advertise in custom mode, which can take one of the following options:

478

# - ALL_SUBNETS: Advertises all available subnets, including peer VPC subnets.

479

# - ALL_VPC_SUBNETS: Advertises the router's own VPC subnets.

480

# - ALL_PEER_VPC_SUBNETS: Advertises peer subnets of the router's VPC network. 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.

481

"A String",

482

],

483

"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]

484

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

Bu Sun Kim

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

[diff] [blame]

485

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

486

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

Sai Cheemalapati

2017-06-06 18:46:08 -0400

[diff] [blame]

487

},

488

],

Bu Sun Kim

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

[diff] [blame]

489

"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.

490

"bfd": { # BFD configuration for the BGP peering.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

491

# Not currently available publicly.

492

"minReceiveInterval": 42, # The minimum interval, in milliseconds, between BFD control packets received from the peer router. The actual value is negotiated between the two routers and is equal to the greater of this value and the transmit interval of the other router.

493

# Not currently available publicly.

494

# If set, this value must be between 100 and 30000.

495

# The default is 300.

496

"minTransmitInterval": 42, # The minimum interval, in milliseconds, between BFD control packets transmitted to the peer router. The actual value is negotiated between the two routers and is equal to the greater of this value and the corresponding receive interval of the other router.

497

# Not currently available publicly.

498

# If set, this value must be between 100 and 30000.

499

# The default is 300.

Bu Sun Kim

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

[diff] [blame]

500

"mode": "A String", # The BFD session initialization mode for this BGP peer. If set to ACTIVE, the Cloud Router will initiate the BFD session for this BGP peer. If set to PASSIVE, the Cloud Router will wait for the peer router to initiate the BFD session for this BGP peer. If set to DISABLED, BFD is disabled for this BGP peer. The default is PASSIVE.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

501

"multiplier": 42, # The number of consecutive BFD packets that must be missed before BFD declares that a peer is unavailable.

502

# Not currently available publicly.

503

# If set, the value must be a value between 2 and 16.

504

# The default is 3.

Bu Sun Kim

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

[diff] [blame]

505

"packetMode": "A String", # The BFD packet mode for this BGP peer. If set to CONTROL_AND_ECHO, BFD echo mode is enabled for this BGP peer. In this mode, if the peer router also has BFD echo mode enabled, BFD echo packets will be sent to the other router. If the peer router does not have BFD echo mode enabled, only control packets will be sent. If set to CONTROL_ONLY, BFD echo mode is disabled for this BGP peer. If this router and the peer router have a multihop connection, this should be set to CONTROL_ONLY as BFD echo mode is only supported on singlehop connections. The default is CONTROL_AND_ECHO.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

506

"sessionInitializationMode": "A String", # The BFD session initialization mode for this BGP peer.

507

# Not currently available publicly.

508

# If set to ACTIVE, the Cloud Router will initiate the BFD session for this BGP peer. If set to PASSIVE, the Cloud Router will wait for the peer router to initiate the BFD session for this BGP peer. If set to DISABLED, BFD is disabled for this BGP peer. The default is PASSIVE.

Bu Sun Kim

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

[diff] [blame]

509

"slowTimerInterval": 42, # The minimum interval, in milliseconds, between BFD control packets transmitted to and received from the peer router when BFD echo mode is enabled on both routers. The actual transmit and receive intervals are negotiated between the two routers and are equal to the greater of this value and the corresponding interval on the other router. If set, this value must be between 1000 and 30000. The default is 5000.

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

510

},

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

511

"enable": "A String", # The status of the BGP peer connection.

512

# Not currently available publicly.

513

# 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]

514

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

515

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

516

"managementType": "A String", # [Output Only] The resource that configures and manages this BGP peer.

517

# - MANAGED_BY_USER is the default value and can be managed by you or other users

518

# - 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.

519

"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.

520

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

521

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

522

},

523

],

524

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

525

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

526

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

527

"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.

528

{

529

"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.

530

"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.

531

"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.

532

"managementType": "A String", # [Output Only] The resource that configures and manages this interface.

533

# - MANAGED_BY_USER is the default value and can be managed directly by users.

534

# - 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.

535

"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.

536

},

537

],

538

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

539

"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.

540

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

541

{ # 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.

542

"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.

543

"A String",

544

],

545

"enableEndpointIndependentMapping": True or False,

546

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

547

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

548

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

549

"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:

550

# - ERRORS_ONLY: Export logs only for connection failures.

551

# - TRANSLATIONS_ONLY: Export logs only for successful connections.

552

# - ALL: Export logs for all connections, successful and unsuccessful.

553

},

554

"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.

555

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

556

"natIpAllocateOption": "A String", # Specify the NatIpAllocateOption, which can take one of the following values:

557

# - 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.

558

# - 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.

559

"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.

560

"A String",

561

],

562

"rules": [ # A list of rules associated with this NAT.

563

{

564

"action": { # The action to be enforced for traffic that matches this rule.

565

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

566

"A String",

567

],

568

"sourceNatDrainIps": [ # 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 rule only.

"A String",

],

},

"description": "A String", # An optional description of this rule.

573

"match": "A String", # CEL expression that specifies the match condition that egress traffic from a VM is evaluated against. If it evaluates to true, the corresponding ?action? is enforced.

574

#

575

# The following examples are valid match expressions:

576

#

577

# "inIpRange(destination.ip, '1.1.0.0/16') || inIpRange(destination.ip, '2.2.0.0/16')"

578

#

579

# "destination.ip == '1.1.0.1' || destination.ip == '8.8.8.8'"

Dmitry Frenkel

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

[diff] [blame]

580

"ruleNumber": 42, # An integer uniquely identifying a rule in the list. The rule number must be a positive value between 0 and 65000, and must be unique among rules within a NAT.

Bu Sun Kim

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

[diff] [blame]

581

},

582

],

583

"sourceSubnetworkIpRangesToNat": "A String", # Specify the Nat option, which can take one of the following values:

584

# - ALL_SUBNETWORKS_ALL_IP_RANGES: All of the IP ranges in every Subnetwork are allowed to Nat.

585

# - ALL_SUBNETWORKS_ALL_PRIMARY_IP_RANGES: All of the primary IP ranges in every Subnetwork are allowed to Nat.

586

# - 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.

587

"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.

588

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

589

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

590

"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.

591

"A String",

592

],

593

"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.

599

"tcpTimeWaitTimeoutSec": 42, # Timeout (in seconds) for TCP connections that are in TIME_WAIT state. Defaults to 120s if not set.

600

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

601

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

602

},

603

],

604

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

605

"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.

606

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

607

"selfLinkWithId": "A String", # [Output Only] Server-defined URL for this resource with the resource id.

608

}</pre>

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

</div>

Bu Sun Kim

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

[diff] [blame]

612

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

Bu Sun Kim

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

[diff] [blame]

613

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

614

615

Args:

616

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

617

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

618

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

Dan O'Meara

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

[diff] [blame]

619

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 `<`.

Bu Sun Kim

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

[diff] [blame]

620

Dan O'Meara

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

[diff] [blame]

621

For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`.

Bu Sun Kim

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

[diff] [blame]

622

Dan O'Meara

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

[diff] [blame]

623

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.

Bu Sun Kim

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

[diff] [blame]

624

Bu Sun Kim

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

[diff] [blame]

625

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) ```

626

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`)

627

natName: string, Name of the nat service to filter the Nat Mapping information. If it is omitted, all nats for this router will be returned. Name should conform to RFC1035.

628

orderBy: string, Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name.

629

630

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.

631

632

Currently, only sorting by `name` or `creationTimestamp desc` is supported.

633

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.

634

returnPartialSuccess: boolean, Opt-in for partial success behavior which provides partial results in case of failure. The default value is false and the logic is the same as today.

Bu Sun Kim

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

[diff] [blame]

635

636

Returns:

637

An object of the form:

638

639

{ # Contains a list of VmEndpointNatMappings.

Bu Sun Kim

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

[diff] [blame]

640

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

641

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

642

"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.

643

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

Bu Sun Kim

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

[diff] [blame]

644

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

Bu Sun Kim

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

[diff] [blame]

645

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

646

"interfaceNatMappings": [

Bu Sun Kim

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

[diff] [blame]

647

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

Bu Sun Kim

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

[diff] [blame]

648

"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"].

649

"A String",

Bu Sun Kim

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

[diff] [blame]

650

],

Bu Sun Kim

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

[diff] [blame]

651

"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"].

652

"A String",

Bu Sun Kim

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

[diff] [blame]

653

],

Bu Sun Kim

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

[diff] [blame]

654

"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.

655

"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.

Dmitry Frenkel

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

[diff] [blame]

656

"ruleMappings": [ # Information about mappings provided by rules in this NAT.

657

{ # Contains information of NAT Mappings provided by a NAT Rule.

658

"drainNatIpPortRanges": [ # List of all drain IP:port-range mappings assigned to this interface by this rule. 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"].

659

"A String",

660

],

661

"natIpPortRanges": [ # A list of all IP:port-range mappings assigned to this interface by this rule. 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"].

662

"A String",

663

],

664

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

665

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

666

"ruleNumber": 42, # Rule number of the NAT Rule.

667

},

668

],

Bu Sun Kim

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

[diff] [blame]

669

"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".

670

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

Bu Sun Kim

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

[diff] [blame]

671

},

672

],

Bu Sun Kim

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

[diff] [blame]

673

},

674

],

Bu Sun Kim

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

[diff] [blame]

675

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

676

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

677

"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.

678

"data": [ # [Output Only] Metadata about this warning in key: value format. For example:

679

# "data": [ { "key": "scope", "value": "zones/us-east1-d" }

680

{

681

"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).

682

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

683

},

684

],

685

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

686

},

Bu Sun Kim

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

[diff] [blame]

}</pre>

</div>

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

692

<pre>Retrieves the next page of results.

693

694

Args:

695

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

696

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

697

698

Returns:

Bu Sun Kim

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

[diff] [blame]

699

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]

700

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

</pre>

</div>

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

705

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

706

<pre>Retrieves runtime information of the specified router.

707

708

Args:

709

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

710

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

711

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

712

713

Returns:

714

An object of the form:

715

716

{

Bu Sun Kim

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

[diff] [blame]

717

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

718

"result": {

719

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

720

{ # Represents a Route resource.

721

#

722

# 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. (== resource_for {$api_version}.routes ==)

723

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

724

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

725

"destRange": "A String", # The destination range of outgoing packets that this route applies to. Only IPv4 is supported.

726

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

727

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

728

"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.

729

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

730

"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

731

"nextHopIlb": "A String", # The URL to a forwarding rule of type loadBalancingScheme=INTERNAL that should handle matching packets. You can only specify the forwarding rule as a partial or full URL. For example, the following are all valid URLs:

732

# - https://www.googleapis.com/compute/v1/projects/project/regions/region/forwardingRules/forwardingRule

733

# - regions/region/forwardingRules/forwardingRule

734

"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:

735

# https://www.googleapis.com/compute/v1/projects/project/zones/zone/instances/

736

"nextHopInterconnectAttachment": "A String", # [Output Only] The URL to an InterconnectAttachment which is the next hop for the route. This field will only be populated for the dynamic routes generated by Cloud Router with a linked interconnectAttachment.

737

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

738

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

739

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

740

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

741

"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.

742

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

743

"selfLinkWithId": "A String", # [Output Only] Server-defined URL for this resource with the resource id.

744

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

745

"A String",

746

],

747

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

748

{

749

"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.

750

"data": [ # [Output Only] Metadata about this warning in key: value format. For example:

751

# "data": [ { "key": "scope", "value": "zones/us-east1-d" }

752

{

753

"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).

754

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

755

},

756

],

757

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

},

],

},

],

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

763

{ # Represents a Route resource.

764

#

765

# 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. (== resource_for {$api_version}.routes ==)

766

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

767

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

768

"destRange": "A String", # The destination range of outgoing packets that this route applies to. Only IPv4 is supported.

769

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

770

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

771

"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.

772

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

773

"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

774

"nextHopIlb": "A String", # The URL to a forwarding rule of type loadBalancingScheme=INTERNAL that should handle matching packets. You can only specify the forwarding rule as a partial or full URL. For example, the following are all valid URLs:

775

# - https://www.googleapis.com/compute/v1/projects/project/regions/region/forwardingRules/forwardingRule

776

# - regions/region/forwardingRules/forwardingRule

777

"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:

778

# https://www.googleapis.com/compute/v1/projects/project/zones/zone/instances/

779

"nextHopInterconnectAttachment": "A String", # [Output Only] The URL to an InterconnectAttachment which is the next hop for the route. This field will only be populated for the dynamic routes generated by Cloud Router with a linked interconnectAttachment.

780

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

781

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

782

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

783

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

784

"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.

785

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

786

"selfLinkWithId": "A String", # [Output Only] Server-defined URL for this resource with the resource id.

787

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

788

"A String",

789

],

790

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

791

{

792

"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.

793

"data": [ # [Output Only] Metadata about this warning in key: value format. For example:

794

# "data": [ { "key": "scope", "value": "zones/us-east1-d" }

795

{

796

"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).

797

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

798

},

799

],

800

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

},

],

},

],

"bgpPeerStatus": [

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

806

{

Bu Sun Kim

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

[diff] [blame]

807

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

Bu Sun Kim

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

[diff] [blame]

808

{ # Represents a Route resource.

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

809

#

Dan O'Meara

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

[diff] [blame]

810

# 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. (== resource_for {$api_version}.routes ==)

Bu Sun Kim

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

[diff] [blame]

811

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

812

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

813

"destRange": "A String", # The destination range of outgoing packets that this route applies to. Only IPv4 is supported.

814

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

815

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

816

"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.

817

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

818

"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

819

"nextHopIlb": "A String", # The URL to a forwarding rule of type loadBalancingScheme=INTERNAL that should handle matching packets. You can only specify the forwarding rule as a partial or full URL. For example, the following are all valid URLs:

Bu Sun Kim

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

[diff] [blame]

820

# - https://www.googleapis.com/compute/v1/projects/project/regions/region/forwardingRules/forwardingRule

Dan O'Meara

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

[diff] [blame]

821

# - regions/region/forwardingRules/forwardingRule

Bu Sun Kim

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

[diff] [blame]

822

"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:

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

823

# https://www.googleapis.com/compute/v1/projects/project/zones/zone/instances/

Bu Sun Kim

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

[diff] [blame]

824

"nextHopInterconnectAttachment": "A String", # [Output Only] The URL to an InterconnectAttachment which is the next hop for the route. This field will only be populated for the dynamic routes generated by Cloud Router with a linked interconnectAttachment.

825

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

826

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

827

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

828

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

829

"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.

830

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

831

"selfLinkWithId": "A String", # [Output Only] Server-defined URL for this resource with the resource id.

832

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

833

"A String",

834

],

835

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

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

836

{

Bu Sun Kim

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

[diff] [blame]

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.

838

"data": [ # [Output Only] Metadata about this warning in key: value format. For example:

839

# "data": [ { "key": "scope", "value": "zones/us-east1-d" }

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

840

{

Bu Sun Kim

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

[diff] [blame]

841

"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).

842

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

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

843

},

844

],

Bu Sun Kim

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

[diff] [blame]

845

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

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

},

],

},

],

Bu Sun Kim

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

[diff] [blame]

850

"bfdStatus": { # Next free: 15

851

"bfdSessionInitializationMode": "A String", # The BFD session initialization mode for this BGP peer. If set to ACTIVE, the Cloud Router will initiate the BFD session for this BGP peer. If set to PASSIVE, the Cloud Router will wait for the peer router to initiate the BFD session for this BGP peer. If set to DISABLED, BFD is disabled for this BGP peer.

852

"configUpdateTimestampMicros": "A String", # Unix timestamp of the most recent config update.

853

"controlPacketCounts": { # Control packet counts for the current BFD session.

854

"numRx": 42, # Number of packets received since the beginning of the current BFD session.

855

"numRxRejected": 42, # Number of packets received that were rejected because of errors since the beginning of the current BFD session.

856

"numRxSuccessful": 42, # Number of packets received that were successfully processed since the beginning of the current BFD session.

857

"numTx": 42, # Number of packets transmitted since the beginning of the current BFD session.

858

},

859

"controlPacketIntervals": [ # Inter-packet time interval statistics for control packets.

860

{ # Next free: 7

861

"avgMs": "A String", # Average observed inter-packet interval in milliseconds.

862

"duration": "A String", # From how long ago in the past these intervals were observed.

863

"maxMs": "A String", # Maximum observed inter-packet interval in milliseconds.

864

"minMs": "A String", # Minimum observed inter-packet interval in milliseconds.

865

"numIntervals": "A String", # Number of inter-packet intervals from which these statistics were derived.

866

"type": "A String", # The type of packets for which inter-packet intervals were computed.

867

},

868

],

869

"echoPacketCounts": { # Echo packet counts for the current BFD session.

870

"numRx": 42, # Number of packets received since the beginning of the current BFD session.

871

"numRxRejected": 42, # Number of packets received that were rejected because of errors since the beginning of the current BFD session.

872

"numRxSuccessful": 42, # Number of packets received that were successfully processed since the beginning of the current BFD session.

873

"numTx": 42, # Number of packets transmitted since the beginning of the current BFD session.

874

},

875

"echoPacketIntervals": [ # Inter-packet time interval statistics for echo packets.

876

{ # Next free: 7

877

"avgMs": "A String", # Average observed inter-packet interval in milliseconds.

878

"duration": "A String", # From how long ago in the past these intervals were observed.

879

"maxMs": "A String", # Maximum observed inter-packet interval in milliseconds.

880

"minMs": "A String", # Minimum observed inter-packet interval in milliseconds.

881

"numIntervals": "A String", # Number of inter-packet intervals from which these statistics were derived.

882

"type": "A String", # The type of packets for which inter-packet intervals were computed.

883

},

884

],

885

"localDiagnostic": "A String", # The diagnostic code specifies the local system's reason for the last change in session state. This allows remote systems to determine the reason that the previous session failed, for example. These diagnostic codes are specified in section 4.1 of RFC5880

886

"localState": "A String", # The current BFD session state as seen by the transmitting system. These states are specified in section 4.1 of RFC5880

887

"negotiatedLocalControlTxIntervalMs": 42, # Negotiated transmit interval for control packets.

888

"negotiatedLocalEchoTxIntervalMs": 42, # Negotiated transmit interval for echo packets.

889

"rxPacket": { # The most recent Rx control packet for this BFD session.

890

"authenticationPresent": True or False, # The Authentication Present bit of the BFD packet. This is specified in section 4.1 of RFC5880

891

"controlPlaneIndependent": True or False, # The Control Plane Independent bit of the BFD packet. This is specified in section 4.1 of RFC5880

892

"demand": True or False, # The demand bit of the BFD packet. This is specified in section 4.1 of RFC5880

893

"diagnostic": "A String", # The diagnostic code specifies the local system's reason for the last change in session state. This allows remote systems to determine the reason that the previous session failed, for example. These diagnostic codes are specified in section 4.1 of RFC5880

894

"final": True or False, # The Final bit of the BFD packet. This is specified in section 4.1 of RFC5880

895

"length": 42, # The length of the BFD Control packet in bytes. This is specified in section 4.1 of RFC5880

896

"minEchoRxIntervalMs": 42, # The Required Min Echo RX Interval value in the BFD packet. This is specified in section 4.1 of RFC5880

897

"minRxIntervalMs": 42, # The Required Min RX Interval value in the BFD packet. This is specified in section 4.1 of RFC5880

898

"minTxIntervalMs": 42, # The Desired Min TX Interval value in the BFD packet. This is specified in section 4.1 of RFC5880

899

"multiplier": 42, # The detection time multiplier of the BFD packet. This is specified in section 4.1 of RFC5880

900

"multipoint": True or False, # The multipoint bit of the BFD packet. This is specified in section 4.1 of RFC5880

901

"myDiscriminator": 42, # The My Discriminator value in the BFD packet. This is specified in section 4.1 of RFC5880

902

"poll": True or False, # The Poll bit of the BFD packet. This is specified in section 4.1 of RFC5880

903

"state": "A String", # The current BFD session state as seen by the transmitting system. These states are specified in section 4.1 of RFC5880

904

"version": 42, # The version number of the BFD protocol, as specified in section 4.1 of RFC5880.

905

"yourDiscriminator": 42, # The Your Discriminator value in the BFD packet. This is specified in section 4.1 of RFC5880

906

},

907

"txPacket": { # The most recent Tx control packet for this BFD session.

908

"authenticationPresent": True or False, # The Authentication Present bit of the BFD packet. This is specified in section 4.1 of RFC5880

909

"controlPlaneIndependent": True or False, # The Control Plane Independent bit of the BFD packet. This is specified in section 4.1 of RFC5880

910

"demand": True or False, # The demand bit of the BFD packet. This is specified in section 4.1 of RFC5880

911

"diagnostic": "A String", # The diagnostic code specifies the local system's reason for the last change in session state. This allows remote systems to determine the reason that the previous session failed, for example. These diagnostic codes are specified in section 4.1 of RFC5880

912

"final": True or False, # The Final bit of the BFD packet. This is specified in section 4.1 of RFC5880

913

"length": 42, # The length of the BFD Control packet in bytes. This is specified in section 4.1 of RFC5880

914

"minEchoRxIntervalMs": 42, # The Required Min Echo RX Interval value in the BFD packet. This is specified in section 4.1 of RFC5880

915

"minRxIntervalMs": 42, # The Required Min RX Interval value in the BFD packet. This is specified in section 4.1 of RFC5880

916

"minTxIntervalMs": 42, # The Desired Min TX Interval value in the BFD packet. This is specified in section 4.1 of RFC5880

917

"multiplier": 42, # The detection time multiplier of the BFD packet. This is specified in section 4.1 of RFC5880

918

"multipoint": True or False, # The multipoint bit of the BFD packet. This is specified in section 4.1 of RFC5880

919

"myDiscriminator": 42, # The My Discriminator value in the BFD packet. This is specified in section 4.1 of RFC5880

920

"poll": True or False, # The Poll bit of the BFD packet. This is specified in section 4.1 of RFC5880

921

"state": "A String", # The current BFD session state as seen by the transmitting system. These states are specified in section 4.1 of RFC5880

922

"version": 42, # The version number of the BFD protocol, as specified in section 4.1 of RFC5880.

923

"yourDiscriminator": 42, # The Your Discriminator value in the BFD packet. This is specified in section 4.1 of RFC5880

924

},

925

"uptimeMs": "A String", # Session uptime in milliseconds. Value will be 0 if session is not up.

926

"usingEchoMode": True or False, # Indicates if echo mode is currently being used.

927

},

928

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

929

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

930

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

931

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

932

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

933

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

934

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

935

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

936

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

Bu Sun Kim

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

[diff] [blame]

937

},

938

],

Bu Sun Kim

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

[diff] [blame]

939

"natStatus": [

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

940

{ # Status of a NAT contained in this router.

Bu Sun Kim

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

[diff] [blame]

941

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

942

"A String",

Bu Sun Kim

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

[diff] [blame]

943

],

Bu Sun Kim

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

[diff] [blame]

944

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

945

"A String",

Bu Sun Kim

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

[diff] [blame]

946

],

Bu Sun Kim

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

[diff] [blame]

947

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

948

"A String",

Bu Sun Kim

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

[diff] [blame]

949

],

Bu Sun Kim

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

[diff] [blame]

950

"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.

951

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

952

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

Dmitry Frenkel

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

[diff] [blame]

953

"ruleStatus": [ # Status of rules in this NAT.

954

{ # Status of a NAT Rule contained in this NAT.

955

"activeNatIps": [ # A list of active IPs for NAT. Example: ["1.1.1.1", "179.12.26.133"].

956

"A String",

957

],

958

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

959

"A String",

960

],

961

"minExtraIpsNeeded": 42, # The number of extra IPs to allocate. This will be greater than 0 only if the existing IPs in this NAT Rule are NOT enough to allow all configured VMs to use NAT.

962

"numVmEndpointsWithNatMappings": 42, # Number of VM endpoints (i.e., NICs) that have NAT Mappings from this NAT Rule.

963

"ruleNumber": 42, # Rule number of the rule.

964

},

965

],

Bu Sun Kim

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

[diff] [blame]

966

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

967

"A String",

Bu Sun Kim

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

[diff] [blame]

968

],

Bu Sun Kim

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

[diff] [blame]

969

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

970

"A String",

Bu Sun Kim

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

[diff] [blame]

971

],

Sai Cheemalapati

c30d2b5

2017-03-13 12:12:03 -0400

[diff] [blame]

972

},

973

],

Bu Sun Kim

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

[diff] [blame]

974

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

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

},

}</pre>

</div>

Dan O'Meara

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

[diff] [blame]

980

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

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

981

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

982

983

Args:

984

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

985

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

Dan O'Meara

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

[diff] [blame]

986

body: object, The request body.

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

987

The object takes the form of:

988

Bu Sun Kim

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

[diff] [blame]

989

{ # Represents a Cloud Router resource.

Bu Sun Kim

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

[diff] [blame]

990

#

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

991

# For more information about Cloud Router, read the Cloud Router overview.

Bu Sun Kim

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

[diff] [blame]

992

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

993

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

994

"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.

995

"A String",

996

],

997

"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.

998

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

999

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

1000

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

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

1001

},

1002

],

Bu Sun Kim

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

[diff] [blame]

1003

"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.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

1004

"keepaliveInterval": 42, # The interval in seconds between BGP keepalive messages that are sent to the peer.

1005

# Not currently available publicly.

1006

# 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.

1007

# 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.

1008

# If set, this value must be between 1 and 120. The default is 20.

Bu Sun Kim

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

[diff] [blame]

1009

},

1010

"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.

1011

{

1012

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

1013

"advertisedGroups": [ # User-specified list of prefix groups to advertise in custom mode, which can take one of the following options:

1014

# - ALL_SUBNETS: Advertises all available subnets, including peer VPC subnets.

1015

# - ALL_VPC_SUBNETS: Advertises the router's own VPC subnets.

1016

# - ALL_PEER_VPC_SUBNETS: Advertises peer subnets of the router's VPC network. 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.

1017

"A String",

1018

],

1019

"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]

1020

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

Bu Sun Kim

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

[diff] [blame]

1021

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

1022

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

Sai Cheemalapati

2017-06-06 18:46:08 -0400

[diff] [blame]

1023

},

1024

],

Bu Sun Kim

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

[diff] [blame]

1025

"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.

1026

"bfd": { # BFD configuration for the BGP peering.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

1027

# Not currently available publicly.

1028

"minReceiveInterval": 42, # The minimum interval, in milliseconds, between BFD control packets received from the peer router. The actual value is negotiated between the two routers and is equal to the greater of this value and the transmit interval of the other router.

1029

# Not currently available publicly.

1030

# If set, this value must be between 100 and 30000.

1031

# The default is 300.

1032

"minTransmitInterval": 42, # The minimum interval, in milliseconds, between BFD control packets transmitted to the peer router. The actual value is negotiated between the two routers and is equal to the greater of this value and the corresponding receive interval of the other router.

1033

# Not currently available publicly.

1034

# If set, this value must be between 100 and 30000.

1035

# The default is 300.

Bu Sun Kim

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

[diff] [blame]

1036

"mode": "A String", # The BFD session initialization mode for this BGP peer. If set to ACTIVE, the Cloud Router will initiate the BFD session for this BGP peer. If set to PASSIVE, the Cloud Router will wait for the peer router to initiate the BFD session for this BGP peer. If set to DISABLED, BFD is disabled for this BGP peer. The default is PASSIVE.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

1037

"multiplier": 42, # The number of consecutive BFD packets that must be missed before BFD declares that a peer is unavailable.

1038

# Not currently available publicly.

1039

# If set, the value must be a value between 2 and 16.

1040

# The default is 3.

Bu Sun Kim

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

[diff] [blame]

1041

"packetMode": "A String", # The BFD packet mode for this BGP peer. If set to CONTROL_AND_ECHO, BFD echo mode is enabled for this BGP peer. In this mode, if the peer router also has BFD echo mode enabled, BFD echo packets will be sent to the other router. If the peer router does not have BFD echo mode enabled, only control packets will be sent. If set to CONTROL_ONLY, BFD echo mode is disabled for this BGP peer. If this router and the peer router have a multihop connection, this should be set to CONTROL_ONLY as BFD echo mode is only supported on singlehop connections. The default is CONTROL_AND_ECHO.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

1042

"sessionInitializationMode": "A String", # The BFD session initialization mode for this BGP peer.

1043

# Not currently available publicly.

1044

# If set to ACTIVE, the Cloud Router will initiate the BFD session for this BGP peer. If set to PASSIVE, the Cloud Router will wait for the peer router to initiate the BFD session for this BGP peer. If set to DISABLED, BFD is disabled for this BGP peer. The default is PASSIVE.

Bu Sun Kim

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

[diff] [blame]

1045

"slowTimerInterval": 42, # The minimum interval, in milliseconds, between BFD control packets transmitted to and received from the peer router when BFD echo mode is enabled on both routers. The actual transmit and receive intervals are negotiated between the two routers and are equal to the greater of this value and the corresponding interval on the other router. If set, this value must be between 1000 and 30000. The default is 5000.

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

1046

},

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

1047

"enable": "A String", # The status of the BGP peer connection.

1048

# Not currently available publicly.

1049

# 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]

1050

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

1051

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

1052

"managementType": "A String", # [Output Only] The resource that configures and manages this BGP peer.

1053

# - MANAGED_BY_USER is the default value and can be managed by you or other users

1054

# - 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.

1055

"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.

1056

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

1057

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

1058

},

1059

],

1060

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

1061

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

1062

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

1063

"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.

1064

{

1065

"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.

1066

"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.

1067

"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.

1068

"managementType": "A String", # [Output Only] The resource that configures and manages this interface.

1069

# - MANAGED_BY_USER is the default value and can be managed directly by users.

1070

# - 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.

1071

"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.

1072

},

1073

],

1074

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

1075

"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.

1076

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

1077

{ # 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.

1078

"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.

1079

"A String",

1080

],

1081

"enableEndpointIndependentMapping": True or False,

1082

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

1083

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

1084

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

1085

"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:

1086

# - ERRORS_ONLY: Export logs only for connection failures.

1087

# - TRANSLATIONS_ONLY: Export logs only for successful connections.

1088

# - ALL: Export logs for all connections, successful and unsuccessful.

1089

},

1090

"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.

1091

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

1092

"natIpAllocateOption": "A String", # Specify the NatIpAllocateOption, which can take one of the following values:

1093

# - 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.

1094

# - 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.

1095

"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.

1096

"A String",

1097

],

1098

"rules": [ # A list of rules associated with this NAT.

1099

{

1100

"action": { # The action to be enforced for traffic that matches this rule.

1101

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

1102

"A String",

1103

],

1104

"sourceNatDrainIps": [ # 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 rule only.

"A String",

],

},

"description": "A String", # An optional description of this rule.

1109

"match": "A String", # CEL expression that specifies the match condition that egress traffic from a VM is evaluated against. If it evaluates to true, the corresponding ?action? is enforced.

1110

#

1111

# The following examples are valid match expressions:

1112

#

1113

# "inIpRange(destination.ip, '1.1.0.0/16') || inIpRange(destination.ip, '2.2.0.0/16')"

1114

#

1115

# "destination.ip == '1.1.0.1' || destination.ip == '8.8.8.8'"

Dmitry Frenkel

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

[diff] [blame]

1116

"ruleNumber": 42, # An integer uniquely identifying a rule in the list. The rule number must be a positive value between 0 and 65000, and must be unique among rules within a NAT.

Bu Sun Kim

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

[diff] [blame]

1117

},

1118

],

1119

"sourceSubnetworkIpRangesToNat": "A String", # Specify the Nat option, which can take one of the following values:

1120

# - ALL_SUBNETWORKS_ALL_IP_RANGES: All of the IP ranges in every Subnetwork are allowed to Nat.

1121

# - ALL_SUBNETWORKS_ALL_PRIMARY_IP_RANGES: All of the primary IP ranges in every Subnetwork are allowed to Nat.

1122

# - 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.

1123

"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.

1124

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

1125

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

1126

"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.

1127

"A String",

1128

],

1129

"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.

1135

"tcpTimeWaitTimeoutSec": 42, # Timeout (in seconds) for TCP connections that are in TIME_WAIT state. Defaults to 120s if not set.

1136

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

1137

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

1138

},

1139

],

1140

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

1141

"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.

1142

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

1143

"selfLinkWithId": "A String", # [Output Only] Server-defined URL for this resource with the resource id.

1144

}

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

1145

Bu Sun Kim

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

[diff] [blame]

1146

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.

1147

1148

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.

1149

1150

The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

1151

1152

Returns:

1153

An object of the form:

1154

Bu Sun Kim

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

[diff] [blame]

1155

{ # Represents an Operation resource.

1156

#

Dan O'Meara

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

[diff] [blame]

1157

# Google Compute Engine has three Operation resources:

1158

#

1159

# * [Global](/compute/docs/reference/rest/{$api_version}/globalOperations) * [Regional](/compute/docs/reference/rest/{$api_version}/regionOperations) * [Zonal](/compute/docs/reference/rest/{$api_version}/zoneOperations)

1160

#

Bu Sun Kim

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

[diff] [blame]

1161

# You can use an operation resource to manage asynchronous API requests. For more information, read Handling API responses.

1162

#

1163

# Operations can be global, regional or zonal.

Dan O'Meara

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

[diff] [blame]

1164

# - For global operations, use the `globalOperations` resource.

1165

# - For regional operations, use the `regionOperations` resource.

1166

# - For zonal operations, use the `zonalOperations` resource.

Bu Sun Kim

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

[diff] [blame]

1167

#

Dan O'Meara

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

[diff] [blame]

1168

# For more information, read Global, Regional, and Zonal Resources. (== resource_for {$api_version}.globalOperations ==) (== resource_for {$api_version}.regionOperations ==) (== resource_for {$api_version}.zoneOperations ==)

Bu Sun Kim

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

[diff] [blame]

1169

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

1170

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

1171

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

1172

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

1173

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

1174

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

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

1175

{

Bu Sun Kim

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

[diff] [blame]

1176

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

1177

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

1178

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

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

1179

},

1180

],

1181

},

Bu Sun Kim

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

[diff] [blame]

1182

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

1183

"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.

1184

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

1185

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

1186

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

1187

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

1188

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

1189

"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.

1190

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

1191

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

1192

"selfLinkWithId": "A String", # [Output Only] Server-defined URL for this resource with the resource id.

1193

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

1194

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

1195

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

1196

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

1197

"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.

1198

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

1199

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

1200

{

1201

"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.

1202

"data": [ # [Output Only] Metadata about this warning in key: value format. For example:

1203

# "data": [ { "key": "scope", "value": "zones/us-east1-d" }

1204

{

1205

"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).

1206

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

1207

},

1208

],

1209

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

1210

},

1211

],

1212

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

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

}</pre>

</div>

Bu Sun Kim

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

[diff] [blame]

1217

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

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

1218

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

1219

1220

Args:

1221

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

1222

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

Dan O'Meara

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

[diff] [blame]

1223

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 `<`.

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

1224

Dan O'Meara

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

[diff] [blame]

1225

For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`.

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

1226

Dan O'Meara

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

[diff] [blame]

1227

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.

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

1228

Bu Sun Kim

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

[diff] [blame]

1229

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) ```

1230

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`)

1231

orderBy: string, Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name.

1232

1233

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.

1234

1235

Currently, only sorting by `name` or `creationTimestamp desc` is supported.

1236

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.

1237

returnPartialSuccess: boolean, Opt-in for partial success behavior which provides partial results in case of failure. The default value is false and the logic is the same as today.

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

1238

1239

Returns:

1240

An object of the form:

1241

1242

{ # Contains a list of Router resources.

Bu Sun Kim

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

[diff] [blame]

1243

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

1244

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

Bu Sun Kim

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

[diff] [blame]

1245

{ # Represents a Cloud Router resource.

Bu Sun Kim

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

[diff] [blame]

1246

#

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

1247

# For more information about Cloud Router, read the Cloud Router overview.

Bu Sun Kim

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

[diff] [blame]

1248

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

1249

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

1250

"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.

1251

"A String",

1252

],

1253

"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.

1254

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

1255

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

1256

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

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

1257

},

1258

],

Bu Sun Kim

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

[diff] [blame]

1259

"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.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

1260

"keepaliveInterval": 42, # The interval in seconds between BGP keepalive messages that are sent to the peer.

1261

# Not currently available publicly.

1262

# 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.

1263

# 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.

1264

# If set, this value must be between 1 and 120. The default is 20.

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

1265

},

Bu Sun Kim

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

[diff] [blame]

1266

"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.

1267

{

1268

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

1269

"advertisedGroups": [ # User-specified list of prefix groups to advertise in custom mode, which can take one of the following options:

1270

# - ALL_SUBNETS: Advertises all available subnets, including peer VPC subnets.

1271

# - ALL_VPC_SUBNETS: Advertises the router's own VPC subnets.

1272

# - ALL_PEER_VPC_SUBNETS: Advertises peer subnets of the router's VPC network. 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.

1273

"A String",

1274

],

1275

"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.

1276

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

1277

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

1278

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

1279

},

1280

],

1281

"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.

1282

"bfd": { # BFD configuration for the BGP peering.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

1283

# Not currently available publicly.

1284

"minReceiveInterval": 42, # The minimum interval, in milliseconds, between BFD control packets received from the peer router. The actual value is negotiated between the two routers and is equal to the greater of this value and the transmit interval of the other router.

1285

# Not currently available publicly.

1286

# If set, this value must be between 100 and 30000.

1287

# The default is 300.

1288

"minTransmitInterval": 42, # The minimum interval, in milliseconds, between BFD control packets transmitted to the peer router. The actual value is negotiated between the two routers and is equal to the greater of this value and the corresponding receive interval of the other router.

1289

# Not currently available publicly.

1290

# If set, this value must be between 100 and 30000.

1291

# The default is 300.

Bu Sun Kim

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

[diff] [blame]

1292

"mode": "A String", # The BFD session initialization mode for this BGP peer. If set to ACTIVE, the Cloud Router will initiate the BFD session for this BGP peer. If set to PASSIVE, the Cloud Router will wait for the peer router to initiate the BFD session for this BGP peer. If set to DISABLED, BFD is disabled for this BGP peer. The default is PASSIVE.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

1293

"multiplier": 42, # The number of consecutive BFD packets that must be missed before BFD declares that a peer is unavailable.

1294

# Not currently available publicly.

1295

# If set, the value must be a value between 2 and 16.

1296

# The default is 3.

Bu Sun Kim

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

[diff] [blame]

1297

"packetMode": "A String", # The BFD packet mode for this BGP peer. If set to CONTROL_AND_ECHO, BFD echo mode is enabled for this BGP peer. In this mode, if the peer router also has BFD echo mode enabled, BFD echo packets will be sent to the other router. If the peer router does not have BFD echo mode enabled, only control packets will be sent. If set to CONTROL_ONLY, BFD echo mode is disabled for this BGP peer. If this router and the peer router have a multihop connection, this should be set to CONTROL_ONLY as BFD echo mode is only supported on singlehop connections. The default is CONTROL_AND_ECHO.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

1298

"sessionInitializationMode": "A String", # The BFD session initialization mode for this BGP peer.

1299

# Not currently available publicly.

1300

# If set to ACTIVE, the Cloud Router will initiate the BFD session for this BGP peer. If set to PASSIVE, the Cloud Router will wait for the peer router to initiate the BFD session for this BGP peer. If set to DISABLED, BFD is disabled for this BGP peer. The default is PASSIVE.

Bu Sun Kim

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

[diff] [blame]

1301

"slowTimerInterval": 42, # The minimum interval, in milliseconds, between BFD control packets transmitted to and received from the peer router when BFD echo mode is enabled on both routers. The actual transmit and receive intervals are negotiated between the two routers and are equal to the greater of this value and the corresponding interval on the other router. If set, this value must be between 1000 and 30000. The default is 5000.

1302

},

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

1303

"enable": "A String", # The status of the BGP peer connection.

1304

# Not currently available publicly.

1305

# 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]

1306

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

1307

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

1308

"managementType": "A String", # [Output Only] The resource that configures and manages this BGP peer.

1309

# - MANAGED_BY_USER is the default value and can be managed by you or other users

1310

# - 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.

1311

"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.

1312

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

1313

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

1314

},

1315

],

1316

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

1317

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

1318

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

1319

"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.

1320

{

1321

"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.

1322

"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.

1323

"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.

1324

"managementType": "A String", # [Output Only] The resource that configures and manages this interface.

1325

# - MANAGED_BY_USER is the default value and can be managed directly by users.

1326

# - 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.

1327

"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.

1328

},

1329

],

1330

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

1331

"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.

1332

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

1333

{ # 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.

1334

"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.

1335

"A String",

1336

],

1337

"enableEndpointIndependentMapping": True or False,

1338

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

1339

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

1340

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

1341

"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:

1342

# - ERRORS_ONLY: Export logs only for connection failures.

1343

# - TRANSLATIONS_ONLY: Export logs only for successful connections.

1344

# - ALL: Export logs for all connections, successful and unsuccessful.

1345

},

1346

"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.

1347

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

1348

"natIpAllocateOption": "A String", # Specify the NatIpAllocateOption, which can take one of the following values:

1349

# - 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.

1350

# - 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.

1351

"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.

1352

"A String",

1353

],

1354

"rules": [ # A list of rules associated with this NAT.

1355

{

1356

"action": { # The action to be enforced for traffic that matches this rule.

1357

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

1358

"A String",

1359

],

1360

"sourceNatDrainIps": [ # 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 rule only.

"A String",

],

},

"description": "A String", # An optional description of this rule.

1365

"match": "A String", # CEL expression that specifies the match condition that egress traffic from a VM is evaluated against. If it evaluates to true, the corresponding ?action? is enforced.

1366

#

1367

# The following examples are valid match expressions:

1368

#

1369

# "inIpRange(destination.ip, '1.1.0.0/16') || inIpRange(destination.ip, '2.2.0.0/16')"

1370

#

1371

# "destination.ip == '1.1.0.1' || destination.ip == '8.8.8.8'"

Dmitry Frenkel

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

[diff] [blame]

1372

"ruleNumber": 42, # An integer uniquely identifying a rule in the list. The rule number must be a positive value between 0 and 65000, and must be unique among rules within a NAT.

Bu Sun Kim

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

[diff] [blame]

1373

},

1374

],

1375

"sourceSubnetworkIpRangesToNat": "A String", # Specify the Nat option, which can take one of the following values:

1376

# - ALL_SUBNETWORKS_ALL_IP_RANGES: All of the IP ranges in every Subnetwork are allowed to Nat.

1377

# - ALL_SUBNETWORKS_ALL_PRIMARY_IP_RANGES: All of the primary IP ranges in every Subnetwork are allowed to Nat.

1378

# - 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.

1379

"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.

1380

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

1381

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

1382

"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.

1383

"A String",

1384

],

1385

"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.

1391

"tcpTimeWaitTimeoutSec": 42, # Timeout (in seconds) for TCP connections that are in TIME_WAIT state. Defaults to 120s if not set.

1392

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

1393

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

1394

},

1395

],

1396

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

1397

"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.

1398

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

1399

"selfLinkWithId": "A String", # [Output Only] Server-defined URL for this resource with the resource id.

1400

},

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

1401

],

Bu Sun Kim

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

[diff] [blame]

1402

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

1403

"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.

1404

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

1405

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

1406

"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.

1407

"data": [ # [Output Only] Metadata about this warning in key: value format. For example:

1408

# "data": [ { "key": "scope", "value": "zones/us-east1-d" }

Bu Sun Kim

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

[diff] [blame]

1409

{

Bu Sun Kim

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

[diff] [blame]

1410

"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).

1411

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

Bu Sun Kim

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

[diff] [blame]

1412

},

1413

],

Bu Sun Kim

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

[diff] [blame]

1414

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

Bu Sun Kim

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

[diff] [blame]

1415

},

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

}</pre>

</div>

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

1421

<pre>Retrieves the next page of results.

1422

1423

Args:

1424

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

1425

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

1426

1427

Returns:

Bu Sun Kim

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

[diff] [blame]

1428

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

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

1429

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

</pre>

</div>

Dan O'Meara

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

[diff] [blame]

1434

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

Bu Sun Kim

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

[diff] [blame]

1435

<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.

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

1436

1437

Args:

1438

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

1439

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

Sai Cheemalapati

c30d2b5

2017-03-13 12:12:03 -0400

[diff] [blame]

1440

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

Dan O'Meara

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

[diff] [blame]

1441

body: object, The request body.

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

1442

The object takes the form of:

1443

Bu Sun Kim

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

[diff] [blame]

1444

{ # Represents a Cloud Router resource.

Bu Sun Kim

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

[diff] [blame]

1445

#

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

1446

# For more information about Cloud Router, read the Cloud Router overview.

Bu Sun Kim

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

[diff] [blame]

1447

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

1448

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

1449

"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.

1450

"A String",

1451

],

1452

"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.

1453

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

1454

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

1455

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

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

1456

},

1457

],

Bu Sun Kim

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

[diff] [blame]

1458

"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.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

1459

"keepaliveInterval": 42, # The interval in seconds between BGP keepalive messages that are sent to the peer.

1460

# Not currently available publicly.

1461

# 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.

1462

# 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.

1463

# If set, this value must be between 1 and 120. The default is 20.

Bu Sun Kim

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

[diff] [blame]

1464

},

1465

"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.

1466

{

1467

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

1468

"advertisedGroups": [ # User-specified list of prefix groups to advertise in custom mode, which can take one of the following options:

1469

# - ALL_SUBNETS: Advertises all available subnets, including peer VPC subnets.

1470

# - ALL_VPC_SUBNETS: Advertises the router's own VPC subnets.

1471

# - ALL_PEER_VPC_SUBNETS: Advertises peer subnets of the router's VPC network. 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.

1472

"A String",

1473

],

1474

"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]

1475

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

Bu Sun Kim

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

[diff] [blame]

1476

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

1477

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

Sai Cheemalapati

2017-06-06 18:46:08 -0400

[diff] [blame]

1478

},

1479

],

Bu Sun Kim

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

[diff] [blame]

1480

"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.

1481

"bfd": { # BFD configuration for the BGP peering.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

1482

# Not currently available publicly.

1483

"minReceiveInterval": 42, # The minimum interval, in milliseconds, between BFD control packets received from the peer router. The actual value is negotiated between the two routers and is equal to the greater of this value and the transmit interval of the other router.

1484

# Not currently available publicly.

1485

# If set, this value must be between 100 and 30000.

1486

# The default is 300.

1487

"minTransmitInterval": 42, # The minimum interval, in milliseconds, between BFD control packets transmitted to the peer router. The actual value is negotiated between the two routers and is equal to the greater of this value and the corresponding receive interval of the other router.

1488

# Not currently available publicly.

1489

# If set, this value must be between 100 and 30000.

1490

# The default is 300.

Bu Sun Kim

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

[diff] [blame]

1491

"mode": "A String", # The BFD session initialization mode for this BGP peer. If set to ACTIVE, the Cloud Router will initiate the BFD session for this BGP peer. If set to PASSIVE, the Cloud Router will wait for the peer router to initiate the BFD session for this BGP peer. If set to DISABLED, BFD is disabled for this BGP peer. The default is PASSIVE.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

1492

"multiplier": 42, # The number of consecutive BFD packets that must be missed before BFD declares that a peer is unavailable.

1493

# Not currently available publicly.

1494

# If set, the value must be a value between 2 and 16.

1495

# The default is 3.

Bu Sun Kim

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

[diff] [blame]

1496

"packetMode": "A String", # The BFD packet mode for this BGP peer. If set to CONTROL_AND_ECHO, BFD echo mode is enabled for this BGP peer. In this mode, if the peer router also has BFD echo mode enabled, BFD echo packets will be sent to the other router. If the peer router does not have BFD echo mode enabled, only control packets will be sent. If set to CONTROL_ONLY, BFD echo mode is disabled for this BGP peer. If this router and the peer router have a multihop connection, this should be set to CONTROL_ONLY as BFD echo mode is only supported on singlehop connections. The default is CONTROL_AND_ECHO.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

1497

"sessionInitializationMode": "A String", # The BFD session initialization mode for this BGP peer.

1498

# Not currently available publicly.

1499

# If set to ACTIVE, the Cloud Router will initiate the BFD session for this BGP peer. If set to PASSIVE, the Cloud Router will wait for the peer router to initiate the BFD session for this BGP peer. If set to DISABLED, BFD is disabled for this BGP peer. The default is PASSIVE.

Bu Sun Kim

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

[diff] [blame]

1500

"slowTimerInterval": 42, # The minimum interval, in milliseconds, between BFD control packets transmitted to and received from the peer router when BFD echo mode is enabled on both routers. The actual transmit and receive intervals are negotiated between the two routers and are equal to the greater of this value and the corresponding interval on the other router. If set, this value must be between 1000 and 30000. The default is 5000.

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

1501

},

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

1502

"enable": "A String", # The status of the BGP peer connection.

1503

# Not currently available publicly.

1504

# 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]

1505

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

1506

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

1507

"managementType": "A String", # [Output Only] The resource that configures and manages this BGP peer.

1508

# - MANAGED_BY_USER is the default value and can be managed by you or other users

1509

# - 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.

1510

"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.

1511

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

1512

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

1513

},

1514

],

1515

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

1516

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

1517

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

1518

"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.

1519

{

1520

"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.

1521

"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.

1522

"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.

1523

"managementType": "A String", # [Output Only] The resource that configures and manages this interface.

1524

# - MANAGED_BY_USER is the default value and can be managed directly by users.

1525

# - 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.

1526

"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.

1527

},

1528

],

1529

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

1530

"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.

1531

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

1532

{ # 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.

1533

"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.

1534

"A String",

1535

],

1536

"enableEndpointIndependentMapping": True or False,

1537

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

1538

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

1539

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

1540

"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:

1541

# - ERRORS_ONLY: Export logs only for connection failures.

1542

# - TRANSLATIONS_ONLY: Export logs only for successful connections.

1543

# - ALL: Export logs for all connections, successful and unsuccessful.

1544

},

1545

"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.

1546

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

1547

"natIpAllocateOption": "A String", # Specify the NatIpAllocateOption, which can take one of the following values:

1548

# - 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.

1549

# - 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.

1550

"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.

1551

"A String",

1552

],

1553

"rules": [ # A list of rules associated with this NAT.

1554

{

1555

"action": { # The action to be enforced for traffic that matches this rule.

1556

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

1557

"A String",

1558

],

1559

"sourceNatDrainIps": [ # 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 rule only.

"A String",

],

},

"description": "A String", # An optional description of this rule.

1564

"match": "A String", # CEL expression that specifies the match condition that egress traffic from a VM is evaluated against. If it evaluates to true, the corresponding ?action? is enforced.

1565

#

1566

# The following examples are valid match expressions:

1567

#

1568

# "inIpRange(destination.ip, '1.1.0.0/16') || inIpRange(destination.ip, '2.2.0.0/16')"

1569

#

1570

# "destination.ip == '1.1.0.1' || destination.ip == '8.8.8.8'"

Dmitry Frenkel

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

[diff] [blame]

1571

"ruleNumber": 42, # An integer uniquely identifying a rule in the list. The rule number must be a positive value between 0 and 65000, and must be unique among rules within a NAT.

Bu Sun Kim

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

[diff] [blame]

1572

},

1573

],

1574

"sourceSubnetworkIpRangesToNat": "A String", # Specify the Nat option, which can take one of the following values:

1575

# - ALL_SUBNETWORKS_ALL_IP_RANGES: All of the IP ranges in every Subnetwork are allowed to Nat.

1576

# - ALL_SUBNETWORKS_ALL_PRIMARY_IP_RANGES: All of the primary IP ranges in every Subnetwork are allowed to Nat.

1577

# - 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.

1578

"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.

1579

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

1580

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

1581

"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.

1582

"A String",

1583

],

1584

"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.

1590

"tcpTimeWaitTimeoutSec": 42, # Timeout (in seconds) for TCP connections that are in TIME_WAIT state. Defaults to 120s if not set.

1591

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

1592

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

1593

},

1594

],

1595

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

1596

"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.

1597

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

1598

"selfLinkWithId": "A String", # [Output Only] Server-defined URL for this resource with the resource id.

1599

}

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

1600

Bu Sun Kim

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

[diff] [blame]

1601

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.

1602

1603

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.

1604

1605

The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

1606

1607

Returns:

1608

An object of the form:

1609

Bu Sun Kim

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

[diff] [blame]

1610

{ # Represents an Operation resource.

1611

#

Dan O'Meara

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

[diff] [blame]

1612

# Google Compute Engine has three Operation resources:

1613

#

1614

# * [Global](/compute/docs/reference/rest/{$api_version}/globalOperations) * [Regional](/compute/docs/reference/rest/{$api_version}/regionOperations) * [Zonal](/compute/docs/reference/rest/{$api_version}/zoneOperations)

1615

#

Bu Sun Kim

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

[diff] [blame]

1616

# You can use an operation resource to manage asynchronous API requests. For more information, read Handling API responses.

1617

#

1618

# Operations can be global, regional or zonal.

Dan O'Meara

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

[diff] [blame]

1619

# - For global operations, use the `globalOperations` resource.

1620

# - For regional operations, use the `regionOperations` resource.

1621

# - For zonal operations, use the `zonalOperations` resource.

Bu Sun Kim

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

[diff] [blame]

1622

#

Dan O'Meara

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

[diff] [blame]

1623

# For more information, read Global, Regional, and Zonal Resources. (== resource_for {$api_version}.globalOperations ==) (== resource_for {$api_version}.regionOperations ==) (== resource_for {$api_version}.zoneOperations ==)

Bu Sun Kim

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

[diff] [blame]

1624

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

1625

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

1626

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

1627

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

1628

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

1629

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

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

1630

{

Bu Sun Kim

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

[diff] [blame]

1631

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

1632

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

1633

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

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

1634

},

1635

],

1636

},

Bu Sun Kim

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

[diff] [blame]

1637

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

1638

"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.

1639

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

1640

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

1641

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

1642

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

1643

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

1644

"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.

1645

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

1646

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

1647

"selfLinkWithId": "A String", # [Output Only] Server-defined URL for this resource with the resource id.

1648

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

1649

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

1650

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

1651

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

1652

"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.

1653

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

1654

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

1655

{

1656

"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.

1657

"data": [ # [Output Only] Metadata about this warning in key: value format. For example:

1658

# "data": [ { "key": "scope", "value": "zones/us-east1-d" }

1659

{

1660

"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).

1661

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

1662

},

1663

],

1664

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

1665

},

1666

],

1667

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

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

}</pre>

</div>

Dan O'Meara

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

[diff] [blame]

1672

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

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

1673

<pre>Preview fields auto-generated during router create and update operations. Calling this method does NOT create or update the router.

1674

1675

Args:

1676

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

1677

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

1678

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

Dan O'Meara

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

[diff] [blame]

1679

body: object, The request body.

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

1680

The object takes the form of:

1681

Bu Sun Kim

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

[diff] [blame]

1682

{ # Represents a Cloud Router resource.

Bu Sun Kim

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

[diff] [blame]

1683

#

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

1684

# For more information about Cloud Router, read the Cloud Router overview.

Bu Sun Kim

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

[diff] [blame]

1685

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

1686

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

1687

"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.

1688

"A String",

1689

],

1690

"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.

1691

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

1692

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

1693

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

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

1694

},

1695

],

Bu Sun Kim

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

[diff] [blame]

1696

"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.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

1697

"keepaliveInterval": 42, # The interval in seconds between BGP keepalive messages that are sent to the peer.

1698

# Not currently available publicly.

1699

# 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.

1700

# 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.

1701

# If set, this value must be between 1 and 120. The default is 20.

Bu Sun Kim

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

[diff] [blame]

1702

},

1703

"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.

1704

{

1705

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

1706

"advertisedGroups": [ # User-specified list of prefix groups to advertise in custom mode, which can take one of the following options:

1707

# - ALL_SUBNETS: Advertises all available subnets, including peer VPC subnets.

1708

# - ALL_VPC_SUBNETS: Advertises the router's own VPC subnets.

1709

# - ALL_PEER_VPC_SUBNETS: Advertises peer subnets of the router's VPC network. 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.

1710

"A String",

1711

],

1712

"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]

1713

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

Bu Sun Kim

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

[diff] [blame]

1714

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

1715

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

Sai Cheemalapati

2017-06-06 18:46:08 -0400

[diff] [blame]

1716

},

1717

],

Bu Sun Kim

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

[diff] [blame]

1718

"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.

1719

"bfd": { # BFD configuration for the BGP peering.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

1720

# Not currently available publicly.

1721

"minReceiveInterval": 42, # The minimum interval, in milliseconds, between BFD control packets received from the peer router. The actual value is negotiated between the two routers and is equal to the greater of this value and the transmit interval of the other router.

1722

# Not currently available publicly.

1723

# If set, this value must be between 100 and 30000.

1724

# The default is 300.

1725

"minTransmitInterval": 42, # The minimum interval, in milliseconds, between BFD control packets transmitted to the peer router. The actual value is negotiated between the two routers and is equal to the greater of this value and the corresponding receive interval of the other router.

1726

# Not currently available publicly.

1727

# If set, this value must be between 100 and 30000.

1728

# The default is 300.

Bu Sun Kim

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

[diff] [blame]

1729

"mode": "A String", # The BFD session initialization mode for this BGP peer. If set to ACTIVE, the Cloud Router will initiate the BFD session for this BGP peer. If set to PASSIVE, the Cloud Router will wait for the peer router to initiate the BFD session for this BGP peer. If set to DISABLED, BFD is disabled for this BGP peer. The default is PASSIVE.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

1730

"multiplier": 42, # The number of consecutive BFD packets that must be missed before BFD declares that a peer is unavailable.

1731

# Not currently available publicly.

1732

# If set, the value must be a value between 2 and 16.

1733

# The default is 3.

Bu Sun Kim

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

[diff] [blame]

1734

"packetMode": "A String", # The BFD packet mode for this BGP peer. If set to CONTROL_AND_ECHO, BFD echo mode is enabled for this BGP peer. In this mode, if the peer router also has BFD echo mode enabled, BFD echo packets will be sent to the other router. If the peer router does not have BFD echo mode enabled, only control packets will be sent. If set to CONTROL_ONLY, BFD echo mode is disabled for this BGP peer. If this router and the peer router have a multihop connection, this should be set to CONTROL_ONLY as BFD echo mode is only supported on singlehop connections. The default is CONTROL_AND_ECHO.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

1735

"sessionInitializationMode": "A String", # The BFD session initialization mode for this BGP peer.

1736

# Not currently available publicly.

1737

# If set to ACTIVE, the Cloud Router will initiate the BFD session for this BGP peer. If set to PASSIVE, the Cloud Router will wait for the peer router to initiate the BFD session for this BGP peer. If set to DISABLED, BFD is disabled for this BGP peer. The default is PASSIVE.

Bu Sun Kim

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

[diff] [blame]

1738

"slowTimerInterval": 42, # The minimum interval, in milliseconds, between BFD control packets transmitted to and received from the peer router when BFD echo mode is enabled on both routers. The actual transmit and receive intervals are negotiated between the two routers and are equal to the greater of this value and the corresponding interval on the other router. If set, this value must be between 1000 and 30000. The default is 5000.

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

1739

},

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

1740

"enable": "A String", # The status of the BGP peer connection.

1741

# Not currently available publicly.

1742

# 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]

1743

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

1744

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

1745

"managementType": "A String", # [Output Only] The resource that configures and manages this BGP peer.

1746

# - MANAGED_BY_USER is the default value and can be managed by you or other users

1747

# - 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.

1748

"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.

1749

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

1750

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

1751

},

1752

],

1753

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

1754

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

1755

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

1756

"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.

1757

{

1758

"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.

1759

"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.

1760

"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.

1761

"managementType": "A String", # [Output Only] The resource that configures and manages this interface.

1762

# - MANAGED_BY_USER is the default value and can be managed directly by users.

1763

# - 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.

1764

"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.

1765

},

1766

],

1767

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

1768

"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.

1769

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

1770

{ # 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.

1771

"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.

1772

"A String",

1773

],

1774

"enableEndpointIndependentMapping": True or False,

1775

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

1776

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

1777

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

1778

"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:

1779

# - ERRORS_ONLY: Export logs only for connection failures.

1780

# - TRANSLATIONS_ONLY: Export logs only for successful connections.

1781

# - ALL: Export logs for all connections, successful and unsuccessful.

1782

},

1783

"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.

1784

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

1785

"natIpAllocateOption": "A String", # Specify the NatIpAllocateOption, which can take one of the following values:

1786

# - 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.

1787

# - 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.

1788

"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.

1789

"A String",

1790

],

1791

"rules": [ # A list of rules associated with this NAT.

1792

{

1793

"action": { # The action to be enforced for traffic that matches this rule.

1794

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

1795

"A String",

1796

],

1797

"sourceNatDrainIps": [ # 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 rule only.

"A String",

],

},

"description": "A String", # An optional description of this rule.

1802

"match": "A String", # CEL expression that specifies the match condition that egress traffic from a VM is evaluated against. If it evaluates to true, the corresponding ?action? is enforced.

1803

#

1804

# The following examples are valid match expressions:

1805

#

1806

# "inIpRange(destination.ip, '1.1.0.0/16') || inIpRange(destination.ip, '2.2.0.0/16')"

1807

#

1808

# "destination.ip == '1.1.0.1' || destination.ip == '8.8.8.8'"

Dmitry Frenkel

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

[diff] [blame]

1809

"ruleNumber": 42, # An integer uniquely identifying a rule in the list. The rule number must be a positive value between 0 and 65000, and must be unique among rules within a NAT.

Bu Sun Kim

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

[diff] [blame]

1810

},

1811

],

1812

"sourceSubnetworkIpRangesToNat": "A String", # Specify the Nat option, which can take one of the following values:

1813

# - ALL_SUBNETWORKS_ALL_IP_RANGES: All of the IP ranges in every Subnetwork are allowed to Nat.

1814

# - ALL_SUBNETWORKS_ALL_PRIMARY_IP_RANGES: All of the primary IP ranges in every Subnetwork are allowed to Nat.

1815

# - 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.

1816

"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.

1817

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

1818

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

1819

"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.

1820

"A String",

1821

],

1822

"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.

1828

"tcpTimeWaitTimeoutSec": 42, # Timeout (in seconds) for TCP connections that are in TIME_WAIT state. Defaults to 120s if not set.

1829

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

1830

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

1831

},

1832

],

1833

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

1834

"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.

1835

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

1836

"selfLinkWithId": "A String", # [Output Only] Server-defined URL for this resource with the resource id.

1837

}

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

Returns:

An object of the form:

1842

1843

{

Bu Sun Kim

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

[diff] [blame]

1844

"resource": { # Represents a Cloud Router resource. # Preview of given router.

1845

#

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

1846

# For more information about Cloud Router, read the Cloud Router overview.

Bu Sun Kim

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

[diff] [blame]

1847

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

1848

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

1849

"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.

1850

"A String",

1851

],

1852

"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.

1853

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

1854

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

1855

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

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

1856

},

1857

],

Bu Sun Kim

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

[diff] [blame]

1858

"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.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

1859

"keepaliveInterval": 42, # The interval in seconds between BGP keepalive messages that are sent to the peer.

1860

# Not currently available publicly.

1861

# 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.

1862

# 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.

1863

# If set, this value must be between 1 and 120. The default is 20.

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

1864

},

Bu Sun Kim

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

[diff] [blame]

1865

"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.

1866

{

1867

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

1868

"advertisedGroups": [ # User-specified list of prefix groups to advertise in custom mode, which can take one of the following options:

1869

# - ALL_SUBNETS: Advertises all available subnets, including peer VPC subnets.

1870

# - ALL_VPC_SUBNETS: Advertises the router's own VPC subnets.

1871

# - ALL_PEER_VPC_SUBNETS: Advertises peer subnets of the router's VPC network. 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.

1872

"A String",

1873

],

1874

"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.

1875

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

1876

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

1877

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

1878

},

1879

],

1880

"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.

1881

"bfd": { # BFD configuration for the BGP peering.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

1882

# Not currently available publicly.

1883

"minReceiveInterval": 42, # The minimum interval, in milliseconds, between BFD control packets received from the peer router. The actual value is negotiated between the two routers and is equal to the greater of this value and the transmit interval of the other router.

1884

# Not currently available publicly.

1885

# If set, this value must be between 100 and 30000.

1886

# The default is 300.

1887

"minTransmitInterval": 42, # The minimum interval, in milliseconds, between BFD control packets transmitted to the peer router. The actual value is negotiated between the two routers and is equal to the greater of this value and the corresponding receive interval of the other router.

1888

# Not currently available publicly.

1889

# If set, this value must be between 100 and 30000.

1890

# The default is 300.

Bu Sun Kim

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

[diff] [blame]

1891

"mode": "A String", # The BFD session initialization mode for this BGP peer. If set to ACTIVE, the Cloud Router will initiate the BFD session for this BGP peer. If set to PASSIVE, the Cloud Router will wait for the peer router to initiate the BFD session for this BGP peer. If set to DISABLED, BFD is disabled for this BGP peer. The default is PASSIVE.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

1892

"multiplier": 42, # The number of consecutive BFD packets that must be missed before BFD declares that a peer is unavailable.

1893

# Not currently available publicly.

1894

# If set, the value must be a value between 2 and 16.

1895

# The default is 3.

Bu Sun Kim

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

[diff] [blame]

1896

"packetMode": "A String", # The BFD packet mode for this BGP peer. If set to CONTROL_AND_ECHO, BFD echo mode is enabled for this BGP peer. In this mode, if the peer router also has BFD echo mode enabled, BFD echo packets will be sent to the other router. If the peer router does not have BFD echo mode enabled, only control packets will be sent. If set to CONTROL_ONLY, BFD echo mode is disabled for this BGP peer. If this router and the peer router have a multihop connection, this should be set to CONTROL_ONLY as BFD echo mode is only supported on singlehop connections. The default is CONTROL_AND_ECHO.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

1897

"sessionInitializationMode": "A String", # The BFD session initialization mode for this BGP peer.

1898

# Not currently available publicly.

1899

# If set to ACTIVE, the Cloud Router will initiate the BFD session for this BGP peer. If set to PASSIVE, the Cloud Router will wait for the peer router to initiate the BFD session for this BGP peer. If set to DISABLED, BFD is disabled for this BGP peer. The default is PASSIVE.

Bu Sun Kim

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

[diff] [blame]

1900

"slowTimerInterval": 42, # The minimum interval, in milliseconds, between BFD control packets transmitted to and received from the peer router when BFD echo mode is enabled on both routers. The actual transmit and receive intervals are negotiated between the two routers and are equal to the greater of this value and the corresponding interval on the other router. If set, this value must be between 1000 and 30000. The default is 5000.

1901

},

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

1902

"enable": "A String", # The status of the BGP peer connection.

1903

# Not currently available publicly.

1904

# 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]

1905

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

1906

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

1907

"managementType": "A String", # [Output Only] The resource that configures and manages this BGP peer.

1908

# - MANAGED_BY_USER is the default value and can be managed by you or other users

1909

# - 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.

1910

"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.

1911

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

1912

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

1913

},

1914

],

1915

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

1916

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

1917

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

1918

"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.

1919

{

1920

"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.

1921

"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.

1922

"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.

1923

"managementType": "A String", # [Output Only] The resource that configures and manages this interface.

1924

# - MANAGED_BY_USER is the default value and can be managed directly by users.

1925

# - 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.

1926

"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.

1927

},

1928

],

1929

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

1930

"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.

1931

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

1932

{ # 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.

1933

"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.

1934

"A String",

1935

],

1936

"enableEndpointIndependentMapping": True or False,

1937

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

1938

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

1939

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

1940

"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:

1941

# - ERRORS_ONLY: Export logs only for connection failures.

1942

# - TRANSLATIONS_ONLY: Export logs only for successful connections.

1943

# - ALL: Export logs for all connections, successful and unsuccessful.

1944

},

1945

"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.

1946

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

1947

"natIpAllocateOption": "A String", # Specify the NatIpAllocateOption, which can take one of the following values:

1948

# - 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.

1949

# - 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.

1950

"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.

1951

"A String",

1952

],

1953

"rules": [ # A list of rules associated with this NAT.

1954

{

1955

"action": { # The action to be enforced for traffic that matches this rule.

1956

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

1957

"A String",

1958

],

1959

"sourceNatDrainIps": [ # 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 rule only.

"A String",

],

},

"description": "A String", # An optional description of this rule.

1964

"match": "A String", # CEL expression that specifies the match condition that egress traffic from a VM is evaluated against. If it evaluates to true, the corresponding ?action? is enforced.

1965

#

1966

# The following examples are valid match expressions:

1967

#

1968

# "inIpRange(destination.ip, '1.1.0.0/16') || inIpRange(destination.ip, '2.2.0.0/16')"

1969

#

1970

# "destination.ip == '1.1.0.1' || destination.ip == '8.8.8.8'"

Dmitry Frenkel

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

[diff] [blame]

1971

"ruleNumber": 42, # An integer uniquely identifying a rule in the list. The rule number must be a positive value between 0 and 65000, and must be unique among rules within a NAT.

Bu Sun Kim

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

[diff] [blame]

1972

},

1973

],

1974

"sourceSubnetworkIpRangesToNat": "A String", # Specify the Nat option, which can take one of the following values:

1975

# - ALL_SUBNETWORKS_ALL_IP_RANGES: All of the IP ranges in every Subnetwork are allowed to Nat.

1976

# - ALL_SUBNETWORKS_ALL_PRIMARY_IP_RANGES: All of the primary IP ranges in every Subnetwork are allowed to Nat.

1977

# - 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.

1978

"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.

1979

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

1980

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

1981

"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.

1982

"A String",

1983

],

1984

"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.

1990

"tcpTimeWaitTimeoutSec": 42, # Timeout (in seconds) for TCP connections that are in TIME_WAIT state. Defaults to 120s if not set.

1991

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

1992

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

1993

},

1994

],

1995

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

1996

"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.

1997

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

1998

"selfLinkWithId": "A String", # [Output Only] Server-defined URL for this resource with the resource id.

1999

},

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

}</pre>

</div>

Dan O'Meara

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

[diff] [blame]

2004

<code class="details" id="testIamPermissions">testIamPermissions(project, region, resource, body=None)</code>

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

2005

<pre>Returns permissions that a caller has on the specified resource.

2006

2007

Args:

2008

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

2009

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

Bu Sun Kim

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

[diff] [blame]

2010

resource: string, Name or id of the resource for this request. (required)

Dan O'Meara

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

[diff] [blame]

2011

body: object, The request body.

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

2012

The object takes the form of:

2013

2014

{

Bu Sun Kim

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

[diff] [blame]

2015

"permissions": [ # The set of permissions to check for the 'resource'. Permissions with wildcards (such as '*' or 'storage.*') are not allowed.

2016

"A String",

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

],

}

Returns:

An object of the form:

2023

2024

{

Bu Sun Kim

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

[diff] [blame]

2025

"permissions": [ # A subset of `TestPermissionsRequest.permissions` that the caller is allowed.

2026

"A String",

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

],

}</pre>

</div>

Dan O'Meara

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

[diff] [blame]

2032

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

2033

<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.

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

2034

2035

Args:

2036

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

2037

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

2038

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

Dan O'Meara

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

[diff] [blame]

2039

body: object, The request body.

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

2040

The object takes the form of:

2041

Bu Sun Kim

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

[diff] [blame]

2042

{ # Represents a Cloud Router resource.

Bu Sun Kim

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

[diff] [blame]

2043

#

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

2044

# For more information about Cloud Router, read the Cloud Router overview.

Bu Sun Kim

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

[diff] [blame]

2045

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

2046

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

2047

"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.

2048

"A String",

2049

],

2050

"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.

2051

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

2052

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

2053

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

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

2054

},

2055

],

Bu Sun Kim

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

[diff] [blame]

2056

"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.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

2057

"keepaliveInterval": 42, # The interval in seconds between BGP keepalive messages that are sent to the peer.

2058

# Not currently available publicly.

2059

# 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.

2060

# 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.

2061

# If set, this value must be between 1 and 120. The default is 20.

Bu Sun Kim

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

[diff] [blame]

2062

},

2063

"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.

2064

{

2065

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

2066

"advertisedGroups": [ # User-specified list of prefix groups to advertise in custom mode, which can take one of the following options:

2067

# - ALL_SUBNETS: Advertises all available subnets, including peer VPC subnets.

2068

# - ALL_VPC_SUBNETS: Advertises the router's own VPC subnets.

2069

# - ALL_PEER_VPC_SUBNETS: Advertises peer subnets of the router's VPC network. 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.

2070

"A String",

2071

],

2072

"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]

2073

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

Bu Sun Kim

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

[diff] [blame]

2074

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

2075

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

Sai Cheemalapati

2017-06-06 18:46:08 -0400

[diff] [blame]

2076

},

2077

],

Bu Sun Kim

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

[diff] [blame]

2078

"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.

2079

"bfd": { # BFD configuration for the BGP peering.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

2080

# Not currently available publicly.

2081

"minReceiveInterval": 42, # The minimum interval, in milliseconds, between BFD control packets received from the peer router. The actual value is negotiated between the two routers and is equal to the greater of this value and the transmit interval of the other router.

2082

# Not currently available publicly.

2083

# If set, this value must be between 100 and 30000.

2084

# The default is 300.

2085

"minTransmitInterval": 42, # The minimum interval, in milliseconds, between BFD control packets transmitted to the peer router. The actual value is negotiated between the two routers and is equal to the greater of this value and the corresponding receive interval of the other router.

2086

# Not currently available publicly.

2087

# If set, this value must be between 100 and 30000.

2088

# The default is 300.

Bu Sun Kim

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

[diff] [blame]

2089

"mode": "A String", # The BFD session initialization mode for this BGP peer. If set to ACTIVE, the Cloud Router will initiate the BFD session for this BGP peer. If set to PASSIVE, the Cloud Router will wait for the peer router to initiate the BFD session for this BGP peer. If set to DISABLED, BFD is disabled for this BGP peer. The default is PASSIVE.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

2090

"multiplier": 42, # The number of consecutive BFD packets that must be missed before BFD declares that a peer is unavailable.

2091

# Not currently available publicly.

2092

# If set, the value must be a value between 2 and 16.

2093

# The default is 3.

Bu Sun Kim

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

[diff] [blame]

2094

"packetMode": "A String", # The BFD packet mode for this BGP peer. If set to CONTROL_AND_ECHO, BFD echo mode is enabled for this BGP peer. In this mode, if the peer router also has BFD echo mode enabled, BFD echo packets will be sent to the other router. If the peer router does not have BFD echo mode enabled, only control packets will be sent. If set to CONTROL_ONLY, BFD echo mode is disabled for this BGP peer. If this router and the peer router have a multihop connection, this should be set to CONTROL_ONLY as BFD echo mode is only supported on singlehop connections. The default is CONTROL_AND_ECHO.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

2095

"sessionInitializationMode": "A String", # The BFD session initialization mode for this BGP peer.

2096

# Not currently available publicly.

2097

# If set to ACTIVE, the Cloud Router will initiate the BFD session for this BGP peer. If set to PASSIVE, the Cloud Router will wait for the peer router to initiate the BFD session for this BGP peer. If set to DISABLED, BFD is disabled for this BGP peer. The default is PASSIVE.

Bu Sun Kim

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

[diff] [blame]

2098

"slowTimerInterval": 42, # The minimum interval, in milliseconds, between BFD control packets transmitted to and received from the peer router when BFD echo mode is enabled on both routers. The actual transmit and receive intervals are negotiated between the two routers and are equal to the greater of this value and the corresponding interval on the other router. If set, this value must be between 1000 and 30000. The default is 5000.

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

2099

},

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

2100

"enable": "A String", # The status of the BGP peer connection.

2101

# Not currently available publicly.

2102

# 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]

2103

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

2104

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

2105

"managementType": "A String", # [Output Only] The resource that configures and manages this BGP peer.

2106

# - MANAGED_BY_USER is the default value and can be managed by you or other users

2107

# - 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.

2108

"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.

2109

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

2110

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

2111

},

2112

],

2113

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

2114

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

2115

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

2116

"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.

2117

{

2118

"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.

2119

"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.

2120

"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.

2121

"managementType": "A String", # [Output Only] The resource that configures and manages this interface.

2122

# - MANAGED_BY_USER is the default value and can be managed directly by users.

2123

# - 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.

2124

"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.

2125

},

2126

],

2127

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

2128

"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.

2129

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

2130

{ # 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.

2131

"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.

2132

"A String",

2133

],

2134

"enableEndpointIndependentMapping": True or False,

2135

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

2136

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

2137

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

2138

"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:

2139

# - ERRORS_ONLY: Export logs only for connection failures.

2140

# - TRANSLATIONS_ONLY: Export logs only for successful connections.

2141

# - ALL: Export logs for all connections, successful and unsuccessful.

2142

},

2143

"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.

2144

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

2145

"natIpAllocateOption": "A String", # Specify the NatIpAllocateOption, which can take one of the following values:

2146

# - 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.

2147

# - 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.

2148

"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.

2149

"A String",

2150

],

2151

"rules": [ # A list of rules associated with this NAT.

2152

{

2153

"action": { # The action to be enforced for traffic that matches this rule.

2154

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

2155

"A String",

2156

],

2157

"sourceNatDrainIps": [ # 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 rule only.

"A String",

],

},

"description": "A String", # An optional description of this rule.

2162

"match": "A String", # CEL expression that specifies the match condition that egress traffic from a VM is evaluated against. If it evaluates to true, the corresponding ?action? is enforced.

2163

#

2164

# The following examples are valid match expressions:

2165

#

2166

# "inIpRange(destination.ip, '1.1.0.0/16') || inIpRange(destination.ip, '2.2.0.0/16')"

2167

#

2168

# "destination.ip == '1.1.0.1' || destination.ip == '8.8.8.8'"

Dmitry Frenkel

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

[diff] [blame]

2169

"ruleNumber": 42, # An integer uniquely identifying a rule in the list. The rule number must be a positive value between 0 and 65000, and must be unique among rules within a NAT.

Bu Sun Kim

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

[diff] [blame]

2170

},

2171

],

2172

"sourceSubnetworkIpRangesToNat": "A String", # Specify the Nat option, which can take one of the following values:

2173

# - ALL_SUBNETWORKS_ALL_IP_RANGES: All of the IP ranges in every Subnetwork are allowed to Nat.

2174

# - ALL_SUBNETWORKS_ALL_PRIMARY_IP_RANGES: All of the primary IP ranges in every Subnetwork are allowed to Nat.

2175

# - 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.

2176

"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.

2177

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

2178

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

2179

"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.

2180

"A String",

2181

],

2182

"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.

2188

"tcpTimeWaitTimeoutSec": 42, # Timeout (in seconds) for TCP connections that are in TIME_WAIT state. Defaults to 120s if not set.

2189

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

2190

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

2191

},

2192

],

2193

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

2194

"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.

2195

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

2196

"selfLinkWithId": "A String", # [Output Only] Server-defined URL for this resource with the resource id.

2197

}

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

2198

Bu Sun Kim

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

[diff] [blame]

2199

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.

2200

2201

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.

2202

2203

The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

2204

2205

Returns:

2206

An object of the form:

2207

Bu Sun Kim

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

[diff] [blame]

2208

{ # Represents an Operation resource.

2209

#

Dan O'Meara

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

[diff] [blame]

2210

# Google Compute Engine has three Operation resources:

2211

#

2212

# * [Global](/compute/docs/reference/rest/{$api_version}/globalOperations) * [Regional](/compute/docs/reference/rest/{$api_version}/regionOperations) * [Zonal](/compute/docs/reference/rest/{$api_version}/zoneOperations)

2213

#

Bu Sun Kim

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

[diff] [blame]

2214

# You can use an operation resource to manage asynchronous API requests. For more information, read Handling API responses.

2215

#

2216

# Operations can be global, regional or zonal.

Dan O'Meara

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

[diff] [blame]

2217

# - For global operations, use the `globalOperations` resource.

2218

# - For regional operations, use the `regionOperations` resource.

2219

# - For zonal operations, use the `zonalOperations` resource.

Bu Sun Kim

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

[diff] [blame]

2220

#

Dan O'Meara

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

[diff] [blame]

2221

# For more information, read Global, Regional, and Zonal Resources. (== resource_for {$api_version}.globalOperations ==) (== resource_for {$api_version}.regionOperations ==) (== resource_for {$api_version}.zoneOperations ==)

Bu Sun Kim

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

[diff] [blame]

2222

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

2223

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

2224

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

2225

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

2226

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

2227

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

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

2228

{

Bu Sun Kim

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

[diff] [blame]

2229

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

2230

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

2231

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

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

2232

},

2233

],

2234

},

Bu Sun Kim