Network Deployment (Distributed operating systems), v8.0 > Reference > Commands (wsadmin scripting)
PolicySetManagement command group
Use the Jython or Jacl scripting languages to manage policy set configurations with wsadmin.sh. Use the commands and parameters in the PolicySetManagement group to create, delete, and manage policy set, policy, and policy set attachment configurations.
Before you use the commands in this topic, verify that you are using the most recent version of wsadmin.sh. The policy set management commands that accept a properties object as the value for the attributes or bindingLocation parameters are not supported on previous versions of wsadmin.sh. For example, the commands do not run on a v6.1.0.x node.
Use the following commands to manage policy set configurations:
- listPolicySets
- getPolicySet
- createPolicySet
- copyPolicySet
- deletePolicySet
- updatePolicySet
- validatePolicySet
- exportPolicySet
- importPolicySet
Use the following commands to manage policy settings:
- addPolicyType
- deletePolicyType
- listPolicyTypes
- getPolicyType
- setPolicyType
- getPolicyTypeAttribute
- setPolicyTypeAttribute
Use the following commands to manage policy set attachments:
- getPolicySetAttachments
- createPolicySetAttachment
- updatePolicySetAttachment
- addToPolicySetAttachment
- removeFromPolicySetAttachment
- deletePolicySetAttachment
- listAttachmentsForPolicySet
- listAssetsAttachedToPolicySet
- deleteAttachmentsForPolicySet
- transferAttachmentsForPolicySet
- listSupportedPolicySets
Use the following commands to manage policy set bindings:
- getBinding
- setBinding
- getDefaultBindings
- getRequiredBindingVersion
- setDefaultBindings
- exportBinding
- importBinding
- copyBinding
- upgradeBindings
listPolicySets
The listPolicySets command returns a list of all existing policy sets. If administrative security is enabled, each user role can use this command.
Target object None
Optional parameters
Return value
The command returns a list of all existing policy sets. Each entry in the list is the name of a policy set.
Batch example...
- Jython string:
AdminTask.listPolicySets('[-policySetType system/trust]') - Use Jython list:
AdminTask.listPolicySets(['-policySetType', 'system/trust'])
Interactive example...
### Jython
AdminTask.listPolicySets('-interactive')
getPolicySet
The getPolicySet command returns general attributes, such as description and default indicator, for the specified policy set. If administrative security is enabled, each user role can use this command.
Target object None
Required parameters
Optional parameters
Return value
The command returns a list of attributes for the specified policy set name.
Batch example...
- Jython string:
AdminTask.getPolicySet('[-policySet SecureConversation]') - Use Jython list:
AdminTask.getPolicySet(['-policySet', 'SecureConversation'])
Interactive example...
### Jython
AdminTask.getPolicySet('-interactive')
createPolicySet
The createPolicySet command creates a new policy set. Policies are not created with the policy set. The default indicator is set to false.
If administrative security is enabled, use the Administrator role to create policy sets.
Target object None
Required parameters
Optional parameters
Return value
The command returns a success or failure message.
Batch example...
- Jython string:
AdminTask.createPolicySet('[-policySet myCustomPS -description [my new custom policy set] -policySetType system/trust]') - Use Jython list:
AdminTask.createPolicySet(['-policySet', 'myCustomPS', '-description', '[my new custom policy set]', '-policySetType', 'system/trust'])
Interactive example...
### Jython
AdminTask.createPolicySet('-interactive')
copyPolicySet
The copyPolicySet command creates a copy of an existing policy set. By default, the policy set attachments are transferred to the new policy set.
If administrative security is enabled, use the Administrator role to copy policy sets.
Target object None
Required parameters
Optional parameters
Return value
The command returns a success or failure message.
Batch example...
- Jython string:
AdminTask.copyPolicySet('[-sourcePolicySet SecureConversation -newPolicySet CustomSecureConversation -newDescription [my new copied policy set] -transferAttachments true]') - Use Jython list:
AdminTask.copyPolicySet(['-sourcePolicySet', 'SecureConversation', '-newPolicySet', 'CustomSecureConversation', '-newDescription', '[my new copied policy set]', '-transferAttachments', 'true'])
Interactive example...
### Jython
AdminTask.copyPolicySet('-interactive')
deletePolicySet
The deletePolicySet command deletes the specified policy set. If attachments exist for the policy set, the command returns a failure message.
If administrative security is enabled, use the Administrator role to delete policy sets.
Target object None
Required parameters
Return value
The command returns a success or failure message.
Batch example...
- Jython string:
AdminTask.deletePolicySet('[-policySet customSecureConversation]') - Use Jython list:
AdminTask.deletePolicySet(['-policySet', 'customSecureConversation'])
Interactive example...
### Jython
AdminTask.deletePolicySet('-interactive')
updatePolicySet
The updatePolicySet command enables you to input an attribute list to update the policy set. We can use this command to update all attributes for the policy set, or a subset of attributes.
If administrative security is enabled, use the Administrator role to update policy set configurations.
Target object None
Required parameters
Return value
The command returns a success or failure message.
Batch example...
- Jython string:
AdminTask.updatePolicySet('-policySet policySet1 -attributes [[type application] [description [my policy set description]]]') - Use Jython list:
AdminTask.updatePolicySet(['-policySet', 'policySet1', '-attributes', '[[type application] [description [my policy set description]]]'])
Interactive example...
### Jython
AdminTask.updatePolicySet('-interactive')
addPolicyType
The addPolicyType command adds a policy with default values for the specified policy set. We must indicate whether to enable or disable the added policy.
If administrative security is enabled, use the Administrator role to add policies.
Target object None
Required parameters
Return value
The command returns a success or failure message.
Batch example...
- Jython string:
AdminTask.addPolicyType('[-policySet customPolicySet -policyType WSTransaction -enabled true]') - Use Jython list:
AdminTask.addPolicyType(['-policySet', 'customPolicySet', '-policyType', 'WSTransaction', '-enabled', 'true'])
Interactive example...
### Jython
AdminTask.addPolicyType('-interactive')
deletePolicyType
The deletePolicyType command deletes a policy from a policy set.
If administrative security is enabled, use the Administrator role to remove policies from the configuration.
Target object None
Required parameters
Return value
The command returns a success or failure message.
Batch example...
- Jython string:
AdminTask.deletePolicyType('[-policySet customPolicySet -policyType WSTransaction]') - Use Jython list:
AdminTask.deletePolicyType(['-policySet', 'customPolicySet', '-policyType', 'WSTransaction'])
Interactive example...
### Jython
AdminTask.deletePolicyType('-interactive')
validatePolicySet
The validatePolicySet command validates the policy set configuration.
If administrative security is enabled, use the Administrator role to validate policy sets.
Target object None
Required parameters
Return value
The command returns a success or failure message.
Batch example...
- Jython string:
AdminTask.validatePolicySet('[-policySet customSecureConversation]') - Use Jython list:
AdminTask.validatePolicySet(['-policySet', 'customSecureConversation'])
Interactive example...
### Jython
AdminTask.validatePolicySet('-interactive')
exportPolicySet
The exportPolicySet command exports a policy set as an archive that can be copied onto a client environment.
If administrative security is enabled, use the Administrator role to export policy sets.
Target object None
Required parameters
Return value
The command returns a success or failure message.
Batch example...
- Jython string:
AdminTask.exportPolicySet('[-policySet customSecureConversation -pathName C:/IBM/WebSphere/AppServer/PolicySets/customSC.zip]') - Use Jython list:
AdminTask.exportPolicySet(['-policySet', 'customSecureConversation;, '-pathName', ' C:/IBM/WebSphere/AppServer/PolicySets/customSC.zip'])
Interactive example...
### Jython
AdminTask.exportPolicySet('-interactive')
importPolicySet
The importPolicySet command imports a policy set from a compressed archive file or from a selection of default policy sets onto the server environment.
If administrative security is enabled, use the Administrator role to import policy sets.
Target object None
Optional parameters
Return value
The command returns a success or failure message.
Batch example...
- Jython string:
AdminTask.importPolicySet('[-importFile C:/IBM/WebSphere/AppServer/PolicySets/customSC.zip]') - Use Jython list:
AdminTask.importPolicySet(['-importFile', 'C:/IBM/WebSphere/AppServer/PolicySets/customSC.zip'])
Interactive example...
### Jython
AdminTask.importPolicySet('-interactive')
listPolicyTypes
The listPolicyTypes command returns a list of the names of the policies configured on the system. The input parameters allow you to list each policy type configured in the system, the policy types configured in a policy set, or the policy types in a binding.
If administrative security is enabled, each administrative role can list policy types.
Target object None
Optional parameters
- For cell-wide default binding, use a null or empty properties.
- For server-specific default binding, specify the node and server names in the properties. The property names are node and server. Server-specific default bindings are deprecated.
- For attachment-specific binding, specify the application name and attachment ID in the properties. The property names are application and attachmentId.
- For system/trust bindings, set the systemType property as trustService.
- For trust client bindings, specify the systemType property as trustClient. In addition, specify the attachment ID. If the bindings are for a specific application, also specify the application property.
- For WSNClient binding, specify the bus name, service name, and attachment ID in the properties. The property names are bus, WSNService, and attachmentId.
(Properties, optional)
For transitioning users: Even
though you can specify the application value for the -attachmentType parameter, use the provider value in place of the application value because the attachments
are used for more than just applications, such as system attachments
for trust service. For system policy set attachments, specify the provider value for the attachmentType parameter and the "[systemType trustService]" value for the -attachmentProperties parameter. For WSNClient attachments, specify the client value for the attachmentType parameter and the bus and WSNService properties with the -attachmentProperties parameter.trns
Return value
The command returns a list of policy types.
Batch example...
- Jython string:
AdminTask.listPolicyTypes('[-policySet customSecureConversation]') - Use Jython list:
AdminTask.listPolicyTypes(['-policySet', 'customSecureConversation'])
Interactive example...
### Jython
AdminTask.listPolicyTypes('[-interactive]')
getPolicyType
The getPolicyType command returns the attributes for a specified policy.
If administrative security is enabled, each administrative role can query attributes for policies.
Target object None
Required parameters
Optional parameters
Return value
The command returns a properties object containing the policy attributes.
Batch example...
- Jython string:
AdminTask.getPolicyType('[-policySet customSecureConversation -policyType SecureConversation]') - Use Jython list:
AdminTask.getPolicyType(['-policySet', 'customSecureConversation', '-policyType', 'SecureConversation'])
Interactive example...
### Jython
AdminTask.getPolicyType (['-interactive'])
setPolicyType
The setPolicyType command updates the attributes of a specified policy. The admin console command assistance provides incorrect Jython syntax for the setPolicyType command. The XPath expression for the response message part protection of the Username WSSecurity policy set contains single quotes (') within each XPath property value, which Jython does not support.
To fix the command from the admin console command assistance, add a backslash character (\) before each single quote to escape the single quote.
Also, if you are using a Jython script to update the attributes, the brackets should not be included to get a list of elements and not a list of strings.
If administrative security is enabled, use the Administrator role to configure policies.
Target object None
Required parameters
Optional parameters
Return value
The command returns a success or failure message.
Batch example...
- Jython string:
AdminTask.setPolicyType('[-policySet customSecureConversation -policyType SecureConversation -attributes [[type application] [description [my new description]]]]') - Use Jython list:
AdminTask.setPolicyType(['-policySet', 'customSecureConversation', '-policyType', 'SecureConversation', '-attributes', '[[type application] [description [my new description]]]'])
Interactive example...
### Jython
AdminTask.setPolicyType('-interactive')
getPolicyTypeAttribute
The getPolicyTypeAttribute command returns the value for the specified policy attribute.
If administrative security is enabled, each administrative role can query policy type attribute values.
Target object None
Required parameters
Optional parameters
Return value
The command returns a string that contains the value of the specified attribute.
Batch example...
- Jython string:
AdminTask.getPolicyTypeAttribute('[-policySet customSecureConversation -policyType SecureConversation -attributeName type]') - Use Jython list:
AdminTask.getPolicyTypeAttribute(['-policySet', 'customSecureConversation', '-policyType', 'SecureConversation', '-attributeName', 'type'])
Interactive example...
### Jython
AdminTask.getPolicyTypeAttribute('-interactive')
setPolicyTypeAttribute
The setPolicyTypeAttribute command sets the value for the specified policy attribute.
If administrative security is enabled, use the Administrator role to configure policy attributes.
Target object None
Required parameters
Return value
If the attribute is successfully added to the policy, the command returns the true string value.
Batch example...
- Jython string:
AdminTask.setPolicyTypeAttribute('[-policySet customPolicySet -policyType WSReliableMessaging -attributeName specLevel -attributeValue 1.0]') - Use Jython list:
AdminTask.setPolicyTypeAttribute(['-policySet', 'customPolicySet', '-policyType', 'WSReliableMessaging', '-attributeName', 'specLevel', '-attributeValue', '1.0'])
Interactive example...
### Jython
AdminTask.setPolicyTypeAttribute('-interactive')
getPolicySetAttachments
The getPolicySetAttachments command lists the properties for all policy set attachments configured in a specified application.
If administrative security is enabled, each administrative role can query for policy set attachments.
Target object None
Optional parameters
For transitioning users: Even
though you can specify the application value for the -attachmentType parameter, use the provider value in place of the application value because the attachments
are used for more than just applications, such as system attachments
for trust service. For system policy set attachments, specify the provider value for the attachmentType parameter and the "[systemType trustService]" value for the -attachmentProperties parameter. For WSNClient attachments, specify the client value for the attachmentType parameter and the bus and WSNService properties with the -attachmentProperties parameter.trns
Return value
The command returns a list of properties for each attachment in the application, including the policy set name, attachment ID, and resource list. If you specify the expandResources parameter, the command returns the resource, attachmentId, policySet, binding, and directAttachment properties. If a resource is not attached to a policy set, then the system only displays the resource property. The binding property only exists if the attachment contains a custom binding.
Batch example...
- Jython string:
AdminTask.getPolicySetAttachments('[-attachmentType provider -attachmentProperties "[systemType trustService]"]') - Use Jython list:
AdminTask.getPolicySetAttachments(['-attachmentType', 'provider', '-attachmentProperties', '[systemType trustService]'])
The following examples return policy set attachments information for the specified service reference, myServiceRef. The examples return detailed resource information for the logical endpoints or operations for each service reference because the -expandResource parameter is specified.
- Jython string:
AdminTask.getPolicySetAttachments('[-attachmentType client -applicationName application1 -expandResources {http://www.ibm.com}myService -serviceRef myServiceRef]') - Use Jython list:
AdminTask.getPolicySetAttachments(['-attachmentType', 'client', '-applicationName', 'application1', '-expandResources', '{http://www.ibm.com}myService', -serviceRef', 'myServiceRef'])
Interactive example...
- Use Jython list:
AdminTask.getPolicySetAttachments('-interactive')
createPolicySetAttachment
The createPolicySetAttachment command creates a new policy set attachment for an application.
When administrative security is enabled, verify that you use the correct administrative role:
| Administrative role | Authorization |
|---|---|
| Administrator | The Administrator role must have cell-wide access to create policy set attachments. If we have access to a specific resource only, you can create policy set attachments for the resource for which we have access. |
| Configurator | The Configurator role must have cell-wide access to create policy set attachments. If we have access to a specific resource only, you can create policy set attachments for the resource for which we have access. |
| Deployer | The Deployer role with cell-wide or resource specific access can create policy set attachments for application resources only. |
| Operator | The Operator role cannot create policy set attachments. |
| Monitor | The Monitor role cannot create policy set attachments. |
Target object None
Required parameters
Optional parameters
For transitioning users: Even
though you can specify the application value for the -attachmentType parameter, use the provider value in place of the application value because the attachments
are used for more than just applications, such as system attachments
for trust service. For system policy set attachments, specify the provider value for the attachmentType parameter and the "[systemType trustService]" value for the -attachmentProperties parameter. For WSNClient attachments, specify the client value for the attachmentType parameter and the bus and WSNService properties with the -attachmentProperties parameter.trns
Return value
The command returns a string with the ID of the new attachment.
Batch example...
- Jython string:
AdminTask.createPolicySetAttachment('[-policySet policyset1 -resources "WebService:/" -applicationName WebService -attachmentType provider]') - Use Jython list:
AdminTask.createPolicySetAttachment(['-policySet', 'policyset1', '-resources', '"WebService:/"', '-applicationName', 'WebService', '-attachmentType', 'provider'])
Interactive example...
### Jython
AdminTask.createPolicySetAttachment('-interactive')
Mixed-version environment: In a mixed cell environment, not create service reference attachments or resource attachments specified in name-value pair format
for applications that are deployed on an application server that is prior to WAS Version 8. Service reference attachments are only supported on WAS V8 and later.
New feature: In a mixed cell environment, not create attachments to policy sets containing CustomProperties policy for applications that are deployed on an application server that is prior
to WAS v8. The CustomProperties policy is only supported on WAS V8 and later.
mixv
updatePolicySetAttachment
The updatePolicySetAttachment command updates the resources that apply to a policy set attachment.
When administrative security is enabled, verify that you use the correct administrative role:
| Administrative role | Authorization |
|---|---|
| Administrator | The Administrator role must have cell-wide access to configure policy set attachments. If we have access to a specific resource only, you can configure policy set attachments for the resource for which we have access. |
| Configurator | The Configurator role must have cell-wide access to configure policy set attachments. If we have access to a specific resource only, you can configure policy set attachments for the resource for which we have access. |
| Deployer | The Deployer role with cell-wide or resource specific access can configure policy set attachments for application resources only. |
| Operator | The Operator role cannot configure policy set attachments. |
| Monitor | The Monitor role cannot configure policy set attachments. |
Target object None
Required parameters
Optional parameters
For transitioning users: Even
though you can specify the application value for the -attachmentType parameter, use the provider value in place of the application value because the attachments
are used for more than just applications, such as system attachments
for trust service. For system policy set attachments, specify the provider value for the attachmentType parameter and the "[systemType trustService]" value for the -attachmentProperties parameter. For WSNClient attachments, specify the client value for the attachmentType parameter and the bus and WSNService properties with the -attachmentProperties parameter.trns
Return value
The command returns a success or failure message.
Batch example...
- Jython string:
AdminTask.updatePolicySetAttachment('[-attachmentId 123 -resources "WebService:/"]') - Use Jython list:
AdminTask.updatePolicySetAttachment(['-attachmentId', '123', '-resources', '"WebService:/"'])
Interactive example...
### Jython
AdminTask.updatePolicySetAttachment ('-interactive')
Mixed-version environment: In a mixed cell environment, not create service reference attachments or resource attachments specified in name-value pair format
for applications that are deployed on an application server that is prior to v8.0. Service
reference attachments are only supported on v8.0 and later.
New feature: In a mixed cell environment, not create attachments to policy sets containing CustomProperties policy for applications that are deployed on an application server that is prior
to WAS v8. The CustomProperties policy is only supported on WAS V8 and later.
mixv
addToPolicySetAttachment
The addToPolicySetAttachment command adds additional resources that apply to a policy set attachment.
When administrative security is enabled, verify that you use the correct administrative role:
| Administrative role | Authorization |
|---|---|
| Administrator | The Administrator role must have cell-wide access to add resources to policy set attachments. If we have access to a specific resource only, you can add resources to policy set attachments for the resource for which we have access. |
| Configurator | The Configurator role must have cell-wide access to add resources to policy set attachments. If we have access to a specific resource only, you can add resources to policy set attachments for the resource for which we have access. |
| Deployer | The Deployer role with cell-wide or resource specific access can add resources to policy set attachments for application resources only. |
| Operator | The Operator role cannot add resources to policy set attachments. |
| Monitor | The Monitor role cannot add resources to policy set attachments. |
Target object None
Required parameters
Optional parameters
For transitioning users: Even
though you can specify the application value for the -attachmentType parameter, use the provider value in place of the application value because the attachments
are used for more than just applications, such as system attachments
for trust service. For system policy set attachments, specify the provider value for the attachmentType parameter and the "[systemType trustService]" value for the -attachmentProperties parameter. For WSNClient attachments, specify the client value for the attachmentType parameter and the bus and WSNService properties with the -attachmentProperties parameter.trns
Return value
The command returns a success or failure message.
Batch example...
- Jython string:
AdminTask.addToPolicySetAttachment('[-attachmentId 123 -resources "WebService:/webapp1.war:{http://www.ibm.com}myService"]') - Use Jython list:
AdminTask.addToPolicySetAttachment(['-attachmentId', '123', '-resources', '"WebService:/webapp1.war:{http://www.ibm.com}myService"'])
Interactive example...
### Jython
AdminTask.addToPolicySetAttachment('-interactive')
Mixed-version environment: In a mixed cell environment, not create service reference attachments or resource attachments specified in name-value pair format
for applications that are deployed on an application server that is prior to v8.0. Service
reference attachments are only supported on v8.0 and later.
New feature: In a mixed cell environment, not create attachments to policy sets containing CustomProperties policy for applications that are deployed on an application server that is prior
to WAS v8. The CustomProperties policy is only supported on WAS V8 and later.
mixv
removeFromPolicySetAttachment
The removeFromPolicySetAttachment command removes resources that apply to a policy set attachment.
When administrative security is enabled, verify that you use the correct administrative role:
| Administrative role | Authorization |
|---|---|
| Administrator | The Administrator role must have cell-wide access to remove resources from policy set attachments. If we have access to a specific resource only, you can remove resources for which you have access. |
| Configurator | The Configurator role must have cell-wide access to remove resources from policy set attachments. If we have access to a specific resource only, you can remove the resource for which we have access. |
| Deployer | The Deployer role with cell-wide or resource specific access can remove resources from policy set attachments for application resources only. |
| Operator | The Operator role cannot remove resources from policy set attachments. |
| Monitor | The Monitor role cannot remove resources from policy set attachments. |
Target object None
Required parameters
Optional parameters
For transitioning users: Even
though you can specify the application value for the -attachmentType parameter, use the provider value in place of the application value because the attachments
are used for more than just applications, such as system attachments
for trust service. For system policy set attachments, specify the provider value for the attachmentType parameter and the "[systemType trustService]" value for the -attachmentProperties parameter. For WSNClient attachments, specify the client value for the attachmentType parameter and the bus and WSNService properties with the -attachmentProperties parameter.trns
Return value
The command returns a success or failure message.
Batch example...
- Jython string:
AdminTask.removeFromPolicySetAttachment('[-attachmentId 123 -resources "WebService:/webapp1.war:{http://www.ibm.com}myService"]') - Use Jython list:
AdminTask.removeFromPolicySetAttachment(['-attachmentId', '123', '-resources', '"WebService:/webapp1.war:{http://www.ibm.com}myService"'])
Interactive example...
### Jython
AdminTask.removeFromPolicySetAttachment('-interactive')
deletePolicySetAttachment
The deletePolicySetAttachment command removes a policy set attachment from an application.
When administrative security is enabled, verify that you use the correct administrative role:
| Administrative role | Authorization |
|---|---|
| Administrator | The Administrator role must have cell-wide access to delete policy set attachments. If we have access to a specific resource only, you can delete policy set attachments for the resource for which we have access. |
| Configurator | The Configurator role must have cell-wide access to delete policy set attachments. If we have access to a specific resource only, you can delete policy set attachments for the resource for which we have access. |
| Deployer | The Deployer role with cell-wide or resource specific access can delete policy set attachments for application resources only. |
| Operator | The Operator role cannot delete policy set attachments. |
| Monitor | The Monitor role cannot delete policy set attachments. |
Target object None
Required parameters
Optional parameters
For transitioning users: Even
though you can specify the application value for the -attachmentType parameter, use the provider value in place of the application value because the attachments
are used for more than just applications, such as system attachments
for trust service. For system policy set attachments, specify the provider value for the attachmentType parameter and the "[systemType trustService]" value for the -attachmentProperties parameter. For WSNClient attachments, specify the client value for the attachmentType parameter and the bus and WSNService properties with the -attachmentProperties parameter.trns
Return value
The command returns a success or failure message.
Batch example...
- Jython string:
AdminTask.deletePolicySetAttachment('[-attachmentId 123]') - Use Jython list:
AdminTask.deletePolicySetAttachment(['-attachmentId', '123'])
Interactive example...
### Jython
AdminTask.deletePolicySetAttachment('-interactive')
listAssetsAttachedToPolicySet
The listAssetsAttachedToPolicySet command lists the applications or WS-Notification service clients to which a specific policy set is attached.
If administrative security is enabled, each administrative role can list applications that are attached to policy sets.
Target object None
Required parameters
Optional parameters
Return value
The command returns a list of properties that describe each asset. Each properties object contains the assetType property, which specifies the type of asset.
Batch mode example usage
- Jython string:
AdminTask.listAssetsAttachedToPolicySet('[-policySet SecureConversation]') - Use Jython list:
AdminTask.listAssetsAttachedToPolicySet(['-policySet', 'SecureConversation'])
Interactive example...
### Jython
AdminTask.listAssetsAttachedToPolicySet('-interactive')
listAttachmentsForPolicySet
The listAttachmentsForPolicySet command lists the applications to which a specific policy set is attached.
If administrative security is enabled, each administrative role can query for policy set attachments.
Target object None
Required parameters
Optional parameters
Return value
The command returns a list of application names.
Batch example...
- Jython string:
AdminTask.listAttachmentsForPolicySet('[-policySet SecureConversation]') - Use Jython list:
AdminTask.listAttachmentsForPolicySet(['-policySet', 'SecureConversation'])
Interactive example...
### Jython
AdminTask.listAttachmentsForPolicySet('-interactive')
deleteAttachmentsForPolicySet
The deleteAttachmentsForPolicySet command removes all attachments for a specific policy set.
When administrative security is enabled, verify that you use the correct administrative role:
| Administrative role | Authorization |
|---|---|
| Administrator | The Administrator role must have cell-wide access to delete policy set attachments. If we have access to a specific resource only, you can delete policy set attachments for the resource for which we have access. |
| Configurator | The Configurator role must have cell-wide access to delete policy set attachments. If we have access to a specific resource only, you can delete policy set attachments for the resource for which we have access. |
| Deployer | The Deployer role with cell-wide or resource specific access can delete policy set attachments for application resources only. |
| Operator | The Operator role cannot delete policy set attachments. |
| Monitor | The Monitor role cannot delete policy set attachments. |
Target object None
Required parameters
Optional parameters
Return value
The command returns a success or failure message.
Batch example...
- Jython string:
AdminTask.deleteAttachmentsForPolicySet('[-policySet customSecureConversation -applicationName newApp1]') - Use Jython list:
AdminTask.deleteAttachmentsForPolicySet(['-policySet', 'customSecureConversation', '-applicationName', 'newApp1'])
Interactive example...
### Jython
AdminTask.deleteAttachmentsForPolicySet('-interactive')
transferAttachmentsForPolicySet
The transferAttachmentsForPolicySet command transfers all attachments from one policy set to another policy set.
When administrative security is enabled, verify that you use the correct administrative role:
| Administrative role | Authorization |
|---|---|
| Administrator | The Administrator role must have cell-wide access to transfer policy set attachments. If we have access to a specific resource only, you can transfer policy set attachments for the resource for which we have access. |
| Configurator | The Configurator role must have cell-wide access to transfer policy set attachments. If we have access to a specific resource only, you can transfer policy set attachments for the resource for which we have access. |
| Deployer | The Deployer role with cell-wide or resource specific access can transfer policy set attachments for application resources only. |
| Operator | The Operator role cannot transfer policy set attachments. |
| Monitor | The Monitor role cannot transfer policy set attachments. |
Target object None
Required parameters
Optional parameters
Return value
The command returns a success or failure message.
Batch example...
- Jython string:
AdminTask.transferAttachmentsForPolicySet('[-sourcePolicySet SecureConversation -destinationPolicySet customSecureConversation -applicationName newApp1]') - Use Jython list:
AdminTask.transferAttachmentsForPolicySet(['-sourcePolicySet', 'SecureConversation', '-destinationPolicySet', 'customSecureConversation', '-applicationName', 'newApp1'])
Interactive example...
### Jython
AdminTask.transferAttachmentsForPolicySet('-interactive')
listSupportedPolicySets
The listSupportedPolicySets command returns a list of supported policy sets to attach to your web services resources. If administrative security is enabled, each user role can use this command.
Target object None
Required parameters
Supported property and value pairs for the parameter are:
| Property | Value |
|---|---|
| application | Application name, such as myApplication |
| WS-Notification service client:
| Service client names:
|
| Trust service resource:
| Service resoure name:
|
| SCA business-level application resource:
| Resource names:
|
Return value
The command returns a list of supported policy sets. Each entry in the list is the name of a policy set.
Batch example...
- Jython string:
AdminTask.listSupportedPolicySets ('[-assetProps [[application myApplication]]]') - Use Jython list:
AdminTask.listSupportedPolicySets (['-assetProps', '[[bus bus1] [WSNService service1]]'])
Interactive example...
### Jython
AdminTask.listSupportedPolicySets('-interactive')
getBinding
The getBinding command returns the binding configuration for a specified policy and scope. We can use the getBinding command to return a list of available custom bindings, which includes bindings that are and are not referenced by attachments.
If administrative security is enabled, each administrative role can query for binding configuration information.
For transitioning users: In WebSphere Application Server v7.0 and later, the security model was enhanced
to a domain-centric security model instead of a server-based security model. The configuration of the default global security (cell) level and default server level bindings has also changed in this version of the product. In the WAS v6.1 Feature
Pack for Web Services, you can configure one set of default bindings for the cell and optionally configure one set of default bindings for each server. In v7.0 and later, you can configure one or more general service provider bindings and one or more general service client bindings. After we have configured general bindings, you can specify which of these bindings is the global default binding. You can also optionally specify general binding that are used as the default for an application server or a security domain. trns
To support a mixed-cell environment, WebSphere Application Server supports v7.0 and v6.1 bindings. General cell-level bindings are specific to v7.0 and later Application-specific bindings remain at the version that the application requires. When the user creates an application-specific binding, the application server determines the required binding version to use for application.
Target object None
Required parameters
Specify the bindingLocation parameter as a properties object following these guidelines:
- For WAS Version 7.0 and later server default bindings, specify a null or empty properties.
Use the bindingName parameter to identify the binding location.
- For attachment-specific bindings, specify the application name and attachment ID in the properties. The property names are application and attachmentId.
- For WSNClient bindings, specify the bus name, service name, and attachment ID in the properties. The property names are bus, WSNService, and attachmentId. If you specify an asterisk character (*) as the attachment ID, then the command returns
the list of binding names that corresponds to the attachment type of interest.
- For system/trust bindings, specify the systemType property as trustService.
Optional parameters
For transitioning users: Even
though you can specify the application value for the -attachmentType parameter, use the provider value in place of the application value because the attachments
are used for more than just applications, such as system attachments
for trust service. For system policy set attachments, specify the provider value for the attachmentType parameter and the "[systemType trustService]" value for the -attachmentProperties parameter. For WSNClient attachments, specify the client value for the attachmentType parameter and the bus and WSNService properties with the -attachmentProperties parameter.trns
Return value
The command returns a properties object that contains the requested configuration attributes for the policy binding.
Batch example...
- Jython string:
The following example returns a list of application bindings:
AdminTask.getBinding('[-policyType WSAddressing -attachmentType provider -bindingLocation [[application application_name] [attachmentId *]]]')The following example returns a list of client bindings:
AdminTask.getBinding('[-policyType WSAddressing -attachmentType client -bindingLocation [[application application_name] [attachmentId *]]]')The following example returns a list of system bindings:
AdminTask.getBinding('[-policyType WSAddressing -attachmentType provider -bindingLocation [[systemType trustService] [application application_name] [attachmentId *]]]') - Use Jython list:
AdminTask.getBinding(['-policyType', 'WSAddressing', '-bindingLocation', '""'])
Interactive example...
### Jython
AdminTask.getBinding('-interactive')
setBinding
The setBinding command updates the binding configuration for a specified policy. Use this command to add a server-specific binding, update an attachment to use a custom binding, edit binding attributes, or to remove a binding configuration.
When administrative security is enabled, verify that you use the correct administrative role:
| Administrative role | Authorization |
|---|---|
| Administrator | The Administrator role must have cell-wide access to configure bindings. If we have access to a specific resource only, you can configure custom bindings for the resource for which we have access. The Administrator role is the only role that can modify binding configurations. |
| Configurator | The Configurator role must have cell-wide access to assign and unassign bindings. If we have access to a specific resource only, you can assign and unassign bindings for the resource for which we have access. |
| Deployer | The Deployer role with cell-wide or resource specific access can assign or unassign bindings for application resources only. |
| Operator | The Operator role cannot configure bindings. |
| Monitor | The Monitor role cannot configure bindings. |
For transitioning users: In WebSphere Application Server v7.0 and later, the security model was enhanced
to a domain-centric security model instead of a server-based security model. The configuration of the default global security (cell) level and default server level bindings has also changed in this version of the product. In the WAS v6.1 Feature
Pack for Web Services, you can configure one set of default bindings for the cell and optionally configure one set of default bindings for each server. In v7.0 and later, you can configure one or more general service provider bindings and one or more general service client bindings. After we have configured general bindings, you can specify which of these bindings is the global default binding. You can also optionally specify general binding that are used as the default for an application server or a security domain. trns
To support a mixed-cell environment, WebSphere Application Server supports v7.0 and v6.1 bindings. General cell-level bindings are specific to v7.0 and later Application-specific bindings remain at the version that the application requires. When the user creates an application-specific binding, the application server determines the required binding version to use for application.
Target object None
Required parameters
Specify the bindingLocation parameter as a properties object following these guidelines:
- For WAS Version 7.0 and later server default bindings, specify a null or empty properties.
Use the bindingName parameter to identify the binding location.
- For attachment-specific, specify the application name and attachment
ID in the properties. The property names are application and attachmentId.
- For WSNClient bindings, specify the bus name, service name, and attachment ID in the properties. The property names are bus, WSNService, and attachmentId. If you specify an asterisk character (*) as the attachment ID, then the command returns
the list of binding names that corresponds to the attachment type of interest.
- For system/trust bindings, set the systemType property as trustService.
Optional parameters
For transitioning users: Even
though you can specify the application value for the -attachmentType parameter, use the provider value in place of the application value because the attachments
are used for more than just applications, such as system attachments
for trust service. For system policy set attachments, specify the provider value for the attachmentType parameter and the "[systemType trustService]" value for the -attachmentProperties parameter. For WSNClient attachments, specify the client value for the attachmentType parameter and the bus and WSNService properties with the -attachmentProperties parameter.trns
Return value
The command returns a success or failure message.
Batch example...
- Jython string:
AdminTask.setBinding('[-policyType WSAddressing -bindingLocation [[application myApplication] [attachmentId 123]] -attributes "[preventWLM false]" -attachmentType provider]') - Use Jython list:
AdminTask.setBinding(['-policyType', 'WSAddressing', '-bindingLocation', '[[application myApplication] [attachmentId 123]]', '-attributes', '[preventWLM false]', '-attachmentType', 'provider'])
Interactive example...
### Jython
AdminTask.setBinding('-interactive')
getDefaultBindings
The getDefaultBindings command displays the provider and client default bindings if the bindings are set. If the command does not return output, then the system default binding is the current default.
If administrative security is enabled, each administrative role can query for default bindings.
Target object None
Optional parameters
Return value
The command returns a properties object that contains the names of the provider and client default bindings, if the bindings are set.
Batch example...
- Jython string:
AdminTask.getDefaultBindings('[-bindingLocation [[node myNode] [server myServer]]]') - Use Jython list:
AdminTask.getDefaultBindings(['-bindingLocation', '[[node myNode] [server myServer]]'])
Interactive example...
### Jython
AdminTask.getDefaultBindings('-interactive')
getRequiredBindingVersion
The getRequiredBindingVersion command displays the version number of the binding for a specific application.
Target object None
Optional parameters
Return value
The command returns the binding version number as a number, such as 7.0.0.0 or 6.1.0.0.
Batch example...
- Jython string:
AdminTask.getRequiredBindingVersion('[-assetProps [[application myApplication]]]') - Use Jython list:
AdminTask.getRequiredBindingVersion(['-assetProps', '[[application myApplication]]'])
Interactive example...
### Jython
AdminTask.getRequiredBindingVersion('-interactive')
setDefaultBindings
The setDefaultBindings command to set a binding as the default binding.
If administrative security is enabled, use the Administrator role with cell-wide access to configure bindings. If you use the Administrator role and do not have cell-wide access, you can only configure bindings on resources for which we have access.
Target object None
Required parameters
Optional parameters
Return value
The command returns a value of true if the command successfully sets the default binding.
Batch example...
- Jython string:
AdminTask.setDefaultBindings('[-defaultBindings [[provider myDefaultProviderBinding] [client myDefaultClientBinding]] -bindingLocation [[node myNode] [server myServer]]]') - Use Jython list:
AdminTask.setDefaultBindings(['-defaultBindings', '[[provider myDefaultProviderBinding' [client myDefaultClientBinding]]', '-bindingLocation', '[[node myNode] [server myServer]]'])
Interactive example...
### Jython
AdminTask.setDefaultBindings('-interactive')
exportBinding
The exportBinding command export a general, cell-level binding to an archive file. We can copy this file to a client environment or import the archive to a server environment.
If administrative security is enabled, use the Administrator role with cell-wide access to export bindings.
Target object None
Required parameters
Return value
The command returns a success or failure message.
Batch example...
- Jython string:
AdminTask.exportBinding('[-bindingName myDefaultBinding -pathName C:/IBM/WebSphere/AppServer/PolicySets/Bindings/]') - Use Jython list:
AdminTask.exportBinding(['-bindingName', 'myDefaultBinding', '-pathName', 'C:/IBM/WebSphere/AppServer/PolicySets/Bindings/'])
Interactive example...
### Jython
AdminTask.exportBinding('-interactive')
importBinding
The importBinding command imports a general, cell-level binding from a compressed archive file to a server environment.
If administrative security is enabled, use the Administrator role with cell-wide access to import bindings.
Target object None
Required parameters
Optional parameters
Return value
The command returns a success or failure message.
Batch example...
- Jython string:
AdminTask.importBinding('[-bindingName myDefaultBinding -pathName C:/IBM/WebSphere/AppServer/PolicySets/Bindings/myBinding.ear]') - Use Jython list:
AdminTask.importBinding(['-bindingName', 'myDefaultBinding', '-pathName', 'C:/IBM/WebSphere/AppServer/PolicySets/Bindings/myBinding.ear'])
Interactive example...
### Jython
AdminTask.importBinding('-interactive')
copyBinding
The copyBinding command creates a new general, cell-level binding from an existing binding.
If administrative security is enabled, use the Administrator role with cell-wide access to copy bindings.
Target object None
Required parameters
Optional parameters
Return value
The command returns a success or failure message.
Batch example...
- Jython string:
AdminTask.copyBinding('[-sourceBinding mySourceBinding -newBinding mySourceCopyBinding]') - Use Jython list:
AdminTask.copyBinding(['-sourceBinding', 'mySourceBinding', '-newBinding', 'mySourceCopyBinding'])
Interactive example...
- Use Jython list:
AdminTask.copyBinding('-interactive')
upgradeBindings
The upgradeBindings command upgrades application bindings for a specific asset to the latest version.
If administrative security is enabled, you must use the Administrator role with cell-wide access to import bindings.
Target object None
Required parameters
Optional parameters None
Return value
The command returns a success or failure message.
Batch mode example usage
- Jython string:
AdminTask.upgradeBindings('[-assetProps [[application myApplication]]]') - Use Jython list:
AdminTask.upgradeBindings(['-assetProps', '[[application myApplication]]'])
Interactive example...
### Jython
AdminTask.upgradeBindings('-interactive')
Web services policy sets
Configure application and system policy sets for web services using wsadmin.sh
Create policy sets using wsadmin.sh
Add and remove policies using wsadmin.sh
Delete policy sets using wsadmin.sh
Create policy set attachments using wsadmin
Manage policy set attachments using wsadmin
Manage policy set attachments for service references using wsadmin
Remove policy set attachments using wsadmin
Related
Policy configuration properties for all policies