Page History
Name
Export-JS7Agent
SYNOPSIS
Exports the Agent configuration from JOC Cockpit
SYNTAX
Export-JS7Agent [-AgentId] <String[]> [[-ControllerId] <String>] [-FilePath] <String> [[-Format] <String>] [[-AuditComment] <String>] [[-AuditTimeSpent] <Int32>] [[-AuditTicketLink] <Uri>] [<CommonParameters>]
DESCRIPTION
This cmdlet exports the Agent configuration stored with JOC Cockpit to an archive file in .zip or .tar.gz format.
The following REST Web Service API resources are used:
* /agents/export
PARAMETERS
AgentId
-AgentId <String[]>
| Required? | true |
| Position? | 1 |
| Default value | |
| Accept pipeline input? | true (ByPropertyName) |
| Accept wildcard characters? | false |
ControllerId
-ControllerId <String>
Specifies the ID of the Controller to which objects should be deployed after external signing.
This parameter is required if the -ForSigning parameter is used.
| Required? | false |
| Position? | 2 |
| Default value | |
| Accept pipeline input? | true (ByPropertyName) |
| Accept wildcard characters? | false |
FilePath
-FilePath <String>
Specifies the path to the archive file that the exported inventory objects are written to.
| Required? | true |
| Position? | 3 |
| Default value | |
| Accept pipeline input? | true (ByPropertyName) |
| Accept wildcard characters? | false |
Format
-Format <String>
Specifies the type of the archive file that will be returned: ZIP, TAR_GZ.
| Required? | false |
| Position? | 4 |
| Default value | ZIP |
| Accept pipeline input? | true (ByPropertyName) |
| Accept wildcard characters? | false |
AuditComment
-AuditComment <String>
Specifies a free text that indicates the reason for the current intervention, e.g. "business requirement", "maintenance window" etc.
The Audit Comment is visible from the Audit Log view of the JOC Cockpit.
This parameter is not mandatory. However, the JOC Cockpit can be configured to require Audit Log comments for all interventions.
| Required? | false |
| Position? | 5 |
| Default value | |
| Accept pipeline input? | true (ByPropertyName) |
| Accept wildcard characters? | false |
AuditTimeSpent
-AuditTimeSpent <Int32>
Specifies the duration in minutes that the current intervention required.
This information is shown in the Audit Log view. It can be useful when integrated
with a ticket system that logs the time spent on interventions with JS7.
| Required? | false |
| Position? | 6 |
| Default value | 0 |
| Accept pipeline input? | true (ByPropertyName) |
| Accept wildcard characters? | false |
AuditTicketLink
-AuditTicketLink <Uri>
Specifies a URL to a ticket system that keeps track of any interventions performed for JS7.
This information is shown in the Audit Log view of JOC Cockpit.
It can be useful when integrated with a ticket system that logs interventions with JS7.
| Required? | false |
| Position? | 7 |
| Default value | |
| Accept pipeline input? | true (ByPropertyName) |
| Accept wildcard characters? | false |
RELATED LINKS
EXAMPLES
-------------------------- EXAMPLE 1 --------------------------
PS > Export-JS7Agent -ControllerId testsuite -AgentId agent_001,agent_002,agent_cluster_001 -FilePath ./export.zip
Exports the configuration of indicated Agents to the file specified
-------------------------- EXAMPLE 2 --------------------------
PS > Get-JS7Agent -ControllerId testsuite | Export-JS7Agent -FilePath ./export.zip
Exports to the file specified the configuration of all Agents registered wiith the given Controller
Overview
Content Tools