File: baremetalsolution_v2.projects.locations.networks.html

package info (click to toggle)
python-googleapi 2.180.0-1
  • links: PTS
  • area: main
  • in suites: forky, sid
  • size: 527,124 kB
  • sloc: python: 11,076; javascript: 249; sh: 114; makefile: 59
file content (524 lines) | stat: -rw-r--r-- 33,461 bytes parent folder | download | duplicates (2)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
<html><body>
<style>

body, h1, h2, h3, div, span, p, pre, a {
  margin: 0;
  padding: 0;
  border: 0;
  font-weight: inherit;
  font-style: inherit;
  font-size: 100%;
  font-family: inherit;
  vertical-align: baseline;
}

body {
  font-size: 13px;
  padding: 1em;
}

h1 {
  font-size: 26px;
  margin-bottom: 1em;
}

h2 {
  font-size: 24px;
  margin-bottom: 1em;
}

h3 {
  font-size: 20px;
  margin-bottom: 1em;
  margin-top: 1em;
}

pre, code {
  line-height: 1.5;
  font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace;
}

pre {
  margin-top: 0.5em;
}

h1, h2, h3, p {
  font-family: Arial, sans serif;
}

h1, h2, h3 {
  border-bottom: solid #CCC 1px;
}

.toc_element {
  margin-top: 0.5em;
}

.firstline {
  margin-left: 2 em;
}

.method  {
  margin-top: 1em;
  border: solid 1px #CCC;
  padding: 1em;
  background: #EEE;
}

.details {
  font-weight: bold;
  font-size: 14px;
}

</style>

<h1><a href="baremetalsolution_v2.html">Bare Metal Solution API</a> . <a href="baremetalsolution_v2.projects.html">projects</a> . <a href="baremetalsolution_v2.projects.locations.html">locations</a> . <a href="baremetalsolution_v2.projects.locations.networks.html">networks</a></h1>
<h2>Instance Methods</h2>
<p class="toc_element">
  <code><a href="#close">close()</a></code></p>
<p class="firstline">Close httplib2 connections.</p>
<p class="toc_element">
  <code><a href="#get">get(name, x__xgafv=None)</a></code></p>
<p class="firstline">Get details of a single network.</p>
<p class="toc_element">
  <code><a href="#list">list(parent, filter=None, pageSize=None, pageToken=None, x__xgafv=None)</a></code></p>
<p class="firstline">List network in a given project and location.</p>
<p class="toc_element">
  <code><a href="#listNetworkUsage">listNetworkUsage(location, x__xgafv=None)</a></code></p>
<p class="firstline">List all Networks (and used IPs for each Network) in the vendor account associated with the specified project.</p>
<p class="toc_element">
  <code><a href="#list_next">list_next()</a></code></p>
<p class="firstline">Retrieves the next page of results.</p>
<p class="toc_element">
  <code><a href="#patch">patch(name, body=None, updateMask=None, x__xgafv=None)</a></code></p>
<p class="firstline">Update details of a single network.</p>
<p class="toc_element">
  <code><a href="#rename">rename(name, body=None, x__xgafv=None)</a></code></p>
<p class="firstline">RenameNetwork sets a new name for a network. Use with caution, previous names become immediately invalidated.</p>
<h3>Method Details</h3>
<div class="method">
    <code class="details" id="close">close()</code>
  <pre>Close httplib2 connections.</pre>
</div>

<div class="method">
    <code class="details" id="get">get(name, x__xgafv=None)</code>
  <pre>Get details of a single network.

