Close httplib2 connections.
create(parent, activeDirectoryId=None, body=None, x__xgafv=None)
CreateActiveDirectory Creates the active directory specified in the request.
Delete the active directory specified in the request.
Describes a specified active directory.
list(parent, filter=None, orderBy=None, pageSize=None, pageToken=None, x__xgafv=None)
Lists active directories.
Retrieves the next page of results.
patch(name, body=None, updateMask=None, x__xgafv=None)
Update the parameters of an active directories.
close()
Close httplib2 connections.
create(parent, activeDirectoryId=None, body=None, x__xgafv=None)
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.
},
}
delete(name, x__xgafv=None)
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.
},
}
get(name, x__xgafv=None)
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.
}
list(parent, filter=None, orderBy=None, pageSize=None, pageToken=None, x__xgafv=None)
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",
],
}
list_next()
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.
patch(name, body=None, updateMask=None, x__xgafv=None)
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.
},
}