CertificateRequestCommands command group of the AdminTask object

Use the Jython or Jacl scripting languages to configure security with the wsadmin tool. The commands in the CertificateRequestCommands group can be used to manage certificate requests.

The CertificateRequestCommands commands include:

• createCertificateRequest
• deleteCertificateRequest
• extractCertificateRequest
• getCertificateRequest
• listCertificateRequests

createCertificateRequest

Create a certificate request associated with a particular key store.

Target object: None.

Parameters and return values

-keyStoreName

The name that uniquely identifies the key store configuration object. (String, required)

-keyStoreScope

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

-certificateAlias

The name that uniquely identifies the certificate request in a key store. (String, required)

-certificateVersion

The certificate version. (String, required)

-certificateSize

(Integer, required)

-certificateCommonName

(String, required)

-certificateOrganization

(String, optional)

-certificateOrganizationalUnit

(String, optional)

-certificateLocality

(String, optional)

-certificateState

The state code for the certificate. (String, optional)

-certificateZip

The zip code for the certificate. (String, optional)

-certificateCountry

The country for the certificate. (String, optional)

-certificateValidDays

The amount of time in days for which the certificate is valid. (Integer, optional)

-certificateRequestFilePath

The file location of the certificate request that can be sent to a certificate authority. (String, required)

-signatureAlgorithm

The signature algorithm used to create the self-signed certificate. The list of valid signature algorithms can be retrieved using the listSignatureAlgorithms command. (String, optional)

• Returns: The configuration object name of the key store object that we created.

Examples

Batch mode example usage:

• Jacl:
  $AdminTask createCertificateRequest {-keyStoreName testKeyStore -certificateAlias certReq -certificateSize 1024 -certificate CommonName localhost -certificate Organization testing -certificate RequestFilePath c:/temp/testCertReq.arm}

• Jython string:
  AdminTask.createCertificateRequest ('[-keyStoreName testKeyStore -certificateAlias certReq -certificateSize 1024 -certificate CommonName localhost -certificate Organization testing -certificate RequestFilePath c:/temp/testCertReq.arm]')

• Jython list:
  AdminTask.createCertificateRequest (['-keyStoreName', 'testKeyStore', '-certificateAlias', 'certReq', '-certificateSize', '1024', '-certificateCommonName', 'localhost','-certificateOrganization', 'testing', '-certificateRequestFilePath','c:/temp/testCertReq.arm'])

Interactive mode example usage:

• Jacl:
  $AdminTask createCertificateRequest {-interactive}

• Jython string:
  AdminTask.createCertificateRequest ('[-interactive]')

• Jython list:
  AdminTask.createCertificateRequest (['-interactive'])

deleteCertificateRequest

Delete a certificate request from a key store.

Target object: None.

Parameters and return values

-keyStoreName

The name that uniquely identifies the key store configuration object. (String, required)

-keyStoreScope

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

-certificateAlias

The name that uniquely identifies the certificate request in a key store. (String, required)

• Returns: None.

Examples

Batch mode example usage:

• Jacl:
  $AdminTask deleteCertificateRequest {-keyStoreName testKeyStore -certificateAlias certReq}

• Jython string:
  AdminTask.deleteCertificateRequest ('[-keyStoreName testKeyStore -certificateAlias certReq]')

• Jython list:
  AdminTask.deleteCertificateRequest (['-keyStoreName', 'testKeyStore', '-certificateAlias', 'certReq'])

Interactive mode example usage:

• Jacl:
  $AdminTask deleteCertificateRequest {-interactive}

• Jython string:
  AdminTask.deleteCertificateRequest ('[-interactive]')

• Jython list:
  AdminTask.deleteCertificateRequest (['-interactive'])

extractCertificateRequest

Extract a certificate request to a file.

Target object: None.

Parameters and return values

-keyStoreName

The name that uniquely identifies the key store configuration object. (String, required)

-keyStoreScope

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

-certificateAlias

The name that uniquely identifies the certificate request in a key store. (String, required)

-certificateRequestFilePath

The file location of the certificate request that can be sent to a certificate authority. (String, required)

Optional parameters

-signatureAlgorithm

The signature algorithm used to create the self-signed certificate. The list of valid signature algorithms can be retrieved using the listSignatureAlgorithms command. (String, optional)

Elliptical Curve signature algorithms require specific sizes, so the size parameter is ignored if SHA256withECDSA, SHA384withECDSA, or SHA512withECDSA is specified. SHA256withECDSA will have a size of 256, SHA384withECDSA will have a size of 384, and SHA512withECDSA will have a size of 521.

• Returns: A certificate request file is created containing the extracted certificate.

Examples

Batch mode example usage:

• Jacl:
  $AdminTask extractCertificateRequest {-keyStoreName testKeyStore -certificateAlias certReq -certificateRequestFilePath c:/temp/testCertReq.arm}

• Jython string:
  AdminTask.extractCertificateRequest ('[-keyStoreName testKeyStore -certificateAlias certReq -certificateRequestFilePath c:/temp/testCertReq.arm]')

• Jython list:
  AdminTask.extractCertificateRequest (['-keyStoreName', 'testKeyStore', '-certificateAlias', 'certReq', '-certificateRequestFilePath','c:/temp/testCertReq.arm'])

Interactive mode example usage:

• Jacl:
  $AdminTask extractCertificateRequest {-interactive}

• Jython string:
  AdminTask.extractCertificateRequest ('[-interactive]')

• Jython list:
  AdminTask.extractCertificateRequest (['-interactive'])

getCertificateRequest

Obtain information about a particular certificate request in a key store.

Target object: None.

Parameters and return values

-keyStoreName

The name that uniquely identifies the key store configuration object. (String, required)

-keyStoreScope

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

-certificateAlias

The name that uniquely identifies the certificate request in a key store. (String, required)

• Returns: Information about the certificate request.

Examples

Batch mode example usage:

• Jacl:
  $AdminTask getCertificateRequest {-keyStoreName testKeyStore -certificateAlias certReq}

• Jython string:
  AdminTask.getCertificateRequest ('[-keyStoreName testKeyStore -certificateAlias certReq]')

• Jython list:
  AdminTask.getCertificateRequest (['-keyStoreName', 'testKeyStore', '-certificateAlias', 'certReq'])

Interactive mode example usage:

• Jacl:
  $AdminTask getCertificateRequest {-interactive}

• Jython string:
  AdminTask.getCertificateRequest ('[-interactive]')

• Jython list:
  AdminTask.getCertificateRequest (['-interactive'])

listCertificateRequests

List all the certificate requests associated with a particular key store.

Target object: None.

Parameters and return values

-keyStoreName

The name that uniquely identifies the key store configuration object. (String, required)

-keyStoreScope

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

• Returns: An attribute list for each certificate request in a key store.

Examples

Batch mode example usage:

• Jacl:
  $AdminTask listCertificateRequest {-keyStoreName testKeyStore}

• Jython string:
  AdminTask.listCertificateRequest ('[-keyStoreName testKeyStore]')

• Jython list:
  AdminTask.listCertificateRequest (['-keyStoreName', 'testKeyStore'])

Interactive mode example usage:

• Jacl:
  $AdminTask listCertificateRequests {-interactive}

• Jython string:
  AdminTask.listCertificateRequests ('[-interactive]')

• Jython list:
  AdminTask.listCertificateRequests (['-interactive'])

wsadmin AdminTask

Commands for the AdminTask object

Use wsadmin scripting with Jython