Args:
  name: string, Required. Name of the resource. (required)
  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # A Network.
  &quot;cidr&quot;: &quot;A String&quot;, # The cidr of the Network.
  &quot;gatewayIp&quot;: &quot;A String&quot;, # Output only. Gateway ip address.
  &quot;id&quot;: &quot;A String&quot;, # An identifier for the `Network`, generated by the backend.
  &quot;ipAddress&quot;: &quot;A String&quot;, # IP address configured.
  &quot;jumboFramesEnabled&quot;: True or False, # Whether network uses standard frames or jumbo ones.
  &quot;labels&quot;: { # Labels as key value pairs.
    &quot;a_key&quot;: &quot;A String&quot;,
  },
  &quot;macAddress&quot;: [ # List of physical interfaces.
    &quot;A String&quot;,
  ],
  &quot;mountPoints&quot;: [ # Input only. List of mount points to attach the network to.
    { # Mount point for a network.
      &quot;defaultGateway&quot;: True or False, # Network should be a default gateway.
      &quot;instance&quot;: &quot;A String&quot;, # Instance to attach network to.
      &quot;ipAddress&quot;: &quot;A String&quot;, # Ip address of the server.
      &quot;logicalInterface&quot;: &quot;A String&quot;, # Logical interface to detach from.
    },
  ],
  &quot;name&quot;: &quot;A String&quot;, # Output only. The resource name of this `Network`. Resource names are schemeless URIs that follow the conventions in https://cloud.google.com/apis/design/resource_names. Format: `projects/{project}/locations/{location}/networks/{network}`
  &quot;pod&quot;: &quot;A String&quot;, # Immutable. Pod name. Pod is an independent part of infrastructure. Network can only be connected to the assets (instances, nfsshares) allocated in the same pod.
  &quot;reservations&quot;: [ # List of IP address reservations in this network. When updating this field, an error will be generated if a reservation conflicts with an IP address already allocated to a physical server.
    { # A reservation of one or more addresses in a network.
      &quot;endAddress&quot;: &quot;A String&quot;, # The last address of this reservation block, inclusive. I.e., for cases when reservations are only single addresses, end_address and start_address will be the same. Must be specified as a single IPv4 address, e.g. 10.1.2.2.
      &quot;note&quot;: &quot;A String&quot;, # A note about this reservation, intended for human consumption.
      &quot;startAddress&quot;: &quot;A String&quot;, # The first address of this reservation block. Must be specified as a single IPv4 address, e.g. 10.1.2.2.
    },
  ],
  &quot;servicesCidr&quot;: &quot;A String&quot;, # IP range for reserved for services (e.g. NFS).
  &quot;state&quot;: &quot;A String&quot;, # The Network state.
  &quot;type&quot;: &quot;A String&quot;, # The type of this network.
  &quot;vlanId&quot;: &quot;A String&quot;, # The vlan id of the Network.
  &quot;vrf&quot;: { # A network VRF. # The Vrf for the Network. Use this only if a new Vrf needs to be created.
    &quot;name&quot;: &quot;A String&quot;, # The name of the VRF.
    &quot;qosPolicy&quot;: { # QOS policy parameters. # The QOS policy applied to this VRF. The value is only meaningful when all the vlan attachments have the same QoS. This field should not be used for new integrations, use vlan attachment level qos instead. The field is left for backward-compatibility.
      &quot;bandwidthGbps&quot;: 3.14, # The bandwidth permitted by the QOS policy, in gbps.
    },
    &quot;state&quot;: &quot;A String&quot;, # The possible state of VRF.
    &quot;vlanAttachments&quot;: [ # The list of VLAN attachments for the VRF.
      { # VLAN attachment details.
        &quot;id&quot;: &quot;A String&quot;, # Immutable. The identifier of the attachment within vrf.
        &quot;interconnectAttachment&quot;: &quot;A String&quot;, # Optional. The name of the vlan attachment within vrf. This is of the form projects/{project_number}/regions/{region}/interconnectAttachments/{interconnect_attachment}
        &quot;pairingKey&quot;: &quot;A String&quot;, # Input only. Pairing key.
        &quot;peerIp&quot;: &quot;A String&quot;, # The peer IP of the attachment.
        &quot;peerVlanId&quot;: &quot;A String&quot;, # The peer vlan ID of the attachment.
        &quot;qosPolicy&quot;: { # QOS policy parameters. # The QOS policy applied to this VLAN attachment. This value should be preferred to using qos at vrf level.
          &quot;bandwidthGbps&quot;: 3.14, # The bandwidth permitted by the QOS policy, in gbps.
        },
        &quot;routerIp&quot;: &quot;A String&quot;, # The router IP of the attachment.
      },
    ],
  },
  &quot;vrfAttachment&quot;: &quot;A String&quot;, # Optional. The name of a pre-existing Vrf that the network should be attached to. Format is `vrfs/{vrf}`.
}</pre>
</div>

