Set-HB-Instance

NAME Set-HB-Instance



SYNOPSIS

Allows you to define the Hornbill instance





SYNTAX

Set-HB-Instance [-Instance] <String> [[-Zone] <String>] [-Key] <String> [<CommonParameters>]





DESCRIPTION

MANDATORY - Allows your Powershell script to define the Hornbill instance to connect

to, the zone in which it resides, and the API key to use for session generation.





PARAMETERS

-Instance <String>

The (case-sensitive) instance name that you wish to connect to.



Required? true

Position? 1

Default value

Accept pipeline input? false

Accept wildcard characters? false



-Zone <String>

The (case-sensitive) zone in which the Hornbill instance resides.

If not supplied, script will work out endpoint from zoneinfo



Required? false

Position? 2

Default value

Accept pipeline input? false

Accept wildcard characters? false



-Key <String>

The API key to use to generate authenticate against the Hornbill instance with.



Required? true

Position? 3

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



OUTPUTS



-------------------------- EXAMPLE 1 --------------------------



PS C:\\>Set-HB-Instance "yourinstancename" "eur" "yourapikeygoeshere"















RELATED LINKS