WSCertExpMonitorCommands command group for the AdminTask object

Operating Systems: i5/OS
Personalize the table of contents and search results

WSCertExpMonitorCommands command group for the AdminTask object

You can use the Jython or Jacl scripting languages to configure security with the wsadmin tool. The commands and parameters in the WSCertExpMonitorCommands group can be used to start or update the certificate expiration monitor. The WSCertExpMonitorCommands command group for the AdminTask object includes the following commands:

createWSCertExpMonitor
deleteWSCertExpMonitor
getWSCertExpMonitor
listWSCertExpMonitor
modifyWSCertExpMonitor
startCertificateExpMonitor

createWSCertExpMonitor

The createWSCertExpMonitor command creates 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 the value of this parameter to true if you want to replace a certificate within a certificate expiration date. If not, set the value of this parameter to false. (Boolean, required)
-deleteOld: Set the value of this parameter to true if you want to delete an old certificate during certificate expiration monitoring. If not, set the value of this parameter to false. (Boolean, required)
-daysBeforeNotification: The number of days before a certificate expires that you want 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 the value of this parameter to true if the certificate expiration monitor is enabled. If not, set the value of this parameter to false. (Boolean, optional)

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

Examples

Batch mode example usage:

Using Jacl:

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

Using Jython string:

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

Using Jython list:

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

Interactive mode example usage:

Using Jacl:

$AdminTask createWSCertExpMonitor {-interactive}

Using Jython string:

AdminTask.createWSCertExpMonitor ('[-interactive]')

Using Jython list:

AdminTask.createWSCertExpMonitor (['-interactive'])

deleteWSCertExpMonitor

The deleteWSCertExpMonitor command deletes 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:

Using Jacl:

$AdminTask deleteWSCertExpMonitor {-name testCertMon}

Using Jython string:

AdminTask.deleteWSCertExpMonitor ('[-name testCertMon]')

Using Jython list:

AdminTask.deleteWSCertExpMonitor (['-name', 'testCertMon'])

Interactive mode example usage:

Using Jacl:

$AdminTask deleteWSCertExpMonitor {-interactive}

Using Jython string:

AdminTask.deleteWSCertExpMonitor ('[-interactive]')

Using Jython list:

AdminTask.deleteWSCertExpMonitor (['-interactive'])

getWSCertExpMonitor

The getWSCertExpMonitor command displays 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:

Using Jacl:

$AdminTask getWSCertExpMonitor {-name testCertMon}

Using Jython string:

AdminTask getWSCertExpMonitor ('[-name testCertMon]')

Using Jython list:

AdminTask getWSCertExpMonitor (['-name', 'testCertMon'])

Interactive mode example usage:

Using Jacl:

$AdminTask getWSCertExpMonitor {-interactive}

Using Jython string:

AdminTask.getWSCertExpMonitor ('[-interactive]')

Using Jython list:

AdminTask.getWSCertExpMonitor (['-interactive'])

listWSCertExpMonitor

The listWSCertExpMonitor command lists the scheduler in the configuration.

Target object None.

Required parameters and return values

-displayObjectNames: If you set the value of this parameter to true, the command returns the certificate expiration monitor configuration object. If you set the value of this parameter to false, the command returns the name of the certificate expiration monitor. (Boolean, optional)

Examples

Batch mode example usage:

Using Jacl:

$AdminTask listWSCertExpMonitor {-displayObjectName false}

Using Jython string:

AdminTask.listWSCertExpMonitor ('[-displayObjectName false]')

Using Jython list:

AdminTask.listWSCertExpMonitor (['-displayObjectName', 'false'])

Interactive mode example usage:

Using Jacl:

$AdminTask listWSCertExpMonitor {-interactive}

Using Jython string:

AdminTask.listWSCertExpMonitor ('[-interactive]')

Using Jython list:

AdminTask.listWSCertExpMonitor (['-interactive'])

modifyWSCertExpMonitor

The modifyWSCertExpMonitor command changes 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 the value of this parameter to true if you want to replace a certificate within a certificate expiration date. If not, set the value of this parameter to false. (Boolean, required)
-deleteOld: Set the value of this parameter to true if you want to delete an old certificate during certificate expiration monitoring. If not, set the value of this parameter to false. (Boolean, required)
-daysBeforeNotification: The number of days before a certificate expires that you want 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 the value of this parameter to true if the certificate expiration monitor is enabled. If not, set the value of this parameter to false. (Boolean, optional)

Returns: None

Examples

Batch mode example usage:

Using Jacl:

$AdminTask modifyWSCertExpMonitor {-name testCertMon –autoReplace false –deleteOld false –daysBeforeNotification 20 –isEnabled true}

Using Jython string:

AdminTask.modifyWSCertExpMonitor ('[-name testCertMon –autoReplace false –deleteOld false –daysBeforeNotification 20 –isEnabled true]')

Using Jython list:

AdminTask.modifyWSCertExpMonitor (['-name', 'testCertMon', '–autoReplace', 'false', '–deleteOld', 'false', '–daysBeforeNotification', '20', '–isEnabled', 'true'])

Interactive mode example usage:

Using Jacl:

$AdminTask modifyWSCertExpMonitor {-interactive}

Using Jython string:

AdminTask.modifyWSCertExpMonitor ('[-interactive]')

Using Jython list:

AdminTask.modifyWSCertExpMonitor (['-interactive'])

startCertificateExpMonitor

The startCertificateExpMonitor command performs 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:

Using Jacl:
```
$AdminTask startCertificateExpMonitor
```
Using Jython:
```
AdminTask.startCertificateExpMonitor()
```

Interactive mode example usage:

Using Jacl:

$AdminTask startCertificateExpMonitor {-interactive}

Using Jython string:

AdminTask.startCertificateExpMonitor ('[-interactive]')

Using Jython list:

AdminTask.startCertificateExpMonitor (['-interactive'])

Related Reference

Commands for the AdminTask object