<div class="method">
    <code class="details" id="list">list(parent, filter=None, pageSize=None, pageToken=None, x__xgafv=None)</code>
  <pre>List network in a given project and location.

Args:
  parent: string, Required. Parent value for ListNetworksRequest. (required)
  filter: string, List filter.
  pageSize: integer, Requested page size. The server might return fewer items than requested. If unspecified, server will pick an appropriate default.
  pageToken: string, A token identifying a page of results from the server.
  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # Response message containing the list of networks.
  &quot;networks&quot;: [ # The list of networks.
    { # A Network.
      &quot;cidr&quot;: &quot;A String&quot;, # The cidr of the Network.
      &quot;gatewayIp&quot;: &quot;A String&quot;, # Output only. Gateway ip address.
      &quot;id&quot;: &quot;A String&quot;, # An identifier for the `Network`, generated by the backend.
      &quot;ipAddress&quot;: &quot;A String&quot;, # IP address configured.
      &quot;jumboFramesEnabled&quot;: True or False, # Whether network uses standard frames or jumbo ones.
      &quot;labels&quot;: { # Labels as key value pairs.
        &quot;a_key&quot;: &quot;A String&quot;,
      },
      &quot;macAddress&quot;: [ # List of physical interfaces.
        &quot;A String&quot;,
      ],
      &quot;mountPoints&quot;: [ # Input only. List of mount points to attach the network to.
        { # Mount point for a network.
          &quot;defaultGateway&quot;: True or False, # Network should be a default gateway.
          &quot;instance&quot;: &quot;A String&quot;, # Instance to attach network to.
          &quot;ipAddress&quot;: &quot;A String&quot;, # Ip address of the server.
          &quot;logicalInterface&quot;: &quot;A String&quot;, # Logical interface to detach from.
        },
      ],
      &quot;name&quot;: &quot;A String&quot;, # Output only. The resource name of this `Network`. Resource names are schemeless URIs that follow the conventions in https://cloud.google.com/apis/design/resource_names. Format: `projects/{project}/locations/{location}/networks/{network}`
      &quot;pod&quot;: &quot;A String&quot;, # Immutable. Pod name. Pod is an independent part of infrastructure. Network can only be connected to the assets (instances, nfsshares) allocated in the same pod.
      &quot;reservations&quot;: [ # List of IP address reservations in this network. When updating this field, an error will be generated if a reservation conflicts with an IP address already allocated to a physical server.
        { # A reservation of one or more addresses in a network.
          &quot;endAddress&quot;: &quot;A String&quot;, # The last address of this reservation block, inclusive. I.e., for cases when reservations are only single addresses, end_address and start_address will be the same. Must be specified as a single IPv4 address, e.g. 10.1.2.2.
          &quot;note&quot;: &quot;A String&quot;, # A note about this reservation, intended for human consumption.
          &quot;startAddress&quot;: &quot;A String&quot;, # The first address of this reservation block. Must be specified as a single IPv4 address, e.g. 10.1.2.2.
        },
      ],
      &quot;servicesCidr&quot;: &quot;A String&quot;, # IP range for reserved for services (e.g. NFS).
      &quot;state&quot;: &quot;A String&quot;, # The Network state.
      &quot;type&quot;: &quot;A String&quot;, # The type of this network.
      &quot;vlanId&quot;: &quot;A String&quot;, # The vlan id of the Network.
      &quot;vrf&quot;: { # A network VRF. # The Vrf for the Network. Use this only if a new Vrf needs to be created.
        &quot;name&quot;: &quot;A String&quot;, # The name of the VRF.
        &quot;qosPolicy&quot;: { # QOS policy parameters. # The QOS policy applied to this VRF. The value is only meaningful when all the vlan attachments have the same QoS. This field should not be used for new integrations, use vlan attachment level qos instead. The field is left for backward-compatibility.
          &quot;bandwidthGbps&quot;: 3.14, # The bandwidth permitted by the QOS policy, in gbps.
        },
        &quot;state&quot;: &quot;A String&quot;, # The possible state of VRF.
        &quot;vlanAttachments&quot;: [ # The list of VLAN attachments for the VRF.
          { # VLAN attachment details.
            &quot;id&quot;: &quot;A String&quot;, # Immutable. The identifier of the attachment within vrf.
            &quot;interconnectAttachment&quot;: &quot;A String&quot;, # Optional. The name of the vlan attachment within vrf. This is of the form projects/{project_number}/regions/{region}/interconnectAttachments/{interconnect_attachment}
            &quot;pairingKey&quot;: &quot;A String&quot;, # Input only. Pairing key.
            &quot;peerIp&quot;: &quot;A String&quot;, # The peer IP of the attachment.
            &quot;peerVlanId&quot;: &quot;A String&quot;, # The peer vlan ID of the attachment.
            &quot;qosPolicy&quot;: { # QOS policy parameters. # The QOS policy applied to this VLAN attachment. This value should be preferred to using qos at vrf level.
              &quot;bandwidthGbps&quot;: 3.14, # The bandwidth permitted by the QOS policy, in gbps.
            },
            &quot;routerIp&quot;: &quot;A String&quot;, # The router IP of the attachment.
          },
        ],
      },
      &quot;vrfAttachment&quot;: &quot;A String&quot;, # Optional. The name of a pre-existing Vrf that the network should be attached to. Format is `vrfs/{vrf}`.
    },
  ],
  &quot;nextPageToken&quot;: &quot;A String&quot;, # A token identifying a page of results from the server.
  &quot;unreachable&quot;: [ # Locations that could not be reached.
    &quot;A String&quot;,
  ],
}</pre>
</div>

