WSCertExpMonitorCommands

Use the Jython or Jacl scripting languages to configure security with the wsadmin tool. The commands in the WSCertExpMonitorCommands group can be used to start or update the certificate expiration monitor.

The WSCertExpMonitorCommands command group for the AdminTask objectcommands include:

• createWSCertExpMonitor
• deleteWSCertExpMonitor
• getWSCertExpMonitor
• listWSCertExpMonitor
• modifyWSCertExpMonitor
• startCertificateExpMonitor

createWSCertExpMonitor

Create the certificate expiration monitor settings in the configuration.

Target object: None.

Required parameters and return values

-name

The name that uniquely identifies the certificate expiration monitor. (String, required)

-autoReplace

Set value to true to replace a certificate within a certificate expiration date. If not, set value to false. (Boolean, required)

-deleteOld

Set value to true to delete an old certificate during certificate expiration monitoring. If not, set value to false. (Boolean, required)

-daysBeforeNotification

The number of days before a certificate expires to be notified of the expiration. (Integer, required)

-wsScheduleName

The name of the scheduler to use for certificate expiration. (String, required)

-wsNotificationName

The name of the notifier to use for certificate expiration. (String, required)

-isEnabled

Set value to true if the certificate expiration monitor is enabled. If not, set value to false. (Boolean, optional)

• Returns: The configuration object name of the certificate expiration monitor object that we created.

Examples

Batch mode example usage:

• Jacl:
  $AdminTask createWSCertExpMonitor {-name testCertMon -autoReplace true -deleteOld true -daysBeforeNotification 30 -wsScheduleName testSchedule -wsNotificationName testNotifier -isEnabled false}

• Jython string:
  AdminTask.createWSCertExpMonitor ('[-name testCertMon -autoReplace true -deleteOld true -daysBeforeNotification 30 -wsScheduleName testSchedule -wsNotificationName testNotifier -isEnabled false]')

• Jython list:
  AdminTask.createWSCertExpMonitor (['-name', 'testCertMon', '-autoReplace', 'true', '-deleteOld', 'true', '-daysBeforeNotification', '30', '-wsScheduleName', 'testSchedule', '-wsNotificationName', 'testNotifier', '-isEnabled', 'false'])

Interactive mode example usage:

• Jacl:
  $AdminTask createWSCertExpMonitor {-interactive}

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

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

deleteWSCertExpMonitor

Delete the settings of a scheduler from the configuration.

Target object: None.

Required parameters and return values

-name

The name that uniquely identifies the certificate expiration monitor. (String, required)

Examples

Batch mode example usage:

• Jacl:
  $AdminTask deleteWSCertExpMonitor {-name testCertMon}

• Jython string:
  AdminTask.deleteWSCertExpMonitor ('[-name testCertMon]')

• Jython list:
  AdminTask.deleteWSCertExpMonitor (['-name', 'testCertMon'])

Interactive mode example usage:

• Jacl:
  $AdminTask deleteWSCertExpMonitor {-interactive}

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

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

getWSCertExpMonitor

Display the settings of a particular scheduler.

Target object: None.

Required parameters and return values

-name

The name that uniquely identifies the certificate expiration monitor. (String, required)

• Returns: The scheduler in the configuration.

Examples

Batch mode example usage:

• Jacl:
  $AdminTask getWSCertExpMonitor {-name testCertMon}

• Jython string:
  AdminTask getWSCertExpMonitor ('[-name testCertMon]')

• Jython list:
  AdminTask getWSCertExpMonitor (['-name', 'testCertMon'])

Interactive mode example usage:

• Jacl:
  $AdminTask getWSCertExpMonitor {-interactive}

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

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

listWSCertExpMonitor

List the scheduler in the configuration.

Target object: None.

Required parameters and return values

-displayObjectNames

If we set value to true, the command returns the certificate expiration monitor configuration object. If we set value to false, the command returns the name of the certificate expiration monitor. (Boolean, optional)

Examples

Batch mode example usage:

• Jacl:
  $AdminTask listWSCertExpMonitor {-displayObjectName false}

• Jython string:
  AdminTask.listWSCertExpMonitor ('[-displayObjectName false]')

• Jython list:
  AdminTask.listWSCertExpMonitor (['-displayObjectName', 'false'])

Interactive mode example usage:

• Jacl:
  $AdminTask listWSCertExpMonitor {-interactive}

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

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

modifyWSCertExpMonitor

Change the setting of an existing scheduler.

Target object: None.

Required parameters and return values

-name

The name that uniquely identifies the certificate expiration monitor. (String, required)

-autoReplace

Set value to true to replace a certificate within a certificate expiration date. If not, set value to false. (Boolean, required)

-deleteOld

Set value to true to delete an old certificate during certificate expiration monitoring. If not, set value to false. (Boolean, required)

-daysBeforeNotification

The number of days before a certificate expires to be notified of the expiration. (Integer, required)

-wsScheduleName

The name of the scheduler to use for certificate expiration. (String, required)

-wsNotificationName

The name of the notifier to use for certificate expiration. (String, required)

-isEnabled

Set value to true if the certificate expiration monitor is enabled. If not, set value to false. (Boolean, optional)

• Returns: None

Examples

Batch mode example usage:

• Jacl:
  $AdminTask modifyWSCertExpMonitor {-name testCertMon -autoReplace false -deleteOld false -daysBeforeNotification 20 -isEnabled true}

• Jython string:
  AdminTask.modifyWSCertExpMonitor ('[-name testCertMon -autoReplace false -deleteOld false -daysBeforeNotification 20 -isEnabled true]')

• Jython list:
  AdminTask.modifyWSCertExpMonitor (['-name', 'testCertMon', '-autoReplace', 'false', '-deleteOld', 'false', '-daysBeforeNotification', '20', '-isEnabled', 'true'])

Interactive mode example usage:

• Jacl:
  $AdminTask modifyWSCertExpMonitor {-interactive}

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

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

startCertificateExpMonitor

Perform certificate monitoring. This command visits all key stores and checks to see if they are within certificate expiration range.

Target object: None.

Required parameters and return values

• Parameters: None
• Returns: None

Examples

Batch mode example usage:

• Jacl:
  $AdminTask startCertificateExpMonitor

• Jython:
  AdminTask.startCertificateExpMonitor()

Interactive mode example usage:

• Jacl:
  $AdminTask startCertificateExpMonitor {-interactive}

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

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

Use the wsadmin scripting AdminTask

Commands for the AdminTask object