Invoke-RASTenantBroker
SYNOPSIS
Joins/Unjoins a Tenant Broker.
SYNTAX
Invoke-RASTenantBroker -HashKey <string> -Join <SwitchParameter> [-PublicDomainAddresses <string>]
[-SiteId <uint>] [-TenantBroker <string>] [-TenantName <string>] [<CommonParameters>]Invoke-RASTenantBroker -Unjoin <SwitchParameter> [-SiteId <uint>] [<CommonParameters>]DESCRIPTION
Joins/Unjoins a Tenant Broker.
EXAMPLES
Example 1
Invoke-RASTenantBroker -Join -HashKey "9A76312E-2EB7-4386-8AAF-180BC1015055" -TenantBroker "TB1"Joins the Tenant Broker TB1 with the provided hash key.
Example 2
Joins the Tenant Broker TB1 (tb01) with the provided hash key.
Example 3
Unjoins the tenant broker.
PARAMETERS
-SiteId
Site ID from which to retrieve the Tenant Broker settings (optional).
-Join
Join Tenant Broker SwitchParameter.
-HashKey
This can be the Tenant Broker secret key located at Farm | Settings | Tenant Broker, or the Tenant invitation hash created at Farm | Tenants | Add.
-TenantBroker
The IP or DNS address of the Tenant Broker to join.
-TenantName
The Tenant name. Applicable only if Farms are allowed to register using a secret key.
-PublicDomainAddresses
The accessible name. Applicable only if Farms are allowed to register using a secret key.
-Unjoin
Unjoin Tenant Broker SwitchParameter.
CommonParameters
This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.
INPUTS
None
OUTPUTS
None
RELATED LINKS
Last updated