<div class="method">
    <code class="details" id="listNetworkUsage">listNetworkUsage(location, x__xgafv=None)</code>
  <pre>List all Networks (and used IPs for each Network) in the vendor account associated with the specified project.

Args:
  location: string, Required. Parent value (project and location). (required)
  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # Response with Networks with IPs
  &quot;networks&quot;: [ # Networks with IPs.
    { # Network with all used IP addresses.
      &quot;network&quot;: { # A Network. # Network.
        &quot;cidr&quot;: &quot;A String&quot;, # The cidr of the Network.
        &quot;gatewayIp&quot;: &quot;A String&quot;, # Output only. Gateway ip address.
        &quot;id&quot;: &quot;A String&quot;, # An identifier for the `Network`, generated by the backend.
        &quot;ipAddress&quot;: &quot;A String&quot;, # IP address configured.
        &quot;jumboFramesEnabled&quot;: True or False, # Whether network uses standard frames or jumbo ones.
        &quot;labels&quot;: { # Labels as key value pairs.
          &quot;a_key&quot;: &quot;A String&quot;,
        },
        &quot;macAddress&quot;: [ # List of physical interfaces.
          &quot;A String&quot;,
        ],
        &quot;mountPoints&quot;: [ # Input only. List of mount points to attach the network to.
          { # Mount point for a network.
            &quot;defaultGateway&quot;: True or False, # Network should be a default gateway.
            &quot;instance&quot;: &quot;A String&quot;, # Instance to attach network to.
            &quot;ipAddress&quot;: &quot;A String&quot;, # Ip address of the server.
            &quot;logicalInterface&quot;: &quot;A String&quot;, # Logical interface to detach from.
          },
        ],
        &quot;name&quot;: &quot;A String&quot;, # Output only. The resource name of this `Network`. Resource names are schemeless URIs that follow the conventions in https://cloud.google.com/apis/design/resource_names. Format: `projects/{project}/locations/{location}/networks/{network}`
        &quot;pod&quot;: &quot;A String&quot;, # Immutable. Pod name. Pod is an independent part of infrastructure. Network can only be connected to the assets (instances, nfsshares) allocated in the same pod.
        &quot;reservations&quot;: [ # List of IP address reservations in this network. When updating this field, an error will be generated if a reservation conflicts with an IP address already allocated to a physical server.
          { # A reservation of one or more addresses in a network.
            &quot;endAddress&quot;: &quot;A String&quot;, # The last address of this reservation block, inclusive. I.e., for cases when reservations are only single addresses, end_address and start_address will be the same. Must be specified as a single IPv4 address, e.g. 10.1.2.2.
            &quot;note&quot;: &quot;A String&quot;, # A note about this reservation, intended for human consumption.
            &quot;startAddress&quot;: &quot;A String&quot;, # The first address of this reservation block. Must be specified as a single IPv4 address, e.g. 10.1.2.2.
          },
        ],
        &quot;servicesCidr&quot;: &quot;A String&quot;, # IP range for reserved for services (e.g. NFS).
        &quot;state&quot;: &quot;A String&quot;, # The Network state.
        &quot;type&quot;: &quot;A String&quot;, # The type of this network.
        &quot;vlanId&quot;: &quot;A String&quot;, # The vlan id of the Network.
        &quot;vrf&quot;: { # A network VRF. # The Vrf for the Network. Use this only if a new Vrf needs to be created.
          &quot;name&quot;: &quot;A String&quot;, # The name of the VRF.
          &quot;qosPolicy&quot;: { # QOS policy parameters. # The QOS policy applied to this VRF. The value is only meaningful when all the vlan attachments have the same QoS. This field should not be used for new integrations, use vlan attachment level qos instead. The field is left for backward-compatibility.
            &quot;bandwidthGbps&quot;: 3.14, # The bandwidth permitted by the QOS policy, in gbps.
          },
          &quot;state&quot;: &quot;A String&quot;, # The possible state of VRF.
          &quot;vlanAttachments&quot;: [ # The list of VLAN attachments for the VRF.
            { # VLAN attachment details.
              &quot;id&quot;: &quot;A String&quot;, # Immutable. The identifier of the attachment within vrf.
              &quot;interconnectAttachment&quot;: &quot;A String&quot;, # Optional. The name of the vlan attachment within vrf. This is of the form projects/{project_number}/regions/{region}/interconnectAttachments/{interconnect_attachment}
              &quot;pairingKey&quot;: &quot;A String&quot;, # Input only. Pairing key.
              &quot;peerIp&quot;: &quot;A String&quot;, # The peer IP of the attachment.
              &quot;peerVlanId&quot;: &quot;A String&quot;, # The peer vlan ID of the attachment.
              &quot;qosPolicy&quot;: { # QOS policy parameters. # The QOS policy applied to this VLAN attachment. This value should be preferred to using qos at vrf level.
                &quot;bandwidthGbps&quot;: 3.14, # The bandwidth permitted by the QOS policy, in gbps.
              },
              &quot;routerIp&quot;: &quot;A String&quot;, # The router IP of the attachment.
            },
          ],
        },
        &quot;vrfAttachment&quot;: &quot;A String&quot;, # Optional. The name of a pre-existing Vrf that the network should be attached to. Format is `vrfs/{vrf}`.
      },
      &quot;usedIps&quot;: [ # All used IP addresses in this network.
        &quot;A String&quot;,
      ],
    },
  ],
}</pre>
</div>

