• Spaces
  • Collections
  • Help
    • ×
     
     
    •  
    BMC Database Automation 8.8

    Page tree

    The following table lists the supported environment variables for Microsoft SQL Server databases, for each BMC Database Automation (BDA) activity:

    Note

    Beginning with BDA 8.8, a new GAC_Max_Wait_For_AvGrp_Synchronization custom variable enables you to specify the maximum polling time (in seconds) when BDA polls the Availability Group to see if all its databases are synchronized before proceeding to the patching operation.

    For more information, see Installing a SQL Server patch package.

    In general, when specifying custom variables with the GAC prefix, use the following syntax:

    • For script Actions on Unix-like operating systems, ${GAC_variablename}
    • For script Actions on Windows operating systems, %GAC_variablename%
    • For SQL Actions, {GAC_variablename}

    Activity

    Environment variables

    Create SQL Server Instance

    GAC_{CUSTOM_FIELD}
    GA_CLARITY_USER
    GA_CLARITY_USERIP
    GA_CLUSTER_GROUP
    GA_DAGENT_VERSION
    GA_DATAPATH
    GA_DBEDITION
    GA_DBMAJORVERSION
    GA_DBNUMERICVERSION
    GA_DBVERSION
    GA_DOMAIN
    GA_INSTALLPATH
    GA_INSTANCE_NAME
    GA_JOB_ID
    GA_LOG_DIR
    GA_MANAGER_ADDRESS
    GA_NODE_STATE
    GA_OPERATION
    GA_OPERATION_DESCRIPTION
    GA_OPERATION_PRODUCT
    GA_PERL
    GA_RUN_STATE
    GA_SCRIPT_DIR
    GA_SQLACCOUNT
    GA_SQLPASSWORD
    GA_SUBJOB_ID
    GA_XML

    Back to top

    Create SQL Server Database

    GAC_{CUSTOM_FIELD}
    GA_CLARITY_USER
    GA_CLARITY_USERIP
    GA_DAGENT_VERSION
    GA_DATABASE_NAME
    GA_DBEDITION
    GA_DBMAJORVERSION
    GA_DBNUMERICVERSION
    GA_DBVERSION
    GA_DOMAIN
    GA_INSTANCE_NAME
    GA_JOB_ID
    GA_LOG_DIR
    GA_MANAGER_ADDRESS
    GA_NODE_STATE
    GA_OPERATION
    GA_OPERATION_DESCRIPTION
    GA_OPERATION_PRODUCT
    GA_PERL
    GA_RUN_STATE
    GA_SCRIPT_DIR
    GA_SUBJOB_ID
    GA_VAR_DIR
    GA_XML

    Back to top

    Create Availability Group

    GAC_{CUSTOM_FIELD}
    GA_CLARITY_USER
    GA_CLARITY_USERIP
    GA_DAGENT_VERSION
    GA_DBEDITION
    GA_DBMAJORVERSION
    GA_DBNUMERICVERSION
    GA_DOMAIN
    GA_HADR_GROUP_NAME
    GA_HADR_DATABASE_LIST
    GA_HADR_REPLICA_NAME
    GA_HADR_REPLICA_CONNECT_NAME
    GA_HADR_REPLICA_ROLE - PRIMARY vs. SECONDARY
    GA_HADR_AUTO_FAILOVER - 1 vs. 0
    GA_HADR_SYNC_COMMIT - 1 vs. 0
    GA_HADR_READABLE_SECONDARY - ALL, NO, READONLY
    GA_HADR_ENDPOINT_URL
    GA_HADR_ENDPOINT_PORT
    GA_HADR_ENDPOINT_NAME
    GA_HADR_ENCRYPT_DATA - 1 vs. 0
    GA_HADR_BACKUP_PREFERENCE - PRIMARY, SECONDARY, SECONDARY_ONLY, NONE
    GA_HADR_BACKUP_PRIORITY - 0 - 100
    GA_HADR_CREATE_LISTENER - 1 vs. 0
    GA_HADR_LISTENER_NAME - only defined if GA_HADR_CREATE_LISTENER = 1
    GA_HADR_LISTENER_PORT - only defined if GA_HADR_CREATE_LISTENER = 1
    GA_HADR_LISTENER_MODE - STATIC vs. DCHP, only defined if GA_HADR_CREATE_LISTENER = 1
    GA_HADR_LISTENER_DHCP_SUBNET - only defined if GA_HADR_CREATE_LISTENER = 1 and GA_HADR_LISTENER_MODE = DHCP
    GA_HADR_LISTENER_STATIC_ADDRESSES - only defined if GA_HADR_CREATE_LISTENER = 1 and GA_HADR_LISTENER_MODE = STATIC
    GA_HADR_SYNCHRONIZATION - FULL, JOIN, SKIP
    GA_HADR_CREATE_SYNC_SHARE - 1 vs. 0, only defined if GA_HADR_SYNCHRONIZATION = FULL
    GA_HADR_SYNC_SHARE_NAME - name of the share, minus the host part, only defined if GA_HADR_SYNCHRONIZATION = FULL and GA_HADR_CREATE_SYNC_SHARE = 1
    GA_HADR_SYNC_SHARE_DIR - directory for the share, only defined if GA_HADR_SYNCHRONIZATION = FULL and GA_HADR_CREATE_SYNC_SHARE = 1
    GA_HADR_SYNC_SHARE_USERS - comma-separated list of users being granted full access to the share, only defined if GA_HADR_SYNCHRONIZATION = FULL and GA_HADR_CREATE_SYNC_SHARE = 1
    GA_HADR_SYNC_SHARE_URI - the full URI for the network share being used for synchronization, only defined if GA_HADR_SYNCHRONIZATION = FULL
    GA_INSTANCE_NAME - defined for compatibility with instance-scoped scripts
    GA_INSTANCE_CONNECT_NAME - defined for compatibility with instance-scoped scripts
    GA_JOB_ID
    GA_LOG_DIR
    GA_MANAGER_ADDRESS
    GA_NODE_STATE
    GA_OPERATION
    GA_OPERATION_DESCRIPTION
    GA_OPERATION_PRODUCT
    GA_PERL
    GA_RUN_STATE
    GA_SCRIPT_DIR
    GA_SUBJOB_ID
    GA_XML

    Back to top

    Remove SQL Server Database

    GAC_{CUSTOM_FIELD}
    GA_CLARITY_USER
    GA_CLARITY_USERIP
    GA_DAGENT_VERSION
    GA_DATABASE_NAME
    GA_DBEDITION
    GA_DBMAJORVERSION
    GA_DBNUMERICVERSION
    GA_DOMAIN
    GA_INSTANCE_NAME
    GA_JOB_ID
    GA_LOG_DIR
    GA_MANAGER_ADDRESS
    GA_NODE_STATE
    GA_OPERATION
    GA_OPERATION_DESCRIPTION
    GA_OPERATION_PRODUCT
    GA_PERL
    GA_RUN_STATE
    GA_SCRIPT_DIR
    GA_SUBJOB_ID
    GA_XML

    Back to top

    Remove SQL Server Instance

    GAC_{CUSTOM_FIELD}
    GA_CLARITY_USER
    GA_CLARITY_USERIP
    GA_DAGENT_VERSION
    GA_DBEDITION
    GA_DBMAJORVERSION
    GA_DBNUMERICVERSION
    GA_DBVERSION
    GA_DOMAIN
    GA_INSTANCE_CLUSTERED
    GA_INSTANCE_NAME
    GA_JOB_ID
    GA_LOG_DIR
    GA_MANAGER_ADDRESS
    GA_NODE_STATE
    GA_OPERATION
    GA_OPERATION_DESCRIPTION
    GA_OPERATION_PRODUCT
    GA_PERL
    GA_RUN_STATE
    GA_SCRIPT_DIR
    GA_SUBJOB_ID
    GA_VAR_DIR
    GA_XML

    Back to top

    Remove Availability Group

    GAC_{CUSTOM_FIELD}
    GA_CLARITY_USER
    GA_CLARITY_USERIP
    GA_DAGENT_VERSION
    GA_DBEDITION
    GA_DBMAJORVERSION
    GA_DBNUMERICVERSION
    GA_DOMAIN
    GA_HADR_GROUP_NAME
    GA_HADR_DATABASE_LIST
    GA_HADR_REPLICA_NAME
    GA_HADR_REPLICA_CONNECT_NAME
    GA_HADR_REPLICA_ROLE -PRIMARY vs. SECONDARY
    GA_HADR_REMOVE_DATABASES_FROM_SECONDARY -1 vs. 0
    GA_HADR_ENDPOINT_URL
    GA_HADR_ENDPOINT_PORT
    GA_HADR_ENDPOINT_NAME
    GA_HADR_LISTENER_DEFINED - 1 vs. 0
    GA_HADR_LISTENER_NAME - only defined if group has a listener
    GA_HADR_LISTENER_PORT - only defined if group has a listener
    GA_INSTANCE_NAME - defined for compatibility with instance-scoped scripts
    GA_INSTANCE_CONNECT_NAME - defined for compatibility with instance-scoped scripts
    GA_JOB_ID
    GA_LOG_DIR
    GA_MANAGER_ADDRESS
    GA_NODE_STATE
    GA_OPERATION
    GA_OPERATION_DESCRIPTION
    GA_OPERATION_PRODUCT
    GA_PERL
    GA_RUN_STATE
    GA_SCRIPT_DIR
    GA_SUBJOB_ID
    GA_XML

    Back to top

    Remove Replica from Existing Availability Group

    GAC_{CUSTOM_FIELD}
    GA_CLARITY_USER
    GA_CLARITY_USERIP
    GA_DAGENT_VERSION
    GA_DBEDITION
    GA_DBMAJORVERSION
    GA_DBNUMERICVERSION
    GA_DOMAIN
    GA_HADR_GROUP_NAME
    GA_HADR_DATABASE_LIST
    GA_HADR_REMOVE_REPLICA_LIST
    GA_HADR_REPLICA_NAME
    GA_HADR_REPLICA_CONNECT_NAME
    GA_HADR_REPLICA_ROLE -PRIMARY vs. SECONDARY
    GA_HADR_REMOVE_DATABASES_FROM_SECONDARY -1 vs. 0
    GA_HADR_ENDPOINT_URL
    GA_HADR_ENDPOINT_PORT
    GA_HADR_ENDPOINT_NAME
    GA_HADR_LISTENER_DEFINED - 1 vs. 0
    GA_HADR_LISTENER_NAME - only defined if group has a listener
    GA_HADR_LISTENER_PORT - only defined if group has a listener
    GA_INSTANCE_NAME - defined for compatibility with instance-scoped scripts
    GA_INSTANCE_CONNECT_NAME - defined for compatibility with instance-scoped scripts
    GA_JOB_ID
    GA_LOG_DIR
    GA_MANAGER_ADDRESS
    GA_NODE_STATE
    GA_OPERATION
    GA_OPERATION_DESCRIPTION
    GA_OPERATION_PRODUCT
    GA_PERL
    GA_RUN_STATE
    GA_SCRIPT_DIR
    GA_SUBJOB_ID
    GA_XML

    Back to top

    Fail Over Primary Replica For Availability Group

    GAC_{CUSTOM_FIELD}
    GA_CLARITY_USER
    GA_CLARITY_USERIP
    GA_DAGENT_VERSION
    GA_DBEDITION
    GA_DBMAJORVERSION
    GA_DBNUMERICVERSION
    GA_DOMAIN
    GA_HADR_GROUP_NAME
    GA_HADR_DATABASE_LIST
    GA_HADR_REPLICA_NAME
    GA_HADR_REPLICA_CONNECT_NAME
    GA_HADR_REPLICA_ROLE -PRIMARY vs. SECONDARY
    GA_INSTANCE_NAME - defined for compatibility with instance-scoped scripts
    GA_INSTANCE_CONNECT_NAME - defined for compatibility with instance-scoped scripts
    GA_JOB_ID
    GA_LOG_DIR
    GA_MANAGER_ADDRESS
    GA_NODE_STATE
    GA_OPERATION
    GA_OPERATION_DESCRIPTION
    GA_OPERATION_PRODUCT
    GA_PERL
    GA_RUN_STATE
    GA_SCRIPT_DIR
    GA_SUBJOB_ID
    GA_XML

    Back to top

    Add Node to Clustered SQL Server Instance

    GAC_{CUSTOM_FIELD}
    GA_CLARITY_USER
    GA_CLARITY_USERIP
    GA_DAGENT_VERSION
    GA_DBEDITION
    GA_DBMAJORVERSION
    GA_DBNUMERICVERSION
    GA_DBVERSION
    GA_DOMAIN
    GA_INSTANCE_CLUSTERED
    GA_INSTANCE_NAME
    GA_JOB_ID
    GA_LOG_DIR
    GA_MANAGER_ADDRESS
    GA_NODE_STATE
    GA_OPERATION
    GA_OPERATION_DESCRIPTION
    GA_OPERATION_PRODUCT
    GA_PERL
    GA_RUN_STATE
    GA_SCRIPT_DIR
    GA_SQLACCOUNT
    GA_SQLPASSWORD
    GA_SUBJOB_ID
    GA_VAR_DIR
    GA_XML

    Back to top

    Add DB to Existing Availability Group

    GAC_{CUSTOM_FIELD}
    GA_CLARITY_USER
    GA_CLARITY_USERIP
    GA_DAGENT_VERSION
    GA_DBEDITION
    GA_DBMAJORVERSION
    GA_DBNUMERICVERSION
    GA_DOMAIN
    GA_HADR_GROUP_NAME
    GA_HADR_DATABASE_LIST
    GA_HADR_NEW_DATABASE_LIST
    GA_HADR_REPLICA_NAME
    GA_HADR_REPLICA_CONNECT_NAME
    GA_HADR_REPLICA_ROLE -PRIMARY vs. SECONDARY
    GA_HADR_SYNCHRONIZATION -FULL, JOIN, SKIP
    GA_HADR_CREATE_SYNC_SHARE -1 vs. 0, only defined if GA_HADR_SYNCHRONIZATION = FULL
    GA_HADR_SYNC_SHARE_NAME - name of the share, minus the host part, only defined if GA_HADR_SYNCHRONIZATION = FULL and GA_HADR_CREATE_SYNC_SHARE = 1
    GA_HADR_SYNC_SHARE_DIR - directory for the share, only defined if GA_HADR_SYNCHRONIZATION = FULL and GA_HADR_CREATE_SYNC_SHARE = 1
    GA_HADR_SYNC_SHARE_DIR - comma-separated list of users being granted full access to the share, only defined if GA_HADR_SYNCHRONIZATION = FULL and GA_HADR_CREATE_SYNC_SHARE = 1
    GA_HADR_SYNC_SHARE_URI - the full URI for the network share being used for synchronization, only defined if GA_HADR_SYNCHRONIZATION = FULL
    GA_INSTANCE_NAME - defined for compatibility with instance-scoped scripts
    GA_INSTANCE_CONNECT_NAME - defined for compatibility with instance-scoped scripts
    GA_JOB_ID
    GA_LOG_DIR
    GA_MANAGER_ADDRESS
    GA_NODE_STATE
    GA_OPERATION
    GA_OPERATION_DESCRIPTION
    GA_OPERATION_PRODUCT
    GA_PERL
    GA_RUN_STATE
    GA_SCRIPT_DIR
    GA_SUBJOB_ID
    GA_XML

    Back to top

      Add Replica to Existing Availability Group

    GAC_{CUSTOM_FIELD}
    GA_CLARITY_USER
    GA_CLARITY_USERIP
    GA_DAGENT_VERSION
    GA_DBEDITION
    GA_DBMAJORVERSION
    GA_DBNUMERICVERSION
    GA_DOMAIN
    GA_HADR_GROUP_NAME
    GA_HADR_DATABASE_LIST
    GA_HADR_NEW_REPLICA_NAME
    GA_HADR_REPLICA_NAME
    GA_HADR_REPLICA_CONNECT_NAME
    GA_HADR_REPLICA_ROLE -PRIMARY vs. SECONDARY
    GA_HADR_AUTO_FAILOVER -1 vs. 0
    GA_HADR_SYNC_COMMIT -1 vs. 0
    GA_HADR_READABLE_SECONDARY -YES, NO, READONLY
    GA_HADR_ENDPOINT_URL
    GA_HADR_ENDPOINT_PORT
    GA_HADR_ENDPOINT_NAME
    GA_HADR_ENCRYPT_DATA -1 vs. 0
    GA_HADR_BACKUP_PRIORITY -0-100
    GA_HADR_SYNCHRONIZATION -FULL, JOIN, SKIP
    GA_HADR_CREATE_SYNC_SHARE -1 vs. 0, only defined if GA_HADR_SYNCHRONIZATION = FULL
    GA_HADR_SYNC_SHARE_NAME - name of the share, minus the host part, only defined if GA_HADR_SYNCHRONIZATION = FULL and GA_HADR_CREATE_SYNC_SHARE = 1
    GA_HADR_SYNC_SHARE_DIR - directory for the share, only defined if GA_HADR_SYNCHRONIZATION = FULL and GA_HADR_CREATE_SYNC_SHARE = 1
    GA_HADR_SYNC_SHARE_DIR - comma-separated list of users being granted full access to the share, only defined if GA_HADR_SYNCHRONIZATION = FULL and GA_HADR_CREATE_SYNC_SHARE = 1
    GA_HADR_SYNC_SHARE_URI - the full URI for the network share being used for synchronization, only defined if GA_HADR_SYNCHRONIZATION = FULL
    GA_INSTANCE_NAME - defined for compatibility with instance-scoped scripts
    GA_INSTANCE_CONNECT_NAME - defined for compatibility with instance-scoped scripts
    GA_JOB_ID
    GA_LOG_DIR
    GA_MANAGER_ADDRESS
    GA_NODE_STATE
    GA_OPERATION
    GA_OPERATION_DESCRIPTION
    GA_OPERATION_PRODUCT
    GA_PERL
    GA_RUN_STATE
    GA_SCRIPT_DIR
    GA_SUBJOB_ID
    GA_XML

    Back to top

    Remove Node from Clustered SQL Server Instance

    GAC_{CUSTOM_FIELD}
    GA_CLARITY_USER
    GA_CLARITY_USERIP
    GA_DAGENT_VERSION
    GA_DBEDITION
    GA_DBMAJORVERSION
    GA_DBNUMERICVERSION
    GA_DBVERSION
    GA_DOMAIN
    GA_INSTANCE_CLUSTERED
    GA_INSTANCE_NAME
    GA_JOB_ID
    GA_LOG_DIR
    GA_MANAGER_ADDRESS
    GA_NODE_STATE
    GA_OPERATION
    GA_OPERATION_DESCRIPTION
    GA_OPERATION_PRODUCT
    GA_PERL
    GA_RUN_STATE
    GA_SCRIPT_DIR
    GA_SUBJOB_ID
    GA_VAR_DIR
    GA_XML

    Back to top

    Remove DB from Existing Availability Group

    GAC_{CUSTOM_FIELD}
    GA_CLARITY_USER
    GA_CLARITY_USERIP
    GA_DAGENT_VERSION
    GA_DBEDITION
    GA_DBMAJORVERSION
    GA_DBNUMERICVERSION
    GA_DOMAIN
    GA_HADR_GROUP_NAME
    GA_HADR_DATABASE_LIST
    GA_HADR_REMOVE_DATABASE_LIST
    GA_HADR_REPLICA_NAME
    GA_HADR_REPLICA_CONNECT_NAME
    GA_HADR_REPLICA_ROLE -PRIMARY vs. SECONDARY
    GA_HADR_REMOVE_DATABASES_FROM_SECONDARY -1 vs. 0
    GA_INSTANCE_NAME - defined for compatibility with instance-scoped scripts
    GA_INSTANCE_CONNECT_NAME - defined for compatibility with instance-scoped scripts
    GA_JOB_ID
    GA_LOG_DIR
    GA_MANAGER_ADDRESS
    GA_NODE_STATE
    GA_OPERATION
    GA_OPERATION_DESCRIPTION
    GA_OPERATION_PRODUCT
    GA_PERL
    GA_RUN_STATE
    GA_SCRIPT_DIR
    GA_SUBJOB_ID
    GA_XML

    Back to top

    Apply Patch to SQL Server

    GAC_{CUSTOM_FIELD}
    GA_CLARITY_USER
    GA_CLARITY_USERIP
    GA_DAGENT_VERSION
    GA_DBEDITION
    GA_DBMAJORVERSION
    GA_DBNUMERICVERSION
    GA_DBVERSION
    GA_DOMAIN
    GA_INSTANCE_CLUSTERED
    GA_INSTANCE_NAME
    GA_JOB_ID
    GA_LOG_DIR
    GA_MANAGER_ADDRESS
    GA_NODE_STATE
    GA_OPERATION
    GA_OPERATION_DESCRIPTION
    GA_OPERATION_PRODUCT
    GA_PERL
    GA_RUN_STATE
    GA_SCRIPT_DIR
    GA_SUBJOB_ID
    GA_VAR_DIR
    GA_VERIFY_MODE
    GA_XML

    Back to top

    Rollback Patch on SQL Server

    GAC_{CUSTOM_FIELD}
    GA_CLARITY_USER
    GA_CLARITY_USERIP
    GA_DAGENT_VERSION
    GA_DBEDITION
    GA_DBMAJORVERSION
    GA_DBNUMERICVERSION
    GA_DBVERSION
    GA_DOMAIN
    GA_INSTANCE_CLUSTERED
    GA_INSTANCE_NAME
    GA_JOB_ID
    GA_LOG_DIR
    GA_MANAGER_ADDRESS
    GA_NODE_STATE
    GA_OPERATION
    GA_OPERATION_DESCRIPTION
    GA_OPERATION_PRODUCT
    GA_PERL
    GA_RUN_STATE
    GA_SCRIPT_DIR
    GA_SUBJOB_ID
    GA_VAR_DIR
    GA_VERIFY_MODE
    GA_XML

    Back to top

    © Copyright 2005-2024 BMC Software, Inc. Use of this site signifies your acceptance of BMC’s Terms of Use . BMC, the BMC logo, and other BMC marks are assets of BMC Software, Inc. These trademarks are registered and may be registered in the U.S. and in other countries.