Space announcement This documentation space provides the same content as before, but the organization of the content has changed. The content is now organized based on logical branches instead of legacy book titles. We hope that the new structure will help you quickly find the content that you need.

zAdviser parameters

CWGLxxxx and LMCLxxxx members

The CWGLxxxx parameter member contains parameters for both zAdviser APIs: 

  • The CMSC API is currently used by legacy BMC AMI products such as AMI Ops Automation and zAdviser to be used without BMC AMI License Management System (LMS).
  • The LMS API is used by legacy BMC AMI DevX products such as Abend-AID and File-AID.

The following parameters in the CWGLxxxx member apply only to the CMSC API:

  • ZADVISER_SMF_ID
  • SMF

The remaining ZADVISER parameters in the CWGLxxxx member apply to both APIs:

  • ZADVISER
  • ZADVISER_SMF_VERSION
  • ZADVISER_SMF_BUFF_INT
  • ZADVISER_QUEUE_ENTRIES
  • ZADVISER_DEST
  • ZADVISER_TENANT_ID
  • ZADVISER_PROXY
  • ZADVISER_PROXY_IP
  • ZADVISER_PROXY_PORT
  • ZADVISER_ONPREM_IP
  • ZADVISER_ONPREM_PORT

Parameters in the LMCLxxxx member apply only to LMS, including the LMS zAdviser API.

The SMF record number written by the CMSC API is specified on the ZADVISER_SMF_ID parameter in the CWGLxxxx member.  The default for this parameter is 241. 

The SMF record number written by the LMS API is specified on the SMF_ID parameter in the LMCLxxxx member.  The default for this parameter is also 241.  However, in addition to writing SMF records for zAdviser, LMS writes SMF records for other purposes.

If you want to use zAdviser, and have both legacy BMC AMI products and legacy BMC AMI DevX (formerly known as BMC Compuware) products, you must specify the same SMF record ID on both the ZADVISER_SMF_ID parameter in CWGLxxxx, and the SMF_ID parameter in the LMCLxxxx member if you want the same SMF record type written by both APIs.Since the default for the ZADVISER_SMF_ID parameter in the CWGLxxxx member and the SMF_ID parameter in the LMCLxxxx member is 241, a new parameter was introduced to both members to prevent SMF records from being written by the CMSC zAdviser API and by LMS.  This parameter in both members is SMF.  The values that may be specified are YES and NO, with the default being YES.  SMF=NO will prevent SMF records from being written. 

While this parameter is used by both APIs, since SMF records are written by LMS for reasons in addition to zAdviser, interaction of this parameter with the SMF parameter is different.

  • The CMSC API
    • SMF=YES specified or defaulted
      • ZADVISER=YES – zAdviser records sent to AWS and written to SMF.
      • ZADVISER=NO – zAdviser records are written only to SMF. If the default of 241 is taken for ZADVISER_SMF_ID, SMF type 241 records will be written.
      • ZADVISER=ONLY – zAdviser records are sent to AWS.
      • ZADVISER=ON_PREM – zAdviser records are sent to ON_PREM and written to SMF - NEW.
    • SMF=NO specified
      • ZADVISER=YES – zAdviser records are sent to AWS.
      • ZADVISER=NO – No zAdviser records are sent to AWS or written to SMF.
      • ZADVISER=ONLY – zAdviser records are sent to AWS
      • ZADVISER=ON_PREM - zAdviser records sent to ON_PREM
  • The LMS API
    • SMF=YES specified or defaulted
      • ZADVISER=YES – zAdviser records sent to AWS and written to SMF, and non-zAdviser LMS records are written. If the default of 241 is taken for SMF_ID, SMF type 241 records will be written.
      • ZADVISER=NO – zAdviser records are written only to SMF, and non-zAdviser LMS records are written. If the default of 241 is taken for SMF_ID, SMF type 241 records will be written for both zAdviser and non-zAdviser.
      • ZADVISER=ONLY – zAdviser records are sent to AWS. Non-zAdviser SMF records will be written.  If the default of 241 is taken for SMF_ID, SMF type 241 records will be written.
      • ZADVISER=ON_PREM – zAdviser records are sent to ON_PREM and written to SMF, and non-zAdviser LMS records are written. If the default of 241 is taken for SMF_ID, SMF type 241 records will be written.
    • SMF=NO specified
      • ZADVISER=YES – zAdviser records are sent to AWS, and no SMF records (zAdviser or non-zAdviser) will be written.
      • ZADVISER=NO – No zAdviser records are sent to AWS, and no SMF records (zAdviser or non-zAdviser) will be written.
      • ZADVISER=ONLY – zAdviser records are sent to AWS, and no SMF records (zAdviser or non-zAdviser) will be written.
      • ZADVISER=ON_PREM – zAdviser records are sent to ON_PREM, and no SMF records (zAdviser or non-zAdviser) will be written.