<div class="method">
    <code class="details" id="list_next">list_next()</code>
  <pre>Retrieves the next page of results.

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

        Returns:
          A request object that you can call &#x27;execute()&#x27; on to request the next
          page. Returns None if there are no more items in the collection.
        </pre>
</div>

<div class="method">
    <code class="details" id="patch">patch(name, body=None, updateMask=None, x__xgafv=None)</code>
  <pre>Update details of a single network.

Args:
  name: string, Output only. The resource name of this `Network`. Resource names are schemeless URIs that follow the conventions in https://cloud.google.com/apis/design/resource_names. Format: `projects/{project}/locations/{location}/networks/{network}` (required)
  body: object, The request body.
    The object takes the form of:

{ # A Network.
  &quot;cidr&quot;: &quot;A String&quot;, # The cidr of the Network.
  &quot;gatewayIp&quot;: &quot;A String&quot;, # Output only. Gateway ip address.
  &quot;id&quot;: &quot;A String&quot;, # An identifier for the `Network`, generated by the backend.
  &quot;ipAddress&quot;: &quot;A String&quot;, # IP address configured.
  &quot;jumboFramesEnabled&quot;: True or False, # Whether network uses standard frames or jumbo ones.
  &quot;labels&quot;: { # Labels as key value pairs.
    &quot;a_key&quot;: &quot;A String&quot;,
  },
  &quot;macAddress&quot;: [ # List of physical interfaces.
    &quot;A String&quot;,
  ],
  &quot;mountPoints&quot;: [ # Input only. List of mount points to attach the network to.
    { # Mount point for a network.
      &quot;defaultGateway&quot;: True or False, # Network should be a default gateway.
      &quot;instance&quot;: &quot;A String&quot;, # Instance to attach network to.
      &quot;ipAddress&quot;: &quot;A String&quot;, # Ip address of the server.
      &quot;logicalInterface&quot;: &quot;A String&quot;, # Logical interface to detach from.
    },
  ],
  &quot;name&quot;: &quot;A String&quot;, # Output only. The resource name of this `Network`. Resource names are schemeless URIs that follow the conventions in https://cloud.google.com/apis/design/resource_names. Format: `projects/{project}/locations/{location}/networks/{network}`
  &quot;pod&quot;: &quot;A String&quot;, # Immutable. Pod name. Pod is an independent part of infrastructure. Network can only be connected to the assets (instances, nfsshares) allocated in the same pod.
  &quot;reservations&quot;: [ # List of IP address reservations in this network. When updating this field, an error will be generated if a reservation conflicts with an IP address already allocated to a physical server.
    { # A reservation of one or more addresses in a network.
      &quot;endAddress&quot;: &quot;A String&quot;, # The last address of this reservation block, inclusive. I.e., for cases when reservations are only single addresses, end_address and start_address will be the same. Must be specified as a single IPv4 address, e.g. 10.1.2.2.
      &quot;note&quot;: &quot;A String&quot;, # A note about this reservation, intended for human consumption.
      &quot;startAddress&quot;: &quot;A String&quot;, # The first address of this reservation block. Must be specified as a single IPv4 address, e.g. 10.1.2.2.
    },
  ],
  &quot;servicesCidr&quot;: &quot;A String&quot;, # IP range for reserved for services (e.g. NFS).
  &quot;state&quot;: &quot;A String&quot;, # The Network state.
  &quot;type&quot;: &quot;A String&quot;, # The type of this network.
  &quot;vlanId&quot;: &quot;A String&quot;, # The vlan id of the Network.
  &quot;vrf&quot;: { # A network VRF. # The Vrf for the Network. Use this only if a new Vrf needs to be created.
    &quot;name&quot;: &quot;A String&quot;, # The name of the VRF.
    &quot;qosPolicy&quot;: { # QOS policy parameters. # The QOS policy applied to this VRF. The value is only meaningful when all the vlan attachments have the same QoS. This field should not be used for new integrations, use vlan attachment level qos instead. The field is left for backward-compatibility.
      &quot;bandwidthGbps&quot;: 3.14, # The bandwidth permitted by the QOS policy, in gbps.
    },
    &quot;state&quot;: &quot;A String&quot;, # The possible state of VRF.
    &quot;vlanAttachments&quot;: [ # The list of VLAN attachments for the VRF.
      { # VLAN attachment details.
        &quot;id&quot;: &quot;A String&quot;, # Immutable. The identifier of the attachment within vrf.
        &quot;interconnectAttachment&quot;: &quot;A String&quot;, # Optional. The name of the vlan attachment within vrf. This is of the form projects/{project_number}/regions/{region}/interconnectAttachments/{interconnect_attachment}
        &quot;pairingKey&quot;: &quot;A String&quot;, # Input only. Pairing key.
        &quot;peerIp&quot;: &quot;A String&quot;, # The peer IP of the attachment.
        &quot;peerVlanId&quot;: &quot;A String&quot;, # The peer vlan ID of the attachment.
        &quot;qosPolicy&quot;: { # QOS policy parameters. # The QOS policy applied to this VLAN attachment. This value should be preferred to using qos at vrf level.
          &quot;bandwidthGbps&quot;: 3.14, # The bandwidth permitted by the QOS policy, in gbps.
        },
        &quot;routerIp&quot;: &quot;A String&quot;, # The router IP of the attachment.
      },
    ],
  },
  &quot;vrfAttachment&quot;: &quot;A String&quot;, # Optional. The name of a pre-existing Vrf that the network should be attached to. Format is `vrfs/{vrf}`.
}

  updateMask: string, The list of fields to update. The only currently supported fields are: `labels`, `reservations`, `vrf.vlan_attachments`
  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # This resource represents a long-running operation that is the result of a network API call.
  &quot;done&quot;: True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.
  &quot;error&quot;: { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.
    &quot;code&quot;: 42, # The status code, which should be an enum value of google.rpc.Code.
    &quot;details&quot;: [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
      {
        &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
      },
    ],
    &quot;message&quot;: &quot;A String&quot;, # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
  },
  &quot;metadata&quot;: { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
    &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
  },
  &quot;name&quot;: &quot;A String&quot;, # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.
  &quot;response&quot;: { # The normal, successful response of the operation. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
    &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
  },
}</pre>
</div>

