4.155 chg-uaps

Use this command to change the UA parameter set.

Parameters

set (mandatory)
UA parameter set to be changed.
Range:
1 - 9
Default:
No change to the current value
parm (optional)
Parameter number.
Range:
1 - 10

1 —ASP SNM Options

2—ASP/AS Notification Options

3—UA Serviceability Options

4-10—Unused

Default:
No change to the current value
pvalue (optional)
If the parm parameter is specified, then this parameter specifies the numerical value that the parm parameter will be set to. Each parameter value is 32 bits (decimal 4294967295); not all 32 bits are used for each parameter. Only the values of the used bits are evaluated to determine the parameter value.

If the default setting for one bit is ON and you want to turn ON another bit in addition, specify the value that turns both bits ON. To turn OFF a bit that is ON and leave other bits ON, specify the value that turns ON just the bits that you want to be on. See the Notes section for this command for an explanation of the meanings of the bit settings.

Range:
0 - 4294967295

Enter a valid decimal or hexadecimal value shown in Table 4-20 for the pvalue parameter to be used for the specified parm parameter.

Table 4-20 Valid and Default UAPS Parameter Values

Parameter (parm) To Turn On Only Bit(s) Decimal pvalue Hexadecimal pvalue System Default

1. ASP SNM Options

Bit 0= Broadcast

Bit 1= Response Method

Bit 6 = Broadcast Congestion Status Change

Bits 2-5 and 7-31= Unused

0

1

h’1

1

2

h’2

6

64

h’40

Off

0, 1

3

h’3

On

0, 6

65

h’41

1, 6

66

h’42

0, 1, 6

67

h’43

2. ASP/AS Notification Options

Bit 0= ASP ACTIVE Notifications

Bit 1= ASP INACTIVE Notifications

Bit 2 = ASP AS State Query

Bits 3-31 = Unused

1

h’1

1

2

h’2

2

4

h’4

0, 1

3

h’3

0, 2

5

h’5

1, 2

6

h’6

0, 1, 2

7

h’7

Off

3. UA Serviceability Options

Bit 0 = UA Heartbeats

Bit 1 = UA Graceful Shutdown

Bits 2-31 = Unused

0

1

0,1

1

2

3

h’1

h'2

h'3

Off

Off

Off

4. SCTP Payload Protocol Indicator Option

Bit 0 = Payload Protocol Indicator

Bits 1-31 = Unused

0

1

h'1

Off

Default:
No change to the current value
srcset (optional)
When specified, this source UAPS will be copied into the specified UAPS (set).
Range:
1 - 10
Default:
Empty
timer (optional)
Timer number within the UA parameter set.
Range:
1 - 10

1 —Unused

2—False IP Connection Congestion Timer

3—UA Heartbeat Period Timer

4—UA Heartbeat Received Timer

5-10—Unused

Default:
No change to the current value
tvalue (optional)
The value given to a timer in milliseconds. Each timer value is 32 bits (decimal 4294967295).
Range:
0 - 60000

Timer 2—0-30000

Timer 3—100-60000

Timer 4—100-10000

If the value specified is greater than the maximum range of the timer, then the maximum value of the timer is used.

Default:
No change to the current value
System Default:

Timer 2 -3000

Timer 3 -10000

Timer 4 -5000

Example

The following example copies UA parameter set 1 into UA parameter set 2.

chg-uaps:set=2:srcset=1

The following example sets the Timer 2 value to 30 milliseconds.

chg-uaps:set=1:timer=2:tvalue=30

The following example sets the UA parameter set 2 value to hexadecimal 7, which turns on bits 0, 1, and 2.

chg-uaps:set=1:parm=2:pvalue=h’7

The following example sets the Timer 2 value to 30 milliseconds, and sets the value for UA parameter set 1 to decimal 64, which turns OFF bits 0 and 1 and turns ON only bit 6.

chg-uaps:set=2:timer=2:tvalue=30:parm=1:pvalue=64

Dependencies

The srcset and set parameter values cannot be the same.

At least one of the timer, parm, and srcset optional parameters must be entered.

If the srcset parameter is specified, no other optional parameters can be entered in the command.

If the parm parameter is specified, the pvalue parameter must be specified.

If the timer parameter is specified, the tvalue parameter must be specified.

Notes

There are 10 UA parameter sets. Each UA parameter set has 10 timers and 10 optional bit-mapped parameters. The bit-mapped parameter values control SNM and extended UA notification message behavior.

