KeySetGroupCommands 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 KeySetGroupCommands group can be used to create and manage key set groups. Use these commands to manage groups of public, private, and shared keys. The KeySetGroupCommands command group for the AdminTask object includes the following commands:

• deleteKeySetGroup

• generateKeysForKeySetGroup

• getKeySetGroups

• listKeySetGroups

• modifyKeySetGroup

 

deleteKeySetGroup

The deleteKeySetGroup command deletes the settings of a key set group from the configuration.

Target object

None

Parameters and return values

-name

The name that uniquely identifies the key set group. (String, required)

-scopeName

The name of the scope. (String, optional)

Examples

Batch mode example usage:

• Use Jacl:

  $AdminTask deleteKeySetGroup {-name keySetGrp }
  

• Use Jython string:

  AdminTask.deleteKeySetGroup ('[-name keySetGrp]')
  

• Use Jython list:

  AdminTask.deleteKeySetGroup (['-name', 'keySetGrp'])
  

Interactive mode example usage:

• Use Jacl:

  $AdminTask deleteKeySetGroup {-interactive}
  

• Use Jython string:

  AdminTask.deleteKeySetGroup ('[-interactive]')
  

• Use Jython list:

  AdminTask.deleteKeySetGroup (['-interactive'])
  

 

generateKeysForKeySetGroup

The generateKeysForKeySetGroup command generates keys for all of the keys in the key sets that make up the key set group.

Target object

None

Parameters and return values

-keySetGroupName

The name of the key set group. (String, required)

-keySetGroupScope

The scope of the key set group. (String, optional)

Examples

Batch mode example usage:

• Use Jacl:

  $AdminTask generateKeyForKeySetGroup {-keySetGroupName keySetGrp}
  

• Use Jython string:

  AdminTask.generateKeyForKeySetGroup ('[-keySetGroupName keySetGrp]')
  

• Use Jython list:

  AdminTask.generateKeyForKeySetGroup (['-keySetGroupName', 'keySetGrp'])
  

Interactive mode example usage:

• Use Jacl:

  $AdminTask generateKeysForKeySetGroup {-interactive}
  

• Use Jython string:

  AdminTask.generateKeysForKeySetGroup ('[-interactive]')
  

• Use Jython list:

  AdminTask.generateKeysForKeySetGroup (['-interactive'])
  

 

getKeySetGroups

The getKeySetGroups command displays the settings of a particular key set group.

Target object

None

Parameters and return values

-name

The name that uniquely identifies the key set group. (String, required)

-scopeName

The name of the scope. (String, optional)

Examples

Batch mode example usage:

• Use Jacl:

  $AdminTask getKeySetGroup { -name keySetGrp }
  

• Use Jython string:

  AdminTask.getKeySetGroup ('[-name keySetGrp]')
  

• Use Jython list:

  AdminTask.getKeySetGroup (['-name', 'keySetGrp'])
  

Interactive mode example usage:

• Use Jacl:

  $AdminTask getKeySetGroups {-interactive}
  

• Use Jython string:

  AdminTask.getKeySetGroups ('[-interactive]')
  

• Use Jython list:

  AdminTask.getKeySetGroups (['-interactive'])
  

 

listKeySetGroups

The listKeySetGroups command lists the key set groups for a particular scope.

Target object

None

Parameters and return values

-scopeName

The name of the scope. (String, optional)

-displayObjectNames

If you set the value of this parameter to true, the command returns a list of all of the key set group objects within a scope. If you set the value of this parameter to false, the command returns a list of strings that contain the key set group name and management scope. (Boolean, optional)

Examples

Batch mode example usage:

• Use Jacl:

  $AdminTask listKeySetGroup {-displayObjectName true}
  

• Use Jython string:

  AdminTask.listKeySetGroup ('[-displayObjectName true]')
  

• Use Jython list:

  AdminTask.listKeySetGroup (['-displayObjectName', 'true'])
  

Interactive mode example usage:

• Use Jacl:

  $AdminTask listKeySetGroups {-interactive}
  

• Use Jython string:

  AdminTask.listKeySetGroups ('[-interactive]')
  

• Use Jython list:

  AdminTask.listKeySetGroups (['-interactive'])
  

 

modifyKeySetGroup

The modifyKeySetGroup command changes the settings of an existing key set group.

Target object

None

Parameters and return values

-name

The name that uniquely identifies the key set group. (String, required)

-scopeName

The name of the scope. (String, optional)

-autoGenerate

Set the value of this parameter to true if you want to automatically generate keys. If not, set the value to false. (Boolean, optional)

-wsScheduleName

The name of the scheduler to use to perform key generation. (String, optional)

-keySetObjectNames

A list of key set configuration names separated by colons (:). (String, optional)

Examples

Batch mode example usage:

• Use Jacl:

  $AdminTask modifyKeySetGroup {-name keySetGrp -autoGenetate false}
  

• Use Jython string:

  AdminTask.modifyKeySetGroup ('[-name keySetGrp -autoGenetate false]')
  

• Use Jython list:

  AdminTask.modifyKeySetGroup (['-name', 'keySetGrp', '-autoGenetate', 'false'])
  

Interactive mode example usage:

• Use Jacl:

  $AdminTask modifyKeySetGroup {-interactive}
  

• Use Jython string:

  AdminTask.modifyKeySetGroup ('[-interactive]')
  

• Use Jython list:

  AdminTask.modifyKeySetGroup (['-interactive'])
  

---

 

Related tasks

Use the AdminTask object for scripted administration

 

Related Reference

Commands for the AdminTask object

 

Reference topic