Invoke ADCUpdateCallhome - j81blog/J81.ADCToolkit GitHub Wiki

Invoke-ADCUpdateCallhome

SYNOPSIS

Update Utility configuration Object.

SYNTAX

Invoke-ADCUpdateCallhome [[-Mode] <String>] [[-Emailaddress] <String>] [[-Hbcustominterval] <Double>]
 [[-Proxymode] <String>] [[-Ipaddress] <String>] [[-Proxyauthservice] <String>] [[-Port] <Int32>] [-WhatIf]
 [-Confirm] [<CommonParameters>]

DESCRIPTION

Configuration for callhome resource.

EXAMPLES

EXAMPLE 1

Invoke-ADCUpdateCallhome

An example how to update callhome configuration Object(s).

PARAMETERS

-Mode

CallHome mode of operation. Possible values = Default, CSP

Type: String
Parameter Sets: (All)
Aliases:

Required: False
Position: 2
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-Emailaddress

Email address of the contact administrator.

Type: String
Parameter Sets: (All)
Aliases:

Required: False
Position: 3
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-Hbcustominterval

Interval (in days) between CallHome heartbeats.

Type: Double
Parameter Sets: (All)
Aliases:

Required: False
Position: 4
Default value: 0
Accept pipeline input: False
Accept wildcard characters: False

-Proxymode

Enables or disables the proxy mode. The proxy server can be set by either specifying the IP address of the server or the name of the service representing the proxy server. Possible values = YES, NO

Type: String
Parameter Sets: (All)
Aliases:

Required: False
Position: 5
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-Ipaddress

IP address of the proxy server.

Type: String
Parameter Sets: (All)
Aliases:

Required: False
Position: 6
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-Proxyauthservice

Name of the service that represents the proxy server.

Type: String
Parameter Sets: (All)
Aliases:

Required: False
Position: 7
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-Port

HTTP port on the Proxy server. This is a mandatory parameter for both IP address and service name based configuration.

  • in CLI is represented as 65535 in NITRO API
Type: Int32
Parameter Sets: (All)
Aliases:

Required: False
Position: 8
Default value: 0
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.

INPUTS

OUTPUTS

NOTES

File Name : Invoke-ADCUpdateCallhome Version : v2111.2521 Author : John Billekens Reference : https://developer-docs.citrix.com/projects/citrix-adc-nitro-api-reference/en/latest/configuration/utility/callhome/ Requires : PowerShell v5.1 and up ADC 13.x and up. ADC 12 and lower may work, not guaranteed.

RELATED LINKS

https://blog.j81.nl

⚠️ **GitHub.com Fallback** ⚠️