MAN page from CentOS 7 fence-agents-azure-arm-4.0.11-86.el7.x86_64.rpm

FENCE_AGENT

Section: Maintenance Commands (8)
Updated: 2009-10-20
Index 

NAME

fence_azure_arm - Fence agent for Azure Resource Manager 

DESCRIPTION

Used to deallocate virtual machines and to report power state of virtual machines running in Azure. It uses Azure SDK for Python to connect to Azure.For instructions to setup credentials see: https://docs.microsoft.com/en-us/azure/azure-resource-manager/resource-group-create-service-principal-portalUsername and password are application ID and authentication key from "App registrations".fence_azure_arm accepts options on the command line as wellas from stdin. Fenced sends parameters through stdin when it execs theagent. fence_azure_arm can be run by itself with commandline options. This is useful for testing and for turning outlets on or offfrom scripts.

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

PARAMETERS

        
        

-o, --action=[action]

Fencing Action (Default Value: reboot)        
        
        
        

-l, --username=[appid]

Login Name This parameter is always required.        

-p, --password=[authkey]

Login password or passphrase        

-S, --password-script=[script]

Script to retrieve password        

-n, --plug=[id]

Physical plug number, name of virtual machine or UUID This parameter is always required.        

--resourceGroup=[name]

Name of resource group. This parameter is always required.        

--tenantId=[name]

Id of Azure Active Directory tenant. This parameter is always required.        

--subscriptionId=[name]

Id of the Azure subscription. This parameter is always required.        

-v, --verbose

Verbose mode        
        

-D, --debug-file=[debugfile]

Write debug information to given file        

-V, --version

Display version information and exit        

-h, --help

Display help and exit        

-C, --separator=[char]

Separator for CSV created by operation list (Default Value: ,)        

--delay=[seconds]

Wait X seconds before fencing is started (Default Value: 0)        

--shell-timeout=[seconds]

Wait X seconds for cmd prompt after issuing command (Default Value: 3)        

--power-wait=[seconds]

Wait X seconds after issuing ON/OFF (Default Value: 0)        

--power-timeout=[seconds]

Test X seconds for status change after ON/OFF (Default Value: 150)        

--login-timeout=[seconds]

Wait X seconds for cmd prompt after login (Default Value: 5)        

--retry-on=[attempts]

Count of attempts to retry power on (Default Value: 1)

 

ACTIONS

        

on

Power on machine.        

off

Power off machine.        

reboot

Reboot machine.        

status

This returns the status of the plug/virtual machine.        

list

List available plugs with aliases/virtual machines if there is support for more then 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 fence device        

metadata

Display the XML metadata describing this resource.        

validate-all

Validate if all required parameters are entered.

 

STDIN PARAMETERS

        
        

action

Fencing Action (Default Value: reboot)        
        
        
        

username

Login Name This parameter is always required. Obsoletes: login        

password

Login password or passphrase Obsoletes: passwd        

password_script

Script to retrieve password Obsoletes: passwd_script        

plug

Physical plug number, name of virtual machine or UUID This parameter is always required. Obsoletes: port        

resourceGroup

Name of resource group. This parameter is always required.        

tenantId

Id of Azure Active Directory tenant. This parameter is always required.        

subscriptionId

Id of the Azure subscription. This parameter is always required.        

verbose

Verbose mode        
        

debug_file

Write debug information to given file Obsoletes: debug        

version

Display version information and exit        

help

Display help and exit        

separator

Separator for CSV created by operation list (Default Value: ,)        

delay

Wait X seconds before fencing is started (Default Value: 0)        

shell_timeout

Wait X seconds for cmd prompt after issuing command (Default Value: 3)        

power_wait

Wait X seconds after issuing ON/OFF (Default Value: 0)        

power_timeout

Test X seconds for status change after ON/OFF (Default Value: 150)        

login_timeout

Wait X seconds for cmd prompt after login (Default Value: 5)        

retry_on

Count of attempts to retry power on (Default Value: 1)

---

 

Index

NAME

DESCRIPTION

PARAMETERS

ACTIONS

STDIN PARAMETERS

---

This document was created byman2html,using the manual pages.