Versions Compared

Key

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

...

-Certificate <X509Certificate2>
This parameter can be used for client authentication if JOC Cockpit is configured for mutual authentication with HTTPS (SSL).
If JOC Cockpit is configured to accept single-factor authentication then the certificate specified with this parameter replaces
the password for login. If JOC Cockpit requires two-factor authentication then a certificate is required
in addition to specifying a password for login.
Consider
Note that this parameter expects a certificate with the data type [System.Security.Cryptography.X509Certificates.X509Certificate2].
This parameter can be used for Windows only. For other operating systems use the -KeyStorePath parameter.

Use of this parameter requires that the certificate object includes the private key and the certificate chain, i.e. the certificate
and any Intermediate or Root CA Certificates required for validation of the certificate.

This parameter cannot be used with the -CertificateThumbprint parameter or -KeyStorePath parameter.

...

-CertificateThumbprint <String>
This parameter can be used for client authentication if JOC Cockpit is configured for mutual authentication with HTTPS (SSL).
If JOC Cockpit is configured to accept single-factor authentication then the certificate identified with this parameter replaces
the password for login. If JOC Cockpit requires two-factor authentication then a certificate is required
in addition to specifying a password for login.

This parameter can be used for Windows only. For other operating sysems use the -KeyStorePath parameter.

Use of this parameter requires a certificate store to be in place that holds the private key and certificate chain, i.e. the same certificate
and any Intermediate or Root CA Certificates required for validation of the certificate. Consider Note that this parameter a reference
to a certificate entry in your Windows certificate store that includes the private key and certificate chain.

This parameter cannot be used with the -Certificate parameter or -KeyStorePath parameter.

...

-KeyStorePath <String>
This parameter can be used for client authentication if the JOC Cockpit is configured for mutual authentication with HTTPS (SSL).
If the JOC Cockpit is configured to accept single-factor authentication then the certificate from the keystore specified with this parameter replaces
the password for login. If the JOC Cockpit requires two-factor authentication then a certificate is required
in addition to specifying a password for login.

This parameter expects the path to a keystore file, preferably a PKCS12 keystore, that holds the private key and certificate chain, i.e. the certificate
and any Intermediate or Root CA Certificates required for validation of the certificate. Certificates of type X509 are supported.

The cmdlet adds the private key, certificate and any intermediate/root certificates from the keystore to the certificate store
used by the current account. This parameter can be used for Windows and Unix operating systems.

This parameter cannot be used with the -Certificate parameter or -CertificateThumbprint parameter.

...

-RootCertificatePath <String>
Specifies the location of a file that holds the root certificate that was used when signing the JOC Cockpit
SSL certificate.

* For Windows environments the Root CA Certificate by default is looked up in the Windows Certificate Store, however. However,
this parameter can be used to apply a Root CA Certificate from a location in the file system.
* For Linux environments a path is specified to the Root CA Certificate file, e.g. *.pem, *.crt file, or to a truststore, e.g. *.jks, *.p12 file.

...

Connects to the JS7 Web Service with a secure HTTPS connection at the indicated address and asks the user interactively for credentials. In order to verfy verify the JOC Cockpit server certificate the corresponding Root CA Certificate is specified that was used when signing the server certificate.

...

A variable $credentials is created that holds the credentials for the default root account of JOC Cockpit. When calling the cmdlet the URL is specified, the Controller ID that was used during installationn installation and the credentials object.

...

This example assumes a secure HTTPS connection to JOC Cockpit with mutual authentication: * The -RootCertificatePath is specified that holds the Root CA Certificate that which was used when signing the JOC Cockpit SSL server certificate. * The -KeyStorePath is specified that hold holds the private key and certificate for mutual authentication with JOC Cockpit. * A $trustStoreCredentials variable $trustStoreCredentials is created that holds the password for access to the the truststore with the Root CA Certificate. * A $keyStoreCredentials variable $keyStoreCredentials is created that holds the credentials for access to they keystore for mutual authentication.