|
|
|
You can use the $RMDBAPI procedure to manage your file transfer resource definitions. The $RMDBAPI lets you:
The API can be used in an NCL procedure or as a command.
You can copy a resource definition using the SERVICE=GET and SERVICE=CREATE operands. Use the GET operand to retrieve information about a resource definition. The retrieved values are stored in the &ZRMDB-prefixed variables. To copy the resource definition, use the CREATE operand and specify a new name for the definition.
You cannot directly update existing resource definitions using the API. You can create a new resource, including any updates required, and then delete the old resource. If you delete a rule set, the rules in the rule set are also deleted. If the rule set is active, the request is rejected.
Use this call to change the status of a file transfer rule in a region to ACTIVE or INACTIVE. The region acts on the rule if the rule belongs to the loaded file transfer rule set.
This command has the following format:
$RMDBAPI SERVICE={ACTIVATE | INACTIVATE}
RSNAME=ft-ruleset-name RMNAME=ft-rule-name
Indicates that status of the specified file transfer rule, ft-rule-name, be changed as follows:
Changes the rule status to ACTIVE.
Changes the rule status to INACTIVE.
Specifies the name of the file transfer rule set to which the specified rule, ft-rule-name, belongs.
Specifies the name of the file transfer rule to which the service applies.
Returned Variable
Contains the message returned by $RMDBAPI.
Return Codes
The following return codes indicate the success or failure of the status change processing:
Processing successful.
Processing failed.
Error occurred in call syntax.
Example
The following example changes the status of the CD40FAIL rule in the CDFAIL file transfer rule set to ACTIVE:
&CALL PROC=$RMDBAPI + PARMS=(SERVICE=ACTIVATE,+ RSNAME=CDFAIL,RMNAME=CD40FAIL)
Use this call to maintain ResourceView definitions in the knowledge base.
This command has the following format:
$RMDBAPI SERVICE={CREATE | DELETE | GET | LIST | SET}
[TRUNCATE={YES|NO}]
[{NAME=resource-name[MANNAME=manager-name]}|
{RSNAME=ft-ruleset-name[RMNAME=ft-rule-name]}]
CLASS=cc
[SYSNAME=system-name]
[VERSION=version]
[field-name-1=field value-1]
[field-name-2=field value-2]
.
.
.
[field-name-n=field value-n]
Note: The next section lists the values for the field-name-n operands that are specific to CA NetMaster FTM. For more information about the operands, see the Reference Guide.
The following sections list the product specific field names.
The names are related to the corresponding field labels on the appropriate definition panels:
This table lists the product specific resource field names that can be used in the $RMDBAPI procedure.
|
Field Names |
Field Label on Panel |
|---|---|
|
General Description |
|
|
IPADDR |
TCP/IP Host Name/Addr |
|
IPPORT |
Agent Port Number |
|
Monitor Details |
|
|
HBACT |
Active Transfer Request Monitors Heartbeat Interval |
|
HBEATIN |
Heartbeat Interval |
|
HBINACT |
Inactive Transfer Request Monitors Heartbeat Interval |
|
Auto Connect Queue Monitor Details |
|
|
QDEPTH |
Queue Depth Threshold |
|
LISTNM1 to LISTNM5 |
List Names |
|
BSC Line Monitor Details |
|
|
QDEPTH |
Queue Depth Threshold |
|
AUTORES |
Automatic Restart? |
|
LINENM1 to LINENM5 |
Line Names |
|
File Transfer Monitor Details |
|
|
IDLEALT |
Stalled Time to Alert |
|
IDLEDRP |
Stalled Time to Flush |
|
QDEST1 to QDEST5 |
Destination Nodes |
|
QPNAME1 to QPNAME5 |
Process Names |
|
Link Monitor Details |
|
|
LINKNME |
Link Name |
|
Queue Monitor Details |
|
|
QTYPE |
Queue Type |
|
QDEPTH |
Queue Depth Threshold |
|
QSTATUS |
Process Status |
|
QDEST1 to QDEST5 |
Destination Nodes |
|
QPNAME1 to QPNAME5 |
Process Names |
|
Remote Node Monitor Details |
|
|
RMSNNDE |
Remote Node LU name (CA XCOM Data Transport for z/OS) |
|
RMIPNDE |
Remote Node TCP/IP Host Name/Addr (CA XCOM Data Transport for z/OS) |
|
REMNODE |
Remote Node Name (CONNECT:Direct) |
|
IPADDR |
TCP/IP Host Name/Addr (FTP) |
|
IPPORT |
TCP/IP Port Number (FTP) |
|
TIMEOUT |
Timeout After (FTP) |
|
SNA Session Monitor Details |
|
|
IDLEALT |
Stalled Time to Alert |
|
RMTNM1 to RMTNM5 |
Remote Names |
|
Stalled Monitor Details |
|
|
IDLEALT |
Stalled Time to Alert |
|
IDLEDRP |
Stalled Time to Terminate |
|
TRID1 to TRID5 |
Transfer Request ID |
|
SERV1 to SERV5 |
Remote Server |
|
TCP/IP Connection Monitor Details |
|
|
IDLEALT |
Idle Time to Alert |
|
IDLEDRP |
Idle Time to Drop |
|
TCP/IP Listener Task Monitor Details |
|
|
LRETRYA |
Retry Attempts |
|
LRETRYI |
Retry Interval |
|
IPPORT |
CONNECT:Direct Port No |
|
COMMUNE |
SNMP Community Name |
|
Transfer Request Monitor Details |
|
|
TRSTATS |
Transfer Request Status |
|
TRDEPTH |
Transfer Request Threshold |
|
TRID1 to TRID5 |
Transfer Request ID |
|
SERV1 to SERV5 |
Remote Server |
|
FT Schedule |
|
|
CRIT1 to CRIT97 |
Day/Date or Criteria Name |
|
TIME1 to TIME97 |
Start Time |
|
PREP1 to PREP97 |
Pre-Processing Period |
|
PROC1 to PROC97 |
Processing Period |
|
POST1 to POST97 |
Post-Processing Period |
|
LONG1 to LONG97 |
Longest Transfer |
|
File Filters |
|
|
FILE1 to FILE97 |
File Name/Transfer ID |
|
TYPE1 to TYPE97 |
Type |
|
FNUM1 to FNUM97 |
Number |
|
Extended File Filter |
|
|
SRC1 to SRC97 |
Source System/Node |
|
TGT1 to TGT97 |
Target System/Node |
|
MIN1 to MIN97 |
Minimum File Size (In Bytes) |
|
MAX1 to MAX97 |
Maximum File Size (In Bytes) |
|
State Change Exits |
|
|
STRPREX |
Start of Pre-Processing |
|
STRPRCX |
Start of Processing |
|
LNGXFRX |
Longest Transfer Exceeded |
|
ENDCMPX |
End of Processing: All Transfers Complete |
|
ENDINCX |
End of Processing: All Transfers not Complete |
|
ENDPOSX |
End of Post-Processing |
|
Define Exit Parameters |
|
|
STRPRE1 to STRPRE2 |
Parameters (for STRPREX) |
|
STRPRC1 to STRPRC2 |
Parameters (for STRPRCX) |
|
LNGXFR1 to LNGXFR2 |
Parameters (for LNGXFRX) |
|
ENDCMP1 to ENDCMP2 |
Parameters (for ENDCMPX) |
|
ENDINC1 to ENDINC2 |
Parameters (for ENDINCX) |
|
ENDPOS1 to ENDPOS2 |
Parameters (for ENDPOSX) |
|
Event Exits |
|
|
ASTARTEX |
All Transfer Started |
|
ACOMPLEX |
All Transfer Completed |
|
FAILUREX |
Transfer Failure |
|
Define Exit Parameters |
|
|
ASTARTP1 to ASTARTP2 |
Parameters (for ASTARTEX) |
|
ACOMPLP1 to ACOMPLP2 |
Parameters (for ACOMPLEX) |
|
FAILURP1 to FAILURP2 |
Parameters (for FAILUREX) |
|
Additional Details |
|
|
ADDDET1 to ADDDET16 |
Additional Details |
This table lists the file transfer rule set field names that can be used in the $RMDBAPI procedure.
|
Field Name |
Field Label on Panel |
|
File Transfer Rule Set |
|
|
SDESC |
Description |
This table lists the file transfer rule field names that can be used in the $RMDBAPI procedure.
|
Field Names |
Field Label on Panel |
|---|---|
|
File Transfer Rule Filter |
|
|
RSTAT |
Rule Status |
|
SDESC |
Description |
|
PFNAME |
FileName/TransferID |
|
SRCTGT |
File Type |
|
TSTAT |
Transfer Status |
|
SVRTY |
Alert Severity |
|
AUTOCLR |
Alert Autoclear |
|
L1 to L10 |
( |
|
FLD1 to FLD10 |
Field |
|
O1 to O10 |
Opr |
|
VAL1 to VAL10 |
Value (field value must not contain the tilde (~) character) |
|
G1 to G10 |
Gen |
|
R1 to R10 |
) |
|
B1 to B10 |
Bool |
|
Alert Automated Actions |
|
|
Note: The maximum size of an Actions record is 12500 bytes, which may reduce the actual number of actions (n) that can be added to a file transfer rule. |
|
|
Important! You must use the ALACTn names in sequence (for example, ALACT1, ALACT2, ALACT3, …). If you break the sequence, the names following the break are ignored. For example, if you specify ALACT1 and ALACT3 but do not specify ALACT2, ALACT3 is ignored. |
|
|
ALACT1 to ALACT99 |
Automation_Services_Process |
|
ALDSC1 to ALDSCn |
Short Description |
|
For Automation_Services_Process only |
|
|
ALPRCn |
Process |
|
ALPRSn |
Parameters |
|
For AUTO_TROUBLE_TICKET only |
|
|
ALUTmn and ALUVmn |
FIELD NAME= and VALUE= on Alert Monitor : Trouble Ticket Data Entry Definition panel |
|
Note: m is 1 to 9, identifying up to nine FIELD NAME-VALUE pairs for each action. You must use m in sequence. Use these operands to override the values already implemented in the region. |
|
|
For NOTIFY only |
|
|
ALUI1n to ALUI2n |
Notify |
|
ALTX1n to ALTX4n |
Text |
|
For RUN_COMMAND only |
|
|
ALCMDn |
Command & Parameters |
|
ALPR1n |
Command Parameters |
|
For RUN_NCL only |
|
|
ALPRNn |
Procedure Name |
|
ALPR1n to ALPR5n |
Parameter |
|
Alert Definition for File Transfer Rule |
|
|
Note: The region assigns default values for these fields when an alert is generated. You can override these default values. |
|
|
ADRES |
Resource Name |
|
ADDESC |
Alert Description |
|
Note: The API treats ADTXTn and ADRACTn as blocks of data. If used, the values are overridden as blocks, not line by line. For example, if you specify ADTXT1 only, ADTXT2 to ADTXT5 will display as blank lines. |
|
|
ADTXT1 to ADTXT5 |
Alert Text |
|
ADRACT1 to ADRACT4 |
Alert Recommended Action |
| Copyright © 2010 CA. All rights reserved. |
|