< Back
New-vRATenantDirectory
Post
NAME New-vRATenantDirectory
SYNOPSIS
Create a vRA Tenant Directory
SYNTAX
New-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>]
New-vRATenantDirectory -ID <String> -JSON <String> [-WhatIf] [-Confirm] [<CommonParameters>]
DESCRIPTION
Create 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? true
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
-Description <String>
Tenant Directory Description
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? true
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? true
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? true
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? true
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
-GroupBaseSearchDN <String>
Tenant Directory GroupBaseSearchDN
Required? true
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? true
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
New-vRATenantDirectory -ID Tenant01 -Name Tenant01 -Description "This is the Tenant01 Directory" -Type AD -Domain
"vrademo.local" -UserNameDN "CN=vrasvc,OU=Service Accounts,OU=HQ,DC=vrademo,DC=local" `
-Password $SecurePassword -URL "ldap://dc01.vrademo.local:389" -GroupBaseSearchDN
"OU=Tenant01,OU=Tenants,DC=vrademo,DC=local" -UserBaseSearchDN "OU=Tenant01,OU=Tenants,DC=vrademo,DC=local" `
-GroupBaseSearchDNs "OU=Tenant01,OU=Tenants,DC=vrademo,DC=local" -UserBaseSearchDNs
"OU=Tenant01,OU=Tenants,DC=vrademo,DC=local" -TrustAll
-------------------------- 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=Tenant01,OU=Tenants,DC=vrademo,DC=local",
"password" : "P@ssword!",
"url" : "ldap://dc01.vrademo.local:389",
"userBaseSearchDn" : "OU=Tenant01,OU=Tenants,DC=vrademo,DC=local",
"domain" : "vrademo.local",
"domainAdminUsername" : "",
"domainAdminPassword" : "",
"subdomains" : [ "" ],
"groupBaseSearchDns" : [ "OU=Tenant01,OU=Tenants,DC=vrademo,DC=local" ],
"userBaseSearchDns" : [ "OU=Tenant01,OU=Tenants,DC=vrademo,DC=local" ],
"certificate" : "",
"trustAll" : true,
"useGlobalCatalog" : false
}
"@
$JSON | New-vRATenantDirectory -ID Tenant01
RELATED LINKS
SYNOPSIS
Create a vRA Tenant Directory
SYNTAX
New-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>]
New-vRATenantDirectory -ID <String> -JSON <String> [-WhatIf] [-Confirm] [<CommonParameters>]
DESCRIPTION
Create 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? true
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
-Description <String>
Tenant Directory Description
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? true
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? true
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? true
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? true
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
-GroupBaseSearchDN <String>
Tenant Directory GroupBaseSearchDN
Required? true
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? true
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
New-vRATenantDirectory -ID Tenant01 -Name Tenant01 -Description "This is the Tenant01 Directory" -Type AD -Domain
"vrademo.local" -UserNameDN "CN=vrasvc,OU=Service Accounts,OU=HQ,DC=vrademo,DC=local" `
-Password $SecurePassword -URL "ldap://dc01.vrademo.local:389" -GroupBaseSearchDN
"OU=Tenant01,OU=Tenants,DC=vrademo,DC=local" -UserBaseSearchDN "OU=Tenant01,OU=Tenants,DC=vrademo,DC=local" `
-GroupBaseSearchDNs "OU=Tenant01,OU=Tenants,DC=vrademo,DC=local" -UserBaseSearchDNs
"OU=Tenant01,OU=Tenants,DC=vrademo,DC=local" -TrustAll
-------------------------- 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=Tenant01,OU=Tenants,DC=vrademo,DC=local",
"password" : "P@ssword!",
"url" : "ldap://dc01.vrademo.local:389",
"userBaseSearchDn" : "OU=Tenant01,OU=Tenants,DC=vrademo,DC=local",
"domain" : "vrademo.local",
"domainAdminUsername" : "",
"domainAdminPassword" : "",
"subdomains" : [ "" ],
"groupBaseSearchDns" : [ "OU=Tenant01,OU=Tenants,DC=vrademo,DC=local" ],
"userBaseSearchDns" : [ "OU=Tenant01,OU=Tenants,DC=vrademo,DC=local" ],
"certificate" : "",
"trustAll" : true,
"useGlobalCatalog" : false
}
"@
$JSON | New-vRATenantDirectory -ID Tenant01
RELATED LINKS