Set

Sets a parameter.

• set acl [<cfgname>/]<aclName> <list of roles> [-noverify|-verify] [-append|-replace|-remove]

  Security in iWay Service Manager (iSM) is managed by Access Control Lists (ACLs), which are described in the iWay Service Manager Security Guide. With ACLs, users are assigned roles that are associated with permissions. The set acl command sets roles for a specified ACL. The list of available ACLs can be seen by using the show acl command. The roles associated with the ACL are assigned to a user by values in an authentication realm. The following table lists and describes the switches that are supported by the set acl command:

  Switch	Description
  -append	Adds the role(s) to the ones already associated with the ACL. If a configuration is specified (for example, myconfig/cmdstart), then the configuration will be added if it does not exist in the security file.
  -replace	Replace the existing roles with the new roles.
  -remove	Removes the listed roles from the ACL.
  -verify	Checks the integrity of the security file holding the roles. This is the default.
  -noverify	Indicates not to check the integrity of the security file holding the roles.

  Example:

  In this example, the cmdstart and cmdstop permissions are added to the operator role in the testsys application.

  set acl testsys/operator cmdstart cmdstop

  The operator role is assigned to the user in the selected authentication realms, such as LDAP.

  The configuration parameter can also be a regular expression if required. This enables the role to apply to a class of configurations based on a naming convention. For example, if development servers end with D, production servers with P, and quality assurance servers with Q, then a role might be assigned as follows:

  set acl .Q/monitor  monitor -append

• set active on | off

  Sets the active status of the named channel/listener. An active channel starts automatically when the server is started, and starts in response to a start all command.

• set appcmd name 'command' [parms]

  Creates a user command. For more information, see User Commands.

• set cmdstatus on | off

  Causes the command handler to mark each subsequent command with a notice of success or failure. Commands that complete successfully are marked with IWAY0000 OK. Failures are marked with IWAY9999 Failed. The failing line is prefixed with [fail]. Users are cautioned that when using automated scripts, not to count on the exact 9999 number. That number may vary in the future. A value of 0000 will always denote success.

• set display

  Shows the current settings.

• Set passive on | off -m name

  Sets the passivation state of the named channel. A passivated channel remains started, but temporarily ceases to acquire messages until it is reactivated. This functionality is used to throttle performance. Only some protocols support passivation. Passive state is controlled internally by High Water Mark (HWM) detection in some listeners.

• set pflowdebug on | off [-m <channelname>]

  Debug nodes in process flows that normally execute only for process flows running in iIT tests if the Debug mode property is set for the process flow. During normal flow execution in a channel, the nodes are ignored. Using this command instructs the debug nodes to execute during a normal channel operation. This property can only be set through the command console and cannot be saved. Users are cautioned that enabling the process flow debug state can significantly impact system performance.

• set policy [<cfgname>/]<policyName> <value> [-noverify]

  Sets the named policy to the required value. The -noverify flag avoids the check for signatures on the checking side, and can only be used with administrative authority.

• set property <file> <name> <value> [-encrypt | -aes <key> [-keylength <length>]]

  Sets the named property in the property file. The file name is expected to end with the .properties extension and this suffix will be supplied if required. The file will be created if it does not exist. The value is evaluated as iFL, which facilitates setting values that have been encrypted or taken from other portions of the system. The -encrypt keyword will encrypt the property value using an iSM salted masking algorithm.

  The -aes keyword uses the provided key to encrypt the value. Advanced Encryption Standard (AES) is a strong encryption standard. The key must be 16 characters or less, as it becomes a 128-bit key. The keylength for AES can be 128 (default), 192, or 256. To use key lengths greater than 128, the appropriate Java policy files must be available.

  For example:

  set property testproperty userpswd mypassword -aes iwaykey1

  If the key value is stored in a Special Register (SREG), which is the usual practice, named for the secretkey sample, the command would be structured as follows:

  set property testproperty userpswd mypassword -aes _sreg(secretkey)

  Either method would generate a properties file called testproperty.properties, which is structured as follows:

  #Saved by set property command
  #Fri Jan 24 14:52:29 EST 2014
  userpswd=A8vRBNezksAtoySgaFbOygkuMeYqmIy6v9GsIwU6K60\=

  The value can be read using standard iFL functions in the specific operand or command. For example:

  _aes('decrypt',_sreg(secretkey),_property('testproperty','userpswd'))

  This example generates mypassword for use in the process execution.

  For more information, see Keeping Secret Values in the iWay Service Manager Security Guide.

• Set qa on|off

  QA (Quality Assurance) mode is used during application testing to facilitate tests. For example, it causes timestamps in XML documents to be replaced with a constant to assist during message compares.

• set register <name> [<value>][-switches] [-delete]

  Sets a configuration register to a specified value. Configuration registers are those shown in the sregs command a Global manager. You cannot change the value of any of the built in registers, but you can add your own. The value of the register is ascertained when the register is accessed by the server; for example changing a value used to configure a channel will not affect that channel until it is restarted.

  Note: One register can depend on another. If the new register depends on the value of another register, that register must have been created before the dependent register. Also, you can start the iFL value with the defer character (`) to signify that the value is to be determined at the time of lookup. For typed registers, a constant value at set time is checked.

  Value	Description
  -secure	The value is to be encrypted. Use this for passwords.
  -defer	The value is determined at lookup time. Use this for an iFL to be evaluated each time that the value is obtained.
  -delete	Delete the register.
  -string	Default. The register value is string.
  -integer	The register value is an integer.
  -float	The register value is a floating point number.
  -double or -real	The register value is a double precision floating point number.

• Set retryinterval duration [-save]

  During channel startup, a failure (for example, MQ is unable to reach a queue manager) that prevents the channel from starting will cause the channel to be queued for retry in a set period. The duration is specified in seconds. If -save is used, then the configuration is permanently changed. The default duration is 30 seconds. The retry interval is a server property, and affects all channels. Channels that fail to start due to a configuration error will not be retried.

• set time on|off

  Adds the current time to all traces displayed at the console.

• set <tracelevel> on|off [-save] [-master <name>]

  Sets a trace level. The trace level change can be saved in the dictionary such that it becomes permanent. A setting can be applied to a single master/channel by name, but master-level settings cannot be saved.

  Note: The name of the console is "console". You can set trace levels for the console as -master console. By default, regardless of the specific trace level settings for other channels, during iSM startup, the console traces only error and warning level messages. You can change this behavior using the Console Settings page. For more information, see BAD XREF HERE "Console Settings.

• set unique <pattern>[value]

  Sets or resets the unique [file] name index. The unique file name pattern is used to generate unique names. For example, the following file name resets the value used for the pattern to zero:

  set unique c:/fileout/file###.xml

  set unique "c:/Program Files/config/base/output/ib####.txt" 50

  The set affects use of the pattern both for the unique file name generation (for example, in the file emitter) and in the _unq() iFL command. The value must fall within the modulus of the pattern size; for example, setting the value of the above pattern to 1000 is not accepted.

  This command might be scheduled to automatically reset the value at midnight each day (requires installation of the iSM scheduling component,).

  Note that the example with a pattern name enclosed the pattern in quotes. This is because it contained a blank in the pattern (file) name.