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
|
<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="netapp_v1.html">NetApp API</a> . <a href="netapp_v1.projects.html">projects</a> . <a href="netapp_v1.projects.locations.html">locations</a> . <a href="netapp_v1.projects.locations.activeDirectories.html">activeDirectories</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="#create">create(parent, activeDirectoryId=None, body=None, x__xgafv=None)</a></code></p>
<p class="firstline">CreateActiveDirectory Creates the active directory specified in the request.</p>
<p class="toc_element">
<code><a href="#delete">delete(name, x__xgafv=None)</a></code></p>
<p class="firstline">Delete the active directory specified in the request.</p>
<p class="toc_element">
<code><a href="#get">get(name, x__xgafv=None)</a></code></p>
<p class="firstline">Describes a specified active directory.</p>
<p class="toc_element">
<code><a href="#list">list(parent, filter=None, orderBy=None, pageSize=None, pageToken=None, x__xgafv=None)</a></code></p>
<p class="firstline">Lists active directories.</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 the parameters of an active directories.</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="create">create(parent, activeDirectoryId=None, body=None, x__xgafv=None)</code>
<pre>CreateActiveDirectory Creates the active directory specified in the request.
Args:
parent: string, Required. Value for parent. (required)
body: object, The request body.
The object takes the form of:
{ # ActiveDirectory is the public representation of the active directory config.
"administrators": [ # Optional. Users to be added to the Built-in Admininstrators group.
"A String",
],
"aesEncryption": True or False, # If enabled, AES encryption will be enabled for SMB communication.
"backupOperators": [ # Optional. Users to be added to the Built-in Backup Operator active directory group.
"A String",
],
"createTime": "A String", # Output only. Create time of the active directory.
"description": "A String", # Description of the active directory.
"dns": "A String", # Required. Comma separated list of DNS server IP addresses for the Active Directory domain.
"domain": "A String", # Required. Name of the Active Directory domain
"encryptDcConnections": True or False, # If enabled, traffic between the SMB server to Domain Controller (DC) will be encrypted.
"kdcHostname": "A String", # Name of the active directory machine. This optional parameter is used only while creating kerberos volume
"kdcIp": "A String", # KDC server IP address for the active directory machine.
"labels": { # Labels for the active directory.
"a_key": "A String",
},
"ldapSigning": True or False, # Specifies whether or not the LDAP traffic needs to be signed.
"name": "A String", # Identifier. The resource name of the active directory. Format: `projects/{project_number}/locations/{location_id}/activeDirectories/{active_directory_id}`.
"netBiosPrefix": "A String", # Required. NetBIOSPrefix is used as a prefix for SMB server name.
"nfsUsersWithLdap": True or False, # If enabled, will allow access to local users and LDAP users. If access is needed for only LDAP users, it has to be disabled.
"organizationalUnit": "A String", # The Organizational Unit (OU) within the Windows Active Directory the user belongs to.
"password": "A String", # Required. Password of the Active Directory domain administrator.
"securityOperators": [ # Optional. Domain users to be given the SeSecurityPrivilege.
"A String",
],
"site": "A String", # The Active Directory site the service will limit Domain Controller discovery too.
"state": "A String", # Output only. The state of the AD.
"stateDetails": "A String", # Output only. The state details of the Active Directory.
"username": "A String", # Required. Username of the Active Directory domain administrator.
}
activeDirectoryId: string, Required. ID of the active directory to create. Must be unique within the parent resource. Must contain only letters, numbers and hyphen, with the first character a letter , the last a letter or a number, and a 63 character maximum.
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.
"done": 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.
"error": { # 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.
"code": 42, # The status code, which should be an enum value of google.rpc.Code.
"details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
{
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
],
"message": "A String", # 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.
},
"metadata": { # 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.
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
"name": "A String", # 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}`.
"response": { # 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`.
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
}</pre>
</div>
<div class="method">
<code class="details" id="delete">delete(name, x__xgafv=None)</code>
<pre>Delete the active directory specified in the request.
Args:
name: string, Required. Name of the active directory. (required)
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.
"done": 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.
"error": { # 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.
"code": 42, # The status code, which should be an enum value of google.rpc.Code.
"details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
{
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
],
"message": "A String", # 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.
},
"metadata": { # 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.
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
"name": "A String", # 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}`.
"response": { # 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`.
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
}</pre>
</div>
<div class="method">
<code class="details" id="get">get(name, x__xgafv=None)</code>
<pre>Describes a specified active directory.
Args:
name: string, Required. Name of the active directory. (required)
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # ActiveDirectory is the public representation of the active directory config.
"administrators": [ # Optional. Users to be added to the Built-in Admininstrators group.
"A String",
],
"aesEncryption": True or False, # If enabled, AES encryption will be enabled for SMB communication.
"backupOperators": [ # Optional. Users to be added to the Built-in Backup Operator active directory group.
"A String",
],
"createTime": "A String", # Output only. Create time of the active directory.
"description": "A String", # Description of the active directory.
"dns": "A String", # Required. Comma separated list of DNS server IP addresses for the Active Directory domain.
"domain": "A String", # Required. Name of the Active Directory domain
"encryptDcConnections": True or False, # If enabled, traffic between the SMB server to Domain Controller (DC) will be encrypted.
"kdcHostname": "A String", # Name of the active directory machine. This optional parameter is used only while creating kerberos volume
"kdcIp": "A String", # KDC server IP address for the active directory machine.
"labels": { # Labels for the active directory.
"a_key": "A String",
},
"ldapSigning": True or False, # Specifies whether or not the LDAP traffic needs to be signed.
"name": "A String", # Identifier. The resource name of the active directory. Format: `projects/{project_number}/locations/{location_id}/activeDirectories/{active_directory_id}`.
"netBiosPrefix": "A String", # Required. NetBIOSPrefix is used as a prefix for SMB server name.
"nfsUsersWithLdap": True or False, # If enabled, will allow access to local users and LDAP users. If access is needed for only LDAP users, it has to be disabled.
"organizationalUnit": "A String", # The Organizational Unit (OU) within the Windows Active Directory the user belongs to.
"password": "A String", # Required. Password of the Active Directory domain administrator.
"securityOperators": [ # Optional. Domain users to be given the SeSecurityPrivilege.
"A String",
],
"site": "A String", # The Active Directory site the service will limit Domain Controller discovery too.
"state": "A String", # Output only. The state of the AD.
"stateDetails": "A String", # Output only. The state details of the Active Directory.
"username": "A String", # Required. Username of the Active Directory domain administrator.
}</pre>
</div>
<div class="method">
<code class="details" id="list">list(parent, filter=None, orderBy=None, pageSize=None, pageToken=None, x__xgafv=None)</code>
<pre>Lists active directories.
Args:
parent: string, Required. Parent value for ListActiveDirectoriesRequest (required)
filter: string, Filtering results
orderBy: string, Hint for how to order the results
pageSize: integer, Requested page size. Server may return fewer items than requested. If unspecified, the server will pick an appropriate default.
pageToken: string, A token identifying a page of results the server should return.
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # ListActiveDirectoriesResponse contains all the active directories requested.
"activeDirectories": [ # The list of active directories.
{ # ActiveDirectory is the public representation of the active directory config.
"administrators": [ # Optional. Users to be added to the Built-in Admininstrators group.
"A String",
],
"aesEncryption": True or False, # If enabled, AES encryption will be enabled for SMB communication.
"backupOperators": [ # Optional. Users to be added to the Built-in Backup Operator active directory group.
"A String",
],
"createTime": "A String", # Output only. Create time of the active directory.
"description": "A String", # Description of the active directory.
"dns": "A String", # Required. Comma separated list of DNS server IP addresses for the Active Directory domain.
"domain": "A String", # Required. Name of the Active Directory domain
"encryptDcConnections": True or False, # If enabled, traffic between the SMB server to Domain Controller (DC) will be encrypted.
"kdcHostname": "A String", # Name of the active directory machine. This optional parameter is used only while creating kerberos volume
"kdcIp": "A String", # KDC server IP address for the active directory machine.
"labels": { # Labels for the active directory.
"a_key": "A String",
},
"ldapSigning": True or False, # Specifies whether or not the LDAP traffic needs to be signed.
"name": "A String", # Identifier. The resource name of the active directory. Format: `projects/{project_number}/locations/{location_id}/activeDirectories/{active_directory_id}`.
"netBiosPrefix": "A String", # Required. NetBIOSPrefix is used as a prefix for SMB server name.
"nfsUsersWithLdap": True or False, # If enabled, will allow access to local users and LDAP users. If access is needed for only LDAP users, it has to be disabled.
"organizationalUnit": "A String", # The Organizational Unit (OU) within the Windows Active Directory the user belongs to.
"password": "A String", # Required. Password of the Active Directory domain administrator.
"securityOperators": [ # Optional. Domain users to be given the SeSecurityPrivilege.
"A String",
],
"site": "A String", # The Active Directory site the service will limit Domain Controller discovery too.
"state": "A String", # Output only. The state of the AD.
"stateDetails": "A String", # Output only. The state details of the Active Directory.
"username": "A String", # Required. Username of the Active Directory domain administrator.
},
],
"nextPageToken": "A String", # A token identifying a page of results the server should return.
"unreachable": [ # Locations that could not be reached.
"A String",
],
}</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 'execute()' 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 the parameters of an active directories.
Args:
name: string, Identifier. The resource name of the active directory. Format: `projects/{project_number}/locations/{location_id}/activeDirectories/{active_directory_id}`. (required)
body: object, The request body.
The object takes the form of:
{ # ActiveDirectory is the public representation of the active directory config.
"administrators": [ # Optional. Users to be added to the Built-in Admininstrators group.
"A String",
],
"aesEncryption": True or False, # If enabled, AES encryption will be enabled for SMB communication.
"backupOperators": [ # Optional. Users to be added to the Built-in Backup Operator active directory group.
"A String",
],
"createTime": "A String", # Output only. Create time of the active directory.
"description": "A String", # Description of the active directory.
"dns": "A String", # Required. Comma separated list of DNS server IP addresses for the Active Directory domain.
"domain": "A String", # Required. Name of the Active Directory domain
"encryptDcConnections": True or False, # If enabled, traffic between the SMB server to Domain Controller (DC) will be encrypted.
"kdcHostname": "A String", # Name of the active directory machine. This optional parameter is used only while creating kerberos volume
"kdcIp": "A String", # KDC server IP address for the active directory machine.
"labels": { # Labels for the active directory.
"a_key": "A String",
},
"ldapSigning": True or False, # Specifies whether or not the LDAP traffic needs to be signed.
"name": "A String", # Identifier. The resource name of the active directory. Format: `projects/{project_number}/locations/{location_id}/activeDirectories/{active_directory_id}`.
"netBiosPrefix": "A String", # Required. NetBIOSPrefix is used as a prefix for SMB server name.
"nfsUsersWithLdap": True or False, # If enabled, will allow access to local users and LDAP users. If access is needed for only LDAP users, it has to be disabled.
"organizationalUnit": "A String", # The Organizational Unit (OU) within the Windows Active Directory the user belongs to.
"password": "A String", # Required. Password of the Active Directory domain administrator.
"securityOperators": [ # Optional. Domain users to be given the SeSecurityPrivilege.
"A String",
],
"site": "A String", # The Active Directory site the service will limit Domain Controller discovery too.
"state": "A String", # Output only. The state of the AD.
"stateDetails": "A String", # Output only. The state details of the Active Directory.
"username": "A String", # Required. Username of the Active Directory domain administrator.
}
updateMask: string, Required. Field mask is used to specify the fields to be overwritten in the Active Directory resource by the update. The fields specified in the update_mask are relative to the resource, not the full request. A field will be overwritten if it is in the mask. If the user does not provide a mask then all fields will be overwritten.
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.
"done": 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.
"error": { # 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.
"code": 42, # The status code, which should be an enum value of google.rpc.Code.
"details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
{
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
],
"message": "A String", # 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.
},
"metadata": { # 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.
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
"name": "A String", # 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}`.
"response": { # 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`.
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
}</pre>
</div>
</body></html>
|
