FENCE_AGENT(8)

✨ fence_azure_arm 💅

okay bestie, welcome to the FENCE_AGENT(8) manual page — yeah, section 8, System Manager's Manual, we're in the big-kid section now. This one's about fence_azure_arm, and no cap, it's lowkey iconic.

---

NAME 🌸

fence_azure_arm — the fence agent for Azure Resource Manager. That's it, that's the name, she's serving exactly what it says on the tin 💖

---

DESCRIPTION 🦋

So fence_azure_arm is a Power Fencing agent for Azure Resource Manager. It uses the Azure SDK for Python to connect to Azure. Periodt.

For the instructions on how to set up your credentials, go look here:

https://docs.microsoft.com/en-us/azure/azure-resource-manager/resource-group-create-service-principal-portal

Your username and password are the application ID and the authentication key from your "App registrations". That's the whole vibe, iykyk 🔑

NOTE: NETWORK FENCING 💀

Network fencing needs an extra subnet named "fence-subnet" for the Virtual Network, using a Network Security Group with these rules:

+-----------+-----+-------------------------+------+------+-----+-----+--------+
| DIRECTION | PRI | NAME                    | PORT | PROT | SRC | DST | ACTION |
+-----------+-----+-------------------------+------+------+-----+-----+--------+
| Inbound   | 100 | FENCE_DENY_ALL_INBOUND  | Any  | Any  | Any | Any | Deny   |
| Outbound  | 100 | FENCE_DENY_ALL_OUTBOUND | Any  | Any  | Any | Any | Deny   |
+-----------+-----+-------------------------+------+------+-----+-----+--------+

When you're using network fencing, the reboot-action will cause a quick-return once the network has been fenced — instead of waiting around for the off-action to succeed. Then it checks the status during the monitor-action, and requests power-on when the shutdown operation is complete. Efficiency queen 👑

The fence agent accepts options on the command line as well as from stdin. Fenced sends parameters through stdin when it execs the agent. You can also run the agent all by itself with command line options — super useful for testing and for turning outlets on or off from scripts. Main character energy fr fr ✨

Vendor URL: http://www.microsoft.com

---

PARAMETERS 🎀

• -o, --action=[action] — the fencing action. (Default Value: reboot)
• -p, --password=[authkey] — the authentication key 🔐
• -S, --password-script=[script] — a script to run to retrieve the password
• -n, --plug=[id] — physical plug number on the device, UUID, or identification of the machine. This parameter is always required. No plug, no party 💅
• -l, --username=[appid] — the Application ID
• --resourceGroup=[name] — name of the resource group. The metadata service is used if the value is not provided.
• --tenantId=[name] — id of the Azure Active Directory tenant.
• --subscriptionId=[name] — id of the Azure subscription. The metadata service is used if the value is not provided.
• --network-fencing — use network fencing. See the NOTE-section for configuration 👀
• --msi — determines if Managed Service Identity should be used.
• --cloud=[name] — name of the cloud you want to use.
• --metadata-endpoint=[URL] — URL to the metadata endpoint (used when cloud=stack).
• -q, --quiet — disable logging to stderr. Does not affect --verbose or --debug-file or logging to syslog.
• -v, --verbose — verbose mode. Multiple -v flags can be stacked on the command line (e.g., -vvv) to increase verbosity. Stack 'em like friendship bracelets 🫶
• --verbose-level — level of debugging detail in output. Defaults to the number of --verbose flags specified on the command line, or to 1 if verbose=1 in a stonith device configuration (i.e., on stdin).
• -D, --debug-file=[debugfile] — write debug information to the given file
• -V, --version — display version information and exit
• -h, --help — display help and exit
• --plug-separator=[char] — separator for the plug parameter when specifying more than 1 plug (Default Value: ,)
• -C, --separator=[char] — separator for the CSV created by the 'list' operation (Default Value: ,)
• --delay=[seconds] — wait X seconds before fencing is started (Default Value: 0)
• --disable-timeout=[true/false] — disable timeout (true/false) (default: true when run from Pacemaker 2.0+)
• --login-timeout=[seconds] — wait X seconds for the cmd prompt after login (Default Value: 5)
• --power-timeout=[seconds] — test X seconds for status change after ON/OFF (Default Value: 150)
• --power-wait=[seconds] — wait X seconds after issuing ON/OFF (Default Value: 0)
• --shell-timeout=[seconds] — wait X seconds for the cmd prompt after issuing a command (Default Value: 3)
• --stonith-status-sleep=[seconds] — sleep X seconds between status calls during a STONITH action (Default Value: 1)
• --retry-on=[attempts] — count of attempts to retry power on (Default Value: 1)

---

ACTIONS ⭐

• on — power on the machine.
• off — power off the machine.
• reboot — reboot the machine.
• status — this returns the status of the plug/virtual machine.
• list — list available plugs with aliases/virtual machines, if there's support for more than one device. Returns N/A otherwise.
• list-status — list available plugs with aliases/virtual machines and their power state, if it can be obtained without additional commands.
• monitor — check the health of the fence device 🩺
• metadata — display the XML metadata describing this resource.
• manpage — the operational behavior of this is not known. (Bestie, we're all just figuring it out 😭)
• validate-all — validate if all required parameters are entered.

---

STDIN PARAMETERS 🌈

• action — fencing action (Default Value: reboot)
• password — authentication key. Obsoletes: passwd
• password_script — script to run to retrieve password. Obsoletes: passwd_script
• plug — physical plug number on device, UUID or identification of machine. This parameter is always required. Obsoletes: port
• username — Application ID. Obsoletes: login
• resourceGroup — name of resource group. Metadata service is used if the value is not provided.
• tenantId — id of Azure Active Directory tenant.
• subscriptionId — id of the Azure subscription. Metadata service is used if the value is not provided.
• network_fencing — use network fencing. See NOTE-section for configuration. Obsoletes: network-fencing
• msi — determines if Managed Service Identity should be used.
• cloud — name of the cloud you want to use.
• metadata_endpoint — URL to metadata endpoint (used when cloud=stack). Obsoletes: metadata-endpoint
• quiet — disable logging to stderr. Does not affect --verbose or --debug-file or logging to syslog.
• verbose — verbose mode. Multiple -v flags can be stacked on the command line (e.g., -vvv) to increase verbosity.
• verbose_level — level of debugging detail in output. Defaults to the number of --verbose flags specified on the command line, or to 1 if verbose=1 in a stonith device configuration (i.e., on stdin).
• debug_file — write debug information to given file. Obsoletes: debug
• version — display version information and exit
• help — display help and exit
• plug_separator — separator for plug parameter when specifying more than 1 plug (Default Value: ,)
• separator — separator for CSV created by 'list' operation (Default Value: ,)
• delay — wait X seconds before fencing is started (Default Value: 0)
• disable_timeout — disable timeout (true/false) (default: true when run from Pacemaker 2.0+)
• login_timeout — wait X seconds for cmd prompt after login (Default Value: 5)
• power_timeout — test X seconds for status change after ON/OFF (Default Value: 150)
• power_wait — wait X seconds after issuing ON/OFF (Default Value: 0)
• shell_timeout — wait X seconds for cmd prompt after issuing command (Default Value: 3)
• stonith_status_sleep — sleep X seconds between status calls during a STONITH action (Default Value: 1)
• retry_on — count of attempts to retry power on (Default Value: 1)

---

Reminder bestie: plug is always required, and --quiet does NOT silence --verbose or --debug-file or syslog. Don't get caught lacking 💅

---

And that's a wrap! This page came from fence_azure_arm (Fence Agent) and it's dated 2009-10-20. Slay, bye 🦋💖✨