SignerCertificateCommands

Use the Jython or Jacl scripting languages to configure security with wsadmin. The commands and parameters in the SignerCertificateCommands group can be used to create and modify signer certificates in relation to the key store file and to query for signer information on ports of remote hosts.

The SignerCertificateCommands includes the following commands:

• addSignerCertificate
• deleteSignerCertificate
• extractSignerCertificate
• getSignerCertificate
• listSignerCertificates
• retrieveSignerFromPort
• retrieveSignerInfoFromPort

 

addSignerCertificate

The addSignerCertificate command add a signer certificate from a certificate file to a keystore.

Target object

None.

Required parameters

-keyStoreName

Name that uniquely identifies the keystore configuration object. (String, required)

-certificateAlias

Name that uniquely identifies the certificate request in a keystore. (String, required)

-certificateFilePath

Full path of the request file that contains the certificate. (String, required)

-base64Encoded

Specifies that the certificate is a Base64 encoded ASCII data file type if the value is set to true. Set the value of this parameter to false if the certificate is a binary DER data file type. (Boolean, required)

Optional parameters

-keyStoreScope

Scope name of the keystore. (String, optional)

Example output The command does not return output.

Examples

Batch mode example usage:

• Jacl...

  $AdminTask addSignerCertificate {-keyStoreName testKeyStore -certificateAlias
  default -certificateFilePath <file path> -base64Encoded true}
  

• Use Jython string:

  AdminTask.addSignerCertificate('[-keyStoreName testKeyStore -certificateAlias
  default -certificateFilePath <file path> -base64Encoded true]')
  

• Use Jython list:

  AdminTask.addSignerCertificate(['-keyStoreName', 'testKeyStore', '-certificateAlias', 'default', '-certificateFilePath', '<file path>', '-base64Encoded', 'true'])
  

Interactive mode example usage:

• Jacl...

  $AdminTask addSignerCertificate {-interactive}
  

• Use Jython string:

  AdminTask.addSignerCertificate ('[-interactive]')
  

 

deleteSignerCertificate

The deleteSignerCertificate command delete a signer certificate from a certificate file from a keystore.

Target object

None.

Required parameters

-keyStoreName

Name that uniquely identifies the keystore configuration object. (String, required)

-certificateAlias

Name that uniquely identifies the certificate request in a keystore. (String, required)

Optional parameters

-keyStoreScope

Scope name of the keystore. (String, optional)

Example output The command does not return output.

Examples

Batch mode example usage:

• Jacl...

  $AdminTask deleteSignerCertificate {-keyStoreName testKeyStore -certificateAlias
  default}
  

• Use Jython string:

  AdminTask.deleteSignerCertificate('[-keyStoreName testKeyStore -certificateAlias
  default]')
  

• Use Jython list:

  AdminTask.deleteSignerCertificate(['-keyStoreName', 'testKeyStore', '-certificateAlias', 'default'])
  

Interactive mode example usage:

• Jacl...

  $AdminTask deleteSignerCertificate {-interactive}
  

• Use Jython string:

  AdminTask.deleteSignerCertificate ('[-interactive]')
  

 

extractSignerCertificate

The extractSignerCertificate command extracts a signer certificate from a key store to a file.

Target object

None

Required parameters and return values

-keyStoreName

The name of the key store where the signer certificate is located. (String, required)

-keyStoreScope

The management scope of the key store. (String, optional)

-certificateAlias

The alias name of the signer certificate in the key store. (String, required)

-certificateFilePath

The full path name of the file that contains the signer certificate. (String, required)

-base64Encoded

Set the value of this parameter to true if the certificate is ascii base 64 encoded. Set the value of this parameter to false if the certificate is binary. (String, required)

Examples

Interactive mode example usage:

• Jacl...

  $AdminTask extractSignerCertificate {-interactive}
  

• Use Jython string:

  AdminTask.extractSignerCertificate ('[-interactive]')
  

• Use Jython list:

  AdminTask.extractSignerCertificate (['-interactive'])
  

 

getSignerCertificate

The getSignerCertificate command obtains information about a signer certificate from a key store.

Target object

None

Required parameters and return values

-keyStoreName

The name of the key store where the signer certificate is located. (String, required)

-keyStoreScope

The management scope of the key store. (String, optional)

-certificateAlias

The alias name of the signer certificate in the key store. (String, required)

Examples

Interactive mode example usage:

• Jacl...

  $AdminTask getSignerCertificate {-interactive}
  

• Use Jython string:

  AdminTask.getSignerCertificate ('[-interactive]')
  

• Use Jython list:

  AdminTask.getSignerCertificate (['-interactive'])
  

 

listSignerCertificates

The listSignerCertificates command lists all signer certificates in a particular key store.

Target object

None

Required parameters and return values

-keyStoreName

The name of the key store where the signer certificate is located. (String, required)

-keyStoreScope

The management scope of the key store. (String, optional)

Examples

Interactive mode example usage:

• Jacl...

  $AdminTask listSignerCertificates {-interactive}
  

• Use Jython string:

  AdminTask.listSignerCertificates ('[-interactive]')
  

• Use Jython list:

  AdminTask.listSignerCertificates (['-interactive'])
  

 

retrieveSignerFromPort

The retrieveSignerFromPort command retrieves a signer from a remote host and stores the signer in a key store.

Target object

None

Required parameters and return values

-host

The host name of the system from where the signer certificate will be retrieved. (String, required)

-port

The port of the remote system from where the signer certificate will be retrieved. (Integer, required)

-keyStoreName

The name of the key store where the signer certificate is located. (String, required)

-keyStoreScope

The management scope of the key store. (String, required)

-sslConfigName

The name of the SSL configuration object. (String, optional)

-sslConfigScopeName

The management scope where the SSL configuration object is located. (String, optional)

Examples

Batch mode example usage:

• Jacl...

  $AdminTask retrieveSignerFromPort {-host serverHost -port 443 -keyStoreName testKeyStore 
  -certificateAlias serverHostSigner}
  

• Use Jython string:

  AdminTask.retrieveSignerFromPort ('[-host serverHost -port 443 -keyStoreName testKeyStore 
  -certificateAlias serverHostSigner]')
  

• Use Jython list:

  AdminTask.retrieveSignerFromPort (['-host', 'serverHost', '-port', '443', '-keyStoreName', 
  'testKeyStore', '-certificateAlias', 'serverHostSigner'])
  

Interactive mode example usage:

• Jacl...

  $AdminTask retrieveSignerFromPort {-interactive}
  

• Use Jython string:

  AdminTask.retrieveSignerFromPort ('[-interactive]')
  

• Use Jython list:

  AdminTask.retrieveSignerFromPort (['-interactive'])
  

 

retrieveSignerInfoFromPort

The retrieveSignerInfoFromPort command retrieves signer information from a port on a remote host.

Target object

None

Required parameters and return values

-host

The host name of the system from where the signer certificate will be retrieved. (String, required)

-port

The port of the remote system from where the signer certificate will be retrieved. (Integer, required)

-sslConfigName

The name of the SSL configuration object. (String, optional)

-sslConfigScopeName

The management scope where the SSL configuration object is located. (String, optional)

Examples

Interactive mode example usage:

• Jacl...

  $AdminTask retrieveSignerInfoFromPort {-interactive}
  

• Use Jython string:

  AdminTask.retrieveSignerInfoFromPort ('[-interactive]')
  

• Use Jython list:

  AdminTask.retrieveSignerInfoFromPort (['-interactive'])
  

---

 

Related tasks

Use AdminTask for scripted administration

 

Related

Commands for AdminTask