< Back
Reload-LBService
Post
NAME Reload-LBService
SYNOPSIS
Connects to a loadbalancer.org REST API to reload appliance services
SYNTAX
Reload-LBService [-APIKey] <String> [-ConnectionURI] <String> [-Service] <String> [[-Credential] <PSCredential>]
[<CommonParameters>]
DESCRIPTION
Connects to a loadbalancer.org REST API to reload appliance services, must provide service name in lower-case
Valid services are: haproxy, ldirectord, pound, stunnel, heartbeat, waf, collectd, firewall
PARAMETERS
-APIKey <String>
API Key
Required? true
Position? 1
Default value
Accept pipeline input? true (ByPropertyName)
Accept wildcard characters? false
-ConnectionURI <String>
Connection URI e.g. https://10.0.0.10:9443/api/
Required? true
Position? 2
Default value
Accept pipeline input? true (ByPropertyName)
Accept wildcard characters? false
-Service <String>
Service Name
Required? true
Position? 3
Default value
Accept pipeline input? true (ByPropertyName)
Accept wildcard characters? false
-Credential <PSCredential>
PSCredential object containing the API username and password, prompts if omitted
Required? false
Position? 6
Default value (Get-Credential)
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
OUTPUTS
System.Int32
-------------------------- EXAMPLE 1 --------------------------
PS C:\\>reload-LBService -APIKey 'abc123' -ConnectionURI 'https://lbmaster.local:9443/api/' -Credential
(get-credential loadbalancer) -Service haproxy
-------------------------- EXAMPLE 2 --------------------------
PS C:\\>$ApiKey = 'abc123'
$uri = 'https://lbmaster.domain.local:9443/api/'
$cred = New-Object System.Management.Automation.PSCredential -ArgumentList 'loadbalancer', (ConvertTo-SecureString
-AsPlainText 'loadbalancer' -Force)
reload-LBService -APIKey $APIKey -ConnectionURI $uri -Credential $cred -Service haproxy
RELATED LINKS
SYNOPSIS
Connects to a loadbalancer.org REST API to reload appliance services
SYNTAX
Reload-LBService [-APIKey] <String> [-ConnectionURI] <String> [-Service] <String> [[-Credential] <PSCredential>]
[<CommonParameters>]
DESCRIPTION
Connects to a loadbalancer.org REST API to reload appliance services, must provide service name in lower-case
Valid services are: haproxy, ldirectord, pound, stunnel, heartbeat, waf, collectd, firewall
PARAMETERS
-APIKey <String>
API Key
Required? true
Position? 1
Default value
Accept pipeline input? true (ByPropertyName)
Accept wildcard characters? false
-ConnectionURI <String>
Connection URI e.g. https://10.0.0.10:9443/api/
Required? true
Position? 2
Default value
Accept pipeline input? true (ByPropertyName)
Accept wildcard characters? false
-Service <String>
Service Name
Required? true
Position? 3
Default value
Accept pipeline input? true (ByPropertyName)
Accept wildcard characters? false
-Credential <PSCredential>
PSCredential object containing the API username and password, prompts if omitted
Required? false
Position? 6
Default value (Get-Credential)
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
OUTPUTS
System.Int32
-------------------------- EXAMPLE 1 --------------------------
PS C:\\>reload-LBService -APIKey 'abc123' -ConnectionURI 'https://lbmaster.local:9443/api/' -Credential
(get-credential loadbalancer) -Service haproxy
-------------------------- EXAMPLE 2 --------------------------
PS C:\\>$ApiKey = 'abc123'
$uri = 'https://lbmaster.domain.local:9443/api/'
$cred = New-Object System.Management.Automation.PSCredential -ArgumentList 'loadbalancer', (ConvertTo-SecureString
-AsPlainText 'loadbalancer' -Force)
reload-LBService -APIKey $APIKey -ConnectionURI $uri -Credential $cred -Service haproxy
RELATED LINKS