<div class="method">
    <code class="details" id="rename">rename(name, body=None, x__xgafv=None)</code>
  <pre>RenameNetwork sets a new name for a network. Use with caution, previous names become immediately invalidated.

Args:
  name: string, Required. The `name` field is used to identify the network. Format: projects/{project}/locations/{location}/networks/{network} (required)
  body: object, The request body.
    The object takes the form of:

{ # Message requesting rename of a server.
  &quot;newNetworkId&quot;: &quot;A String&quot;, # Required. The new `id` of the network.
}

  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # A Network.
  &quot;cidr&quot;: &quot;A String&quot;, # The cidr of the Network.
  &quot;gatewayIp&quot;: &quot;A String&quot;, # Output only. Gateway ip address.
  &quot;id&quot;: &quot;A String&quot;, # An identifier for the `Network`, generated by the backend.
  &quot;ipAddress&quot;: &quot;A String&quot;, # IP address configured.
  &quot;jumboFramesEnabled&quot;: True or False, # Whether network uses standard frames or jumbo ones.
  &quot;labels&quot;: { # Labels as key value pairs.
    &quot;a_key&quot;: &quot;A String&quot;,
  },
  &quot;macAddress&quot;: [ # List of physical interfaces.
    &quot;A String&quot;,
  ],
  &quot;mountPoints&quot;: [ # Input only. List of mount points to attach the network to.
    { # Mount point for a network.
      &quot;defaultGateway&quot;: True or False, # Network should be a default gateway.
      &quot;instance&quot;: &quot;A String&quot;, # Instance to attach network to.
      &quot;ipAddress&quot;: &quot;A String&quot;, # Ip address of the server.
      &quot;logicalInterface&quot;: &quot;A String&quot;, # Logical interface to detach from.
    },
  ],
  &quot;name&quot;: &quot;A String&quot;, # Output only. The resource name of this `Network`. Resource names are schemeless URIs that follow the conventions in https://cloud.google.com/apis/design/resource_names. Format: `projects/{project}/locations/{location}/networks/{network}`
  &quot;pod&quot;: &quot;A String&quot;, # Immutable. Pod name. Pod is an independent part of infrastructure. Network can only be connected to the assets (instances, nfsshares) allocated in the same pod.
  &quot;reservations&quot;: [ # List of IP address reservations in this network. When updating this field, an error will be generated if a reservation conflicts with an IP address already allocated to a physical server.
    { # A reservation of one or more addresses in a network.
      &quot;endAddress&quot;: &quot;A String&quot;, # The last address of this reservation block, inclusive. I.e., for cases when reservations are only single addresses, end_address and start_address will be the same. Must be specified as a single IPv4 address, e.g. 10.1.2.2.
      &quot;note&quot;: &quot;A String&quot;, # A note about this reservation, intended for human consumption.
      &quot;startAddress&quot;: &quot;A String&quot;, # The first address of this reservation block. Must be specified as a single IPv4 address, e.g. 10.1.2.2.
    },
  ],
  &quot;servicesCidr&quot;: &quot;A String&quot;, # IP range for reserved for services (e.g. NFS).
  &quot;state&quot;: &quot;A String&quot;, # The Network state.
  &quot;type&quot;: &quot;A String&quot;, # The type of this network.
  &quot;vlanId&quot;: &quot;A String&quot;, # The vlan id of the Network.
  &quot;vrf&quot;: { # A network VRF. # The Vrf for the Network. Use this only if a new Vrf needs to be created.
    &quot;name&quot;: &quot;A String&quot;, # The name of the VRF.
    &quot;qosPolicy&quot;: { # QOS policy parameters. # The QOS policy applied to this VRF. The value is only meaningful when all the vlan attachments have the same QoS. This field should not be used for new integrations, use vlan attachment level qos instead. The field is left for backward-compatibility.
      &quot;bandwidthGbps&quot;: 3.14, # The bandwidth permitted by the QOS policy, in gbps.
    },
    &quot;state&quot;: &quot;A String&quot;, # The possible state of VRF.
    &quot;vlanAttachments&quot;: [ # The list of VLAN attachments for the VRF.
      { # VLAN attachment details.
        &quot;id&quot;: &quot;A String&quot;, # Immutable. The identifier of the attachment within vrf.
        &quot;interconnectAttachment&quot;: &quot;A String&quot;, # Optional. The name of the vlan attachment within vrf. This is of the form projects/{project_number}/regions/{region}/interconnectAttachments/{interconnect_attachment}
        &quot;pairingKey&quot;: &quot;A String&quot;, # Input only. Pairing key.
        &quot;peerIp&quot;: &quot;A String&quot;, # The peer IP of the attachment.
        &quot;peerVlanId&quot;: &quot;A String&quot;, # The peer vlan ID of the attachment.
        &quot;qosPolicy&quot;: { # QOS policy parameters. # The QOS policy applied to this VLAN attachment. This value should be preferred to using qos at vrf level.
          &quot;bandwidthGbps&quot;: 3.14, # The bandwidth permitted by the QOS policy, in gbps.
        },
        &quot;routerIp&quot;: &quot;A String&quot;, # The router IP of the attachment.
      },
    ],
  },
  &quot;vrfAttachment&quot;: &quot;A String&quot;, # Optional. The name of a pre-existing Vrf that the network should be attached to. Format is `vrfs/{vrf}`.
}</pre>
</div>

</body></html>