Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

Name

Add-JS7SigningKey

SYNOPSIS

Adds a key pair for signing of deployable objects such as workflows to the current account

...

-KeyAlgorithm <String>
JS7 supports the following key algorithms: PGP, RSA and ECDSA.

Required?true
Position?1
Default value
Accept pipeline input?true (ByPropertyName)
Accept wildcard characters?false

PrivateKey

-PrivateKey <String>
A private key of the type specified with the -KeyAlgorithm parameter is specified.

The private key string is expected to include any newline characters required for the key type.

Required?false
Position?2
Default value
Accept pipeline input?true (ByPropertyName)
Accept wildcard characters?false

PublicKey

-PublicKey <String>
A public key can be specified only when using the PGP key type specified with the -KeyAlgorithm parameter.

The public key string is expected to include any newline characters required for the key type.

Required?false
Position?3
Default value
Accept pipeline input?true (ByPropertyName)
Accept wildcard characters?false

Certificate

-Certificate <String>
A certificate can be specified only when using the RSA, ECDSA key types specified with the -KeyAlgorithm parameter.

The certificate string is expected to include any newline characters required for the key type.

Required?false
Position?4
Default value
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, JOC Cockpit can be configured to enforce 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 value0
Accept pipeline input?true (ByPropertyName)
Accept wildcard characters?false

-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

about_JS7

EXAMPLES

...

For RSA and ECDSA key types the certificate and the private key are added if the JOC Cockpit is operated for security level at the LOW or MEDIUM security levels.

-------------------------- EXAMPLE 2 --------------------------

...

For PGP key types the public key and the private key are added if the JOC Cockpit is operated for security level at the LOW or MEDIUM security levels.

-------------------------- EXAMPLE 5 --------------------------

...

For PGP key types the public key is added if the JOC Cockpit is operated for at the HIGH security level HIGH.