Timer 2 is the False IP Connection Congestion Timer, which controls the maximum amount of time (in milliseconds) that an association is allowed to remain congested before failing due to false connection congestion. This timer value is limited to 0-30,000 milliseconds by the IPGWx application. The default value is 3000 milliseconds. This timer is not supported on the IPSG application.

Timer 3 is the UA Heartbeat Period Timer, which controls the time (in milliseconds) between sending of BEAT messages by the NE. This timer value is limited to 100-60,000 milliseconds by the IPSG and IPGWx applications. The default value is 10,000 milliseconds.

Timer 4 is the UA Heartbeat Received Timer, which controls the timeout period for response BEAT ACK messages by the NE. This timer value is limited to 100-10,000 milliseconds by the IPSG and IPGWx applications. The default value is 5000 milliseconds.

The bit-mapped parameters contain the following flags, which are set by using the pvalue parameter to turn the bits on or off in each bit map:

  • Broadcast —Controls broadcast phase SNM TFPs, TFRs and TFAs sent when a destination’s status changes. If this flag is on (set to 1), SNM TFPs, TFRs, and TFAs will be broadcast to all associations and sockets assigned to routing keys associated with the destination’s network and group code. The default is to enable all broadcast phase messages.
  • Response Method —Sending a SNM TFC/UPU as a reply to a message received on an association or a socket for an unavailable destination. If this bit is on (set to 1), the SNM response message is sent. The default is to allow the response to be sent.
  • Broadcast Congestion Status Change —Controls sending unsolicited congestion status changes. If this flag is on (set to 1) for an ASP, unsolicited congestion status messages are sent by the ASP when a destination’s congestion status changes. This flag is applicable only if, ipgwabate has been turned on with the chg-sg-opts command. The default is do not generate unsolicited congestion status changes.
  • ASP ACTIVE Notifications—Controls sending ASP-Active notifications. If this flag is on (set to 1), the Secure Gateway will, when an ASP transitions to Active, send a Notify message to all inactive and active ASPs in the AS of status type "Other" and a newly defined status ID of "ASP Activation". The ASP Activation notification message will include the ASP ID of the ASP that activated, and is transmitted only if the ASP ID is present. This notification is an extension to RFC3332 and not implemented for M3UA Version 8 adapters. The default is do not send ASP Active Notifications.
  • ASP INACTIVE Notifications—Controls sending ASP-Inactive notifications. If this flag is on (set to 1), the Secure Gateway will, when an ASP transitions to Inactive, send a Notify message to all inactive and active ASPs in the AS of status type "Other" and a newly defined status ID of "ASP Inactivation". The ASP Inactivation notification message will include the ASP ID of the ASP that inactivated and is transmitted only if the ASP ID is present. This notification is an extension to RFC3332 and not implemented for M3UA Version 8 adapters. The default is do not send ASP Inactive Notifications.
  • ASP AS State Query—Controls sending ASP/AS State Notifications on request by ASP. If this flag is on (set to 1), the Secure Gateway will respond with ASP and AS state notifications if 1) the remote ASP sends ASP-UP or ASP-INACTIVE while the local ASP is in the ASP-INACTIVE state, or 2) the remote ASP sends ASP-ACTIVE while the local ASP is in the ASP-ACTIVE state. The default is do not send state notifications.
  • UA Heartbeats—Controls sending UA Heartbeats on request by a connection. If this flag is on (set to 1), Heartbeat messages are transmitted in the ASP-DOWN, ASP-ACTIVE and ASP-INACTIVE States on connections from the Secure Gateway to the far end.
  • UA Graceful Shutdown—Controls whether an association should be shutdown gracefully or not. If this flag is on (set to 1), then a graceful shutdown will occur when OPEN=NO is executed on the server side.  Otherwise, the association will abort when OPEN=NO is executed.
  • SCTP Payload Protocol Indicator byte order option—Indicates whether the SCTP Payload Protocol Indicator (PPI) in received/transmitted messages is in big endian or little endian byte format. If this flag is on (set to 1), then the PPI in received/transmitted messages is little endian. Otherwise, the PPI is in big endian byte format. This flag is implemented only on IPSG M2PA associations; all other association types ignore the flag.

Output

chg-uaps:set=2:srcset=1 

    rlghncxa03w 02-03-07 11:11:28 EST EAGLE 30.0.0
    CHG-UAPS: MASP A - COMPLTD 
;

Related Topics