Set-vRATenantDirectory

NAME Set-vRATenantDirectory



SYNOPSIS

Update a vRA Tenant Directory





SYNTAX

Set-vRATenantDirectory -ID <String> [-Name <String>] [-Description <String>] [-Alias <String>] [-Type <String>]

-Domain <String> [-UserNameDN <String>] [-Password <SecureString>] [-URL <String>] [-GroupBaseSearchDN <String>]

[-UserBaseSearchDN <String>] [-Subdomains <String>] [-GroupBaseSearchDNs <String[]>] [-UserBaseSearchDNs

<String[]>] [-DomainAdminUsername <String>] [-DomainAdminPassword <SecureString>] [-Certificate <String>]

[-TrustAll] [-UseGlobalCatalog] [-WhatIf] [-Confirm] [<CommonParameters>]



Set-vRATenantDirectory -ID <String> -Domain <String> -JSON <String> [-WhatIf] [-Confirm] [<CommonParameters>]





DESCRIPTION

Update a vRA Tenant Directory





PARAMETERS

-ID <String>

Tenant ID



Required? true

Position? named

Default value

Accept pipeline input? false

Accept wildcard characters? false



-Name <String>

Tenant Directory Name



Required? false

Position? named

Default value

Accept pipeline input? false

Accept wildcard characters? false



-Description <String>

A description for the directory



Required? false

Position? named

Default value

Accept pipeline input? false

Accept wildcard characters? false



-Alias <String>

Tenant Directory Alias



Required? false

Position? named

Default value

Accept pipeline input? false

Accept wildcard characters? false



-Type <String>

Tenant Directory Type



Required? false

Position? named

Default value

Accept pipeline input? false

Accept wildcard characters? false



-Domain <String>

Tenant Directory Domain



Required? true

Position? named

Default value

Accept pipeline input? false

Accept wildcard characters? false



-UserNameDN <String>

DN of the Username to authenticate the Tenant Directory with



Required? false

Position? named

Default value

Accept pipeline input? false

Accept wildcard characters? false



-Password <SecureString>

Password of the Username to authenticate the Tenant Directory with



Required? false

Position? named

Default value

Accept pipeline input? false

Accept wildcard characters? false



-URL <String>

Tenant Directory URL, e.g. ldap://dc01.vrademo.local:389



Required? false

Position? named

Default value

Accept pipeline input? false

Accept wildcard characters? false



-GroupBaseSearchDN <String>

Tenant Directory GroupBaseSearchDN



Required? false

Position? named

Default value

Accept pipeline input? false

Accept wildcard characters? false



-UserBaseSearchDN <String>

Tenant Directory UserBaseSearchDN



Required? false

Position? named

Default value

Accept pipeline input? false

Accept wildcard characters? false



-Subdomains <String>

Tenant Directory Subdomains



Required? false

Position? named

Default value

Accept pipeline input? false

Accept wildcard characters? false



-GroupBaseSearchDNs <String[]>

Tenant Directory GroupBaseSearchDNs



Required? false

Position? named

Default value

Accept pipeline input? false

Accept wildcard characters? false



-UserBaseSearchDNs <String[]>

Tenant Directory UserBaseSearchDNs



Required? false

Position? named

Default value

Accept pipeline input? false

Accept wildcard characters? false



-DomainAdminUsername <String>

Tenant Directory DomainAdminUserName



Required? false

Position? named

Default value

Accept pipeline input? false

Accept wildcard characters? false



-DomainAdminPassword <SecureString>

Tenant Directory DomainAdminPassword



Required? false

Position? named

Default value

Accept pipeline input? false

Accept wildcard characters? false



-Certificate <String>

Tenant Directory Certificate



Required? false

Position? named

Default value

Accept pipeline input? false

Accept wildcard characters? false



-TrustAll [<SwitchParameter>]

Tenant Directory TrustAll



Required? false

Position? named

Default value False

Accept pipeline input? false

Accept wildcard characters? false



-UseGlobalCatalog [<SwitchParameter>]

Tenant Directory UseGlobalCatalog



Required? false

Position? named

Default value False

Accept pipeline input? false

Accept wildcard characters? false



-JSON <String>

Body text to send in JSON format



Required? true

Position? named

Default value

Accept pipeline input? true (ByValue)

Accept wildcard characters? false



-WhatIf [<SwitchParameter>]



Required? false

Position? named

Default value

Accept pipeline input? false

Accept wildcard characters? false



-Confirm [<SwitchParameter>]



Required? false

Position? named

Default value

Accept pipeline input? false

Accept wildcard characters? false



<CommonParameters>

This cmdlet supports the common parameters: Verbose, Debug,

ErrorAction, ErrorVariable, WarningAction, WarningVariable,

OutBuffer, PipelineVariable, and OutVariable. For more information, see

about_CommonParameters (https:/go.microsoft.com/fwlink/?LinkID=113216).



INPUTS

System.String

System.SecureString





OUTPUTS

System.Management.Automation.PSObject





-------------------------- EXAMPLE 1 --------------------------



PS C:\\>$SecurePassword = ConvertTo-SecureString ???????P@ssword??????? -AsPlainText -Force



Set-vRATenantDirectory -ID Tenant01 -Domain vrademo.local -GroupBaseSearchDNs

"OU=Groups,OU=Tenant01,OU=Tenants,DC=vrademo,DC=local" -userBaseSearchDNs

"OU=Users,OU=Tenant01,OU=Tenants,DC=vrademo,DC=local" -Password $SecurePassword -Confirm:$false









-------------------------- EXAMPLE 2 --------------------------



PS C:\\>$JSON = @"



{

"name" : "Tenant01",

"description" : "Tenant01",

"alias" : "",

"type" : "AD",

"userNameDn" : "CN=vrasvc,OU=Service Accounts,OU=HQ,DC=vrademo,DC=local",

"groupBaseSearchDn" : "OU=Groups,OU=Tenant01,OU=Tenants,DC=vrademo,DC=local",

"password" : "P@ssword!",

"url" : "ldap://dc01.vrademo.local:389",

"userBaseSearchDn" : "OU=Users,OU=Tenant01,OU=Tenants,DC=vrademo,DC=local",

"domain" : "vrademo.local",

"domainAdminUsername" : "",

"domainAdminPassword" : "",

"subdomains" : [ "" ],

"groupBaseSearchDns" : [ "OU=Groups,OU=Tenant01,OU=Tenants,DC=vrademo,DC=local" ],

"userBaseSearchDns" : [ "OU=Users,OU=Tenant01,OU=Tenants,DC=vrademo,DC=local" ],

"certificate" : "",

"trustAll" : true,

"useGlobalCatalog" : false

}

"@

$JSON | Set-vRATenantDirectory -ID Tenant01 -Domain vrademo.local











RELATED LINKS