Set-B1DTCPool¶
SYNOPSIS¶
Updates a pool object within BloxOne DTC
SYNTAX¶
Default (Default)¶
Set-B1DTCPool -Name <String> [-NewName <String>] [-Description <String>] [-LoadBalancingType <String>]
[-Servers <Object>] [-HealthChecks <Object>] [-PoolHealthyWhen <String>] [-PoolHealthyCount <Int32>]
[-ServersHealthyWhen <String>] [-ServersHealthyCount <Int32>] [-TTL <Int32>] [-State <String>]
[-Tags <Object>] [-Force] [-WhatIf] [-Confirm] [<CommonParameters>]
With ID¶
Set-B1DTCPool [-NewName <String>] [-Description <String>] [-LoadBalancingType <String>] [-Servers <Object>]
[-HealthChecks <Object>] [-PoolHealthyWhen <String>] [-PoolHealthyCount <Int32>]
[-ServersHealthyWhen <String>] [-ServersHealthyCount <Int32>] [-TTL <Int32>] [-State <String>]
[-Tags <Object>] -Object <Object> [-Force] [-WhatIf] [-Confirm] [<CommonParameters>]
DESCRIPTION¶
This function is used to update a pool object within BloxOne DTC
EXAMPLES¶
EXAMPLE 1¶
Set-B1DTCPool -Name 'Exchange Pool' -TTL 60
id : dtc/pool/0gt45t5t-g5g5-h5hg-5h5f-8vd89dr39f
name : Exchange Pool
comment :
tags :
disabled : False
method : ratio
servers : {@{server_id=dtc/server/23404tg-gt54-g4vg-c442-cw4vw3v4f; name=MAIL-PRIMARY; weight=10}, @{server_id=dtc/server/8vdsrnv8-vnnu-777g-gdvd-sdrghjj3b2; name=MAIL-BACKUP; weight=20}}
ttl : 60
inheritance_sources :
pool_availability : quorum
pool_servers_quorum : 1
server_availability : any
server_health_checks_quorum : 0
health_checks : {@{health_check_id=dtc/health_check_icmp/vdsg4g4-vdg4-4g43-b3d8-c55xseve5b; name=ICMP health check}, @{health_check_id=dtc/health_check_icmp/fset4g4fg-h6hg-878f-ssw3-cdfu894d32; name=Exchange HTTPS Check}}
metadata
EXAMPLE 2¶
Get-B1DTCPool -Name 'Exchange Pool' | Set-B1DTCPool -PoolHealthyWhen AtLeast -ServersHealthyWhen Any -ServersHealthyCount 0 -PoolHealthyCount 1 -LoadBalancingType Ratio -Servers MAIL-PRIMARY:10,MAIL-BACKUP:20
id : dtc/pool/0gt45t5t-g5g5-h5hg-5h5f-8vd89dr39f
name : Exchange Pool
comment :
tags :
disabled : False
method : ratio
servers : {@{server_id=dtc/server/23404tg-gt54-g4vg-c442-cw4vw3v4f; name=MAIL-PRIMARY; weight=10}, @{server_id=dtc/server/8vdsrnv8-vnnu-777g-gdvd-sdrghjj3b2; name=MAIL-BACKUP; weight=20}}
ttl : 0
inheritance_sources :
pool_availability : quorum
pool_servers_quorum : 1
server_availability : any
server_health_checks_quorum : 0
health_checks : {@{health_check_id=dtc/health_check_icmp/vdsg4g4-vdg4-4g43-b3d8-c55xseve5b; name=ICMP health check}, @{health_check_id=dtc/health_check_icmp/fset4g4fg-h6hg-878f-ssw3-cdfu894d32; name=Exchange HTTPS Check}}
metadata :
PARAMETERS¶
-Name¶
The name of the DTC pool object to update
Type: String
Parameter Sets: Default
Aliases:
Required: True
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-NewName¶
Use -NewName to update the name of the DTC Pool object
Type: String
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-Description¶
The new description for the DTC pool
Type: String
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-LoadBalancingType¶
The new Load Balancing Type to use (Round Robin / Ratio / Global Availability)
If Ratio is selected, the -Servers parameter must include both the Server Name and Weight separated by a colon. ( -Servers "SERVER-PRIMARY:1","SERVER-BACKUP:2" )
Type: String
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-Servers¶
The list of DTC Servers to assign to the pool. This supports tab-completion to list available DTC servers.
Type: Object
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-HealthChecks¶
The list of DTC Health Checks to assign to the pool. This supports tab-completion to list available DTC Health Checks.
Type: Object
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-PoolHealthyWhen¶
Report the Pool Health Status as Healthy when (Any/All/AtLeast) Servers are healthy
If At Least is selected, this must be used in conjunction with -PoolHealthyCount to set the number of required healthy servers
Type: String
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-PoolHealthyCount¶
The number of DTC Servers within the pool that are required for the pool to be reported as healthy. This is used in conjunction with: -PoolHealthyWhen AtLeast
Type: Int32
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: 0
Accept pipeline input: False
Accept wildcard characters: False
-ServersHealthyWhen¶
Report the Server Health Status as Healthy when (Any/All/At Least) Health Checks are healthy
If At Least is selected, this must be used in conjunction with -ServerHealthyCount to set the number of required health checks
Type: String
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-ServersHealthyCount¶
The number of DTC Health Checks assigned to the server that are required for the server to be reported as healthy. This is used in conjunction with: -ServerHealthyWhen AtLeast
Type: Int32
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: 0
Accept pipeline input: False
Accept wildcard characters: False
-TTL¶
The TTL to use for the DTC pool. This will override inheritance.
Type: Int32
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: 0
Accept pipeline input: False
Accept wildcard characters: False
-State¶
Whether or not the new pool is created as enabled or disabled. Defaults to enabled
Type: String
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-Tags¶
Any tags you want to apply to the DTC Pool
Type: Object
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-Object¶
The DTC Pool Object(s) to update. Accepts pipeline input.
Type: Object
Parameter Sets: With ID
Aliases:
Required: True
Position: Named
Default value: None
Accept pipeline input: True (ByValue)
Accept wildcard characters: False
-Force¶
Perform the operation without prompting for confirmation. By default, this function will not prompt for confirmation unless $ConfirmPreference is set to Medium.
Type: SwitchParameter
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: False
Accept pipeline input: False
Accept wildcard characters: False
-WhatIf¶
Shows what would happen if the cmdlet runs. The cmdlet is not run.
Type: SwitchParameter
Parameter Sets: (All)
Aliases: wi
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-Confirm¶
Prompts you for confirmation before running the cmdlet.
Type: SwitchParameter
Parameter Sets: (All)
Aliases: cf
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
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.