The ZADVISER_DEST parameter in the CWGLxxxx member indicates the endpoint where zAdviser will write data. The default for this value is DFLT which uses an endpoint of https://zadviser.api.bmc.com:443/inbound.

Use the CWGLxxxx member ZADVISER_TENANT_ID if you want to specify an ID instead of using your own customer ID for sending zADVISER data. 

A zAdviser proxy server can be configured using the CWGLxxxx members ZADVISER_PROXY to specify the hostname, ZADVISER_PROXY_IP to specify the IP, and ZADVISER_PROXY_PORT for the port number.

A zAdviser ON_PREM endpoint can be configured using the following CWGLxxxx members:

  • ZADVISER=ON_PREM to specify the data that has to be gathered within the company environment
  • ZADVISER_ONPREM_IP to specify the IP
  • ZADVISER_ONPREM_PORT for the port number

Important

ZADVISER_PROXY parameters and ZADVISER_ONPREM parameters are mutually exclusive. When ZADVISER=ON_PREM ,only ZADVISER_ONPREM_IP and PORT are valid. If any PROXY related parm is present the product will throw an informational message stating mutually exclusive. 

Example

MSCSC0150I  ZAD0101E MUTUALLY EXCLUSIVE PARAMETERS SPECIFIED:                   
MSCSC0150I  ZAD0100E ON_PREM AND ZADVISER PROXY OR PORT OR IP IS INVALID       

The ZADVISER parameter in the CWGLxxxx member informs each API how zAdviser requests are to be handled.  Valid values for this parameter are YES, NO, ONLY and ON_PREM:

  • YES writes records to both zAdviser and SMF
  • NO writes records to SMF
  • ONLY writes records to only zAdviser
  • ON_PREM writes records to both zAdviser ON_PREM and SMF

For more information on zAdviser parameters, see Configuring-Global-Parameters.

Examples

Example 1: Legacy BMC Customer with No Legacy BMC AMI DevX products Sending Data to AWS and Writing SMF

Example
  • CWGL00
    • ZADVISER=YES
    • ZADVISER_SMF_ID=244
    • SMF=YES (the default)
    • ZADVISER_TENANT_ID= 171494-AHbX5qo6j3jSnc4TZW-sbx8a7

Example 2: Legacy BMC Customer with No Legacy BMC AMI DevX products Writing SMF Only

Example
  • CWGL00
    • ZADVISER=NO
    • ZADVISER_SMF_ID=128
    • SMF=YES (the default)
    • ZADVISER_TENANT_ID= 171494-AHbX5qo6j3jSnc4TZW-sbx8a7

Example 3: Legacy BMC Customer with Legacy BMC AMI DevX products Writing SMF Only (Both Products Writing to SMF Record ID 254)

Example
  • CWGL00
    • ZADVISER=NO
    • ZADVISER_SMF_ID=254
    • SMF=YES (the default)
  • LMCL00
    • SMF_ID=254
    • SMF=YES (the default)

 Example 4: Legacy BMC Customer with Legacy BMC AMI DevX products Who Does Not Want zAdviser Data Sent to AWS and Does Not Want SMF Data Written by Either Product Set

Example
  •  CWGL00
    • ZADVISER=NO
    • SMF=NO
  • LMCL00
    • SMF=NO

Example 5: Legacy BMC Customer with No Legacy BMC AMI DevX products Sending Data to AWS Only (No SMF)

Example
  • CWGL00
    • ZADVISER=YES
    • SMF=NO
    • ZADVISER_TENANT_ID= 171494-AHbX5qo6j3jSnc4TZW-sbx8a7

 

 

Tip: For faster searching, add an asterisk to the end of your partial query. Example: cert*