Network Deployment (Distributed operating systems), v8.0 > Reference > Commands (wsadmin scripting)

CertificateRequestCommands command group of the AdminTask object

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

The CertificateRequestCommands command group for the AdminTask object includes the following commands:

• createCertificateRequest

• deleteCertificateRequest

• extractCertificateRequest

• getCertificateRequest

• listCertificateRequests

createCertificateRequest

The createCertificateRequest command creates a certificate request that is 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)

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

Examples

Batch example...:

### 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 example...

### Jacl

$AdminTask createCertificateRequest {-interactive}

### Jython string

AdminTask.createCertificateRequest ('[-interactive]')

• Jython list:

  AdminTask.createCertificateRequest (['-interactive'])
  

deleteCertificateRequest

The deleteCertificateRequest command deletes 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 example...:

### Jacl

$AdminTask deleteCertificateRequest {-keyStoreName testKeyStore
-certificateAlias certReq}

### Jython string

AdminTask.deleteCertificateRequest ('[-keyStoreName testKeyStore
-certificateAlias certReq]')

• Jython list:

  AdminTask.deleteCertificateRequest (['-keyStoreName', 'testKeyStore',
  '-certificateAlias', 'certReq'])
  

Interactive example...

### Jacl

$AdminTask deleteCertificateRequest {-interactive}

### Jython string

AdminTask.deleteCertificateRequest ('[-interactive]')

• Jython list:

  AdminTask.deleteCertificateRequest (['-interactive'])
  

extractCertificateRequest

The extractCertificateRequestcommand extracts 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)

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

Examples

Batch example...:

### 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 example...

### Jacl

$AdminTask extractCertificateRequest {-interactive}

### Jython string

AdminTask.extractCertificateRequest ('[-interactive]')

• Jython list:

  AdminTask.extractCertificateRequest (['-interactive'])
  

getCertificateRequest

The getCertificateRequest command obtains 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 example...:

### Jacl

$AdminTask getCertificateRequest {-keyStoreName testKeyStore
-certificateAlias certReq}

### Jython string

AdminTask.getCertificateRequest ('[-keyStoreName testKeyStore
-certificateAlias certReq]')

• Jython list:

  AdminTask.getCertificateRequest (['-keyStoreName', 'testKeyStore',
  '-certificateAlias', 'certReq'])
  

Interactive example...

### Jacl

$AdminTask getCertificateRequest {-interactive}

### Jython string

AdminTask.getCertificateRequest ('[-interactive]')

• Jython list:

  AdminTask.getCertificateRequest (['-interactive'])
  

listCertificateRequests

The listCertificateRequests command lists 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 example...:

### Jacl

$AdminTask listCertificateRequest {-keyStoreName testKeyStore}

### Jython string

AdminTask.listCertificateRequest ('[-keyStoreName testKeyStore]')

• Jython list:

  AdminTask.listCertificateRequest (['-keyStoreName', 'testKeyStore'])
  

Interactive example...

### Jacl

$AdminTask listCertificateRequests {-interactive}

### Jython string

AdminTask.listCertificateRequests ('[-interactive]')

• Jython list:

  AdminTask.listCertificateRequests (['-interactive'])
  

Use the wsadmin scripting AdminTask object for scripted administration

Related

Commands using wsadmin.sh
Use wsadmin scripting with Jython

+

Search Tips   |   Advanced Search