List of Built-in NCM Macros

dreim

Can anyone point me in the direction of a list of NCM Built-in Macros?

itguynate

Here is what I got from the NCM scripting guys....

Places where macros can be used

• When adding new node in NCM we can use following macros - their values are taken from GlobalDeviceDefaults in NCM Settings:
  ${GlobalUserName}
  ${GlobalPassword}
  ${GlobalEnableLevel}
  ${GlobalEnablePassword}
  ${GlobalExecProtocol}
  ${GlobalConfigRequestProtocol}
  ${GlobalConfigTransferProtocol}
  ${GlobalTelnetPort}
  ${GlobalSSHPort}

• In all Jobs you can use macros in email notification subject sent to users or in filepath where job log is saved: supported are DateTimeMacros and GlobalMacros
  Additionally:
  • in 'Command Script jobs' job log filepath can contain: DateTimeMacros, GlobalMacros, NodeMacros
  • in 'Execute Script jobs' the script can contain: DateTimeMacros, CommandMacros, TransferMacros, NodeMacros, GlobalMacros
  • in 'Export Config jobs' exported filename and path can contain: DateTimeMacros, NodeMacros, GlobalMacros

• In 'Mirror Config copy' functionality mirrored config name can contain: DateTimeMacros, NodeMacros, GlobalMacros
  • Additionally you can use ${CONFIGTYPE} macro that will be changed to mirrored config type.

• In Device Templates every command can have DateTimeMacros, CommandMacros, TransferMacros, NodeMacros, GlobalMacros
  • Additionally in "Download/Upload Config Over Tftp/Scp" commands you can use ${TRANSFERPROTOCOL} that will be changed to Tftp/Scp accordingly

• In RTN functionality when we email notification, then fields:
  EmailSubject, EmailFrom, EmailReplyAddress, EmailRecipient, EmailCC, EmailBCC
  can contain: DateTimeMacros, NodeMacros, GlobalMacros

• For Config Transfer on Edit Node page or in Connection Profiles following properties:
  EnableLevel, EnablePassword, ExecuteScriptProtocol, Name, Password, UserName, RequestConfigProtocol, SSHPort, TelnetPort, TransferConfigProtocol
  can contain: DateTimeMacros, NodeMacros, GlobalMacros

• In Policy Reports every Policy Rule can contain PolicyRuleMacros and their values will be taken from [NCM_Nodes] table.
  • Remediation Script
  • What's more - if rule searches in config block then additional macro ${ConfigBlockStartLine} will be available and will be translated to that config block's start line
• Firmware Upgrade Definition
• There's SWIS verb NodeInvoker.ParseMacros that's accessible and can parse: DateTimeMacros, NodeMacros, GlobalMacros

 
 

Macros' categories

DateTimeMacros

These will be replaced with current date in different formats:

  ${DATETIME}

  ${DATE TIME}

  ${DATE/TIME}

     10-29-2019 2-55 PM

  ${DATE}

  ${SHORTDATE}

  ${SHORT DATE}

     10-29-2019

  ${LONGDATE}

  ${LONG DATE}

     Tuesday, October 29, 2019

  ${MEDIUMDATE}

  ${MEDIUM DATE}

     29-Oct-19

  ${LONGTIME}

  ${LONG TIME}

     2-55-48 PM

  ${MEDIUMTIME}

  ${MEDIUM TIME}

     02-55 PM

  ${TIME}

  ${SHORTTIME}

  ${SHORT TIME}

     14-55

  ${DOW}

  ${DAY OF WEEK}

  ${DAYOFWEEK}

     Tuesday

  ${D}

  ${DAY}

     29

  ${DD}

     29 (for example for 5th of it would be 05)

  ${ABREVIATEDDOW}

  ${ABREVIATED DAY OF WEEK}

  ${ABREVIATEDDAYOFWEEK}

     Tue

  ${MONTH}

  ${M}

     10 

  ${MM}

     10 (for May it would be 05)

  ${MMM}

  ${ABBREVIATEDMONTH}

  ${ABBREVIATED MONTH}

     Oct

  ${MMMM}

  ${MONTHNAME}

  ${MONTH NAME}

     October

  ${DAYOFYEAR}

  ${DAY OF YEAR}

     302

  ${YEAR2}

  ${YEAR 2}

  ${YY}

     19

  ${YEAR4}

  ${YEAR 4}

  ${YEAR}

  ${YYYY}

     2019

  ${H}

  ${HOUR}

     14

  ${HH}

     14 (for 5 AM it would be 05)

  ${N}

     55

  ${NN}

  ${MINUTE}

     55 (for 5 minutes it would be 05)

  ${S}

     48

  ${SS}

  ${SECOND}

     48 (for 5 seconds it would be 05)

  ${AMPM}

  ${AM/PM}

     PM

  ${CR}

  ${CRLF}

     \r\n

 
 

NodeMacros

Values of these macros are taken from NCM_Nodes table in database - Names in square brackets correspond to table's columns

  ${AGENTIP}

     if [ManagedProtocol] is 0 then [AgentIP] else [AgentIPv6]

 

  ${CAPTION}

     [NodeCaption]

 

  ${SYSTEMNAME}

  ${SYSNAME}

     if [SysName] is not empty then [SysName] else same as AGENTIP

  ${SYSTEMLOCATION}

  ${SYSLOCATION}

     [SysLocation]

  ${SYSTEMCONTACT}

  ${SYSCONTACT}

     [SysContact]

  ${DESCRIPTION}

  ${SYSDESCR}

  ${SYSTEMDESCRIPTION}

  ${SYSDESCRIPTION}

     [SysDescr]

  ${SCPSTORAGEADDRESS}

     if [Settings.SCPAutoRetriveIP] then [EngineIP] else [Settings.SCPServerAddress]

  ${STORAGEADDRESS}

     if [Settings.TFTPAutoRetriveIP] then [Settings.TFTPServerAddress] else [EngineIP]

  ${SCPSERVERUSERNAME}

     [Settings.SCPUserName]

  ${PCADDRESS}

  ${SERVERIP}

  ${IPADDRESS}

  ${TFTPSERVER}

  ${LOCALIP}

     [EngineIP]

  ${HOSTNAME}

  ${LOCALHOSTNAME}

     [EngineServerName]

  ${TRANSFERPROTOCOL}

     [TransferProtocol]

 
 

GlobalMacros

every [SettingName] from [NCM_GlobalSettings] can be used as macro - it will be replaced with [SettingValue]

TransferMacros

  ${CONFIGTYPE}

     ${[node's ConfigType]}

  ${STORAGEFILENAME}

     [node's ConfigFilename]

  ${CONFIGTEXT}

     [node's Script]

CommandMacros

Every Command from Device Template can be used as macro - ${Command's Name} would be changed to the Command's Value