Name
New-JS7Subagent
SYNOPSIS
Returns an array with a Subagent object
SYNTAX
New-JS7Subagent [-SubagentId] <String> [-Url] <Uri> [[-Title] <String>] [[-DirectorType] <String>] [[-Ordering] <Int32>] [-GenerateSubagentCluster] [-WhatIf] [-Confirm] [<CommonParameters>]
DESCRIPTION
This cmdlet returns an array with a Subagent object.
Consider that the Subagent identification specified with the -SubagentId parameter cannot be modified
for the lifetime of a Subagent.
PARAMETERS
SubagentId
-SubagentId <String>
Specifies a unique identifier for the Subagent. The Subagent ID cannot be changed during the lifetime of a Subagent.
| Required? | true |
| Position? | 1 |
| Default value | |
| Accept pipeline input? | true (ByPropertyName) |
| Accept wildcard characters? | false |
Url
-Url <Uri>
Specifies the URL for which the Subagent is available. A URL includes the protocol (http, https), hostname and port
for which an Agent is operated.
| Required? | true |
| Position? | 2 |
| Default value | |
| Accept pipeline input? | true (ByPropertyName) |
| Accept wildcard characters? | false |
Title
-Title <String>
Optionally specifies a title for the Subagent that can later on be used for searching.
| Required? | false |
| Position? | 3 |
| Default value | |
| Accept pipeline input? | true (ByPropertyName) |
| Accept wildcard characters? | false |
DirectorType
-DirectorType <String>
Specifies if the Subagent acts as a Director Agent or Subagent only. The following values can be used:
* NO_DIRECTOR: the Agent acts as a Subagent only
* PRIMARY_DIRECTOR: the Agent acts as a Primary Director Agent and includes a Subagent
* SECONDARY_DIRECTOR: the Agent acts as a Secondary Director Agent and includes a Subagent
| Required? | false |
| Position? | 4 |
| Default value | NO_DIRECTOR |
| Accept pipeline input? | true (ByPropertyName) |
| Accept wildcard characters? | false |
Ordering
-Ordering <Int32>
Optionally specifies the sequence in which Subagents are returned and displayed by JOC Cockpit.
The ordering is specified in ascening numbers.
| Required? | false |
| Position? | 5 |
| Default value | 0 |
| Accept pipeline input? | true (ByPropertyName) |
| Accept wildcard characters? | false |
GenerateSubagentCluster
-GenerateSubagentCluster <SwitchParameter>
Optionally specifies if a Subagent Cluster should be created that holds the Subagent as its unique member.
This option is useful if the Subagent Cluster should be assigned directly to jobs that rely on being
executed with the Subagent only.
| Required? | false |
| Position? | named |
| Default value | False |
| Accept pipeline input? | true (ByPropertyName) |
| 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 > $subagents = @()
$subagents += New-JS7Subagent -SubagentId 'subagent_001' -Url https://subagent-2-0-primary:4443
$subagents += New-JS7Subagent -SubagentId 'subagent_0021' -Url https://subagent-2-0-secondary:4443
Returns an array of Subagent objects with the specified Subagent ID and URL.
Overview
Content Tools