Name
New-JS7ControllerInstance
SYNOPSIS
Creates a new JS7 Controller instance PowerShell object for use with other cmdlets.
SYNTAX
New-JS7ControllerInstance [-Url] <Uri> [[-ClusterUrl] <Uri>] [-Role] <String> [[-Title] <String>] [-WhatIf] [-Confirm] [<CommonParameters>]
DESCRIPTION
The cmdlets is used to create a PowerShell object for a new Controller instance
that is added with the Set-JS7Controller cmdlet.
PARAMETERS
Url
-Url <Uri>
Specifies the Url of the Controller instance that should be added. The Url is specified
for use by JOC Cockpit.
Required? | true |
Position? | 1 |
Default value | |
Accept pipeline input? | false |
Accept wildcard characters? | false |
ClusterUrl
-ClusterUrl <Uri>
Specifies the URL by which this Controller can be found from some other cluster member.
Typically this is the same as the -Url parameter. However, depending on network zones
and use of proxies the Controller ID might be accesssible from a different Url in the cluster.
If this parameter is not specified then the value of the -Url parameter is used for the cluster Url.
Required? | false |
Position? | 2 |
Default value | |
Accept pipeline input? | false |
Accept wildcard characters? | false |
Role
-Role <String>
Required? | true |
Position? | 3 |
Default value | |
Accept pipeline input? | true (ByPropertyName) |
Accept wildcard characters? | false |
Title
-Title <String>
Specifies a title for the Controller instance that becomes visible with the JOC Cockpit dashboard.
Required? | false |
Position? | 4 |
Default value | |
Accept pipeline input? | false |
Accept wildcard characters? | false |
WhatIf
-WhatIf <SwitchParameter>
Required? | false |
Position? | named |
Default value | |
Accept pipeline input? | false |
Accept wildcard characters? | false |
Confirm
-Confirm <SwitchParameter>
Required? | false |
Position? | named |
Default value | |
Accept pipeline input? | false |
Accept wildcard characters? | false |
RELATED LINKS
EXAMPLES
-------------------------- EXAMPLE 1 --------------------------
PS > $instance = New-JS7ControllerInstance -Url https://controller-primary.sos:4443 -Role primary -Title 'PRIMARY CONTROLLER'
Returns a PowerShell object for a new Controller instance.