fapolicyd

title: fapolicyd(8)

summary: File Access Policy Daemon

text:
# fapolicyd(8)

## NAME
fapolicyd - File Access Policy Daemon

## SYNOPSIS
fapolicyd [options]

## DESCRIPTION
fapolicyd is a userspace daemon that determines access rights to files based on a trust database and file or process attributes. It can be used to either blacklist or whitelist file access and execution.

Configuring fapolicyd is done with the files in the /etc/fapolicyd/ directory. There are three files: compiled.rules , fapolicyd.conf , and fapolicyd.trust. The first one contains the access policy, the second determines the daemon's configuration, and the last allows admin defined trusted files.

The default rules will generate audit events whenever there is a denial. NOTE: you must have at least 1 audit rule loaded for the audit system to create the full FANOTIFY event. It doesn't matter which rule is loaded. To see if you have any denials, you can run the following command:

ausearch --start today -m fanotify -i

or instead of -i, you can add --format text to get an easier to read audit event.

## OPTIONS
--debug

leave the daemon in the foreground for debugging. Event information is written to stderr so that policy decisions can be observed.

--debug-deny

leave the daemon in the foreground for debugging. Event information is written to stderr only when the decision is to deny access.

--permissive

the daemon will allow file access regardless of the policy decision. This is useful for debugging rules before making them permanent.

--no-details

when fapolicyd ends, it dumps a usage report with various statistics that may be useful for tuning performance. It can also detail which processes it knew about and files being accessed by them. This can be useful for forensics investigations. In some settings, this may not be desirable as the file names may be sensitive. Using this option removes process and file names leaving only the statistics. The default without giving this option is to generate a full report.

## SIGNALS
SIGTERM

causes fapolicyd to discontinue processing events, write it's performance report, and exit.

SIGHUP

causes fapolicyd to reload the trust database.

SIGUSR1

causes fapolicyd to dump it's internal statistics to /var/run/fapolicyd.state

## NOTES
Whatever you do, DO NOT TRY TO ATTACH WITH PTRACE. Ptrace attachment sends a SIGSTOP which cannot be blocked. Since your whole system depends on fapolicyd approving access to glibc and various critical libraries, that will not happen until SIGCONT is sent. The system can deadlock if the continue signal is not sent.

To get audit events, you must have auditing enabled and at least one systemcall rule loaded. Otherwise you will not get any events.

If the rpmdb is set as a trust source, you should minimize the number of 32 bit packages on the system. In such cases, there may be a 32 bit and 64 file with the same pathname. Obviously only one can exist on the disk. So, this will always cause database miscompares and cause a delay in the daemon being operational.

The compiled.rules file is the resulting merge of component rules in /etc/fapolicyd/rules.d/ See the fagenrules man page for more information.

If you are running in the debug mode and wish to compare rule numbers reported in the output with which rule is actually triggering, you can see the rules with the corresponding number by running the following command:

```
fapolicyd-cli --list
```

## FILES
/etc/fapolicyd/fapolicyd.conf - daemon configuration

/etc/fapolicyd/compiled.rules - access control rules

/etc/fapolicyd/fapolicyd.trust - admin defined trusted files

/var/log/fapolicyd-access.log - information about what was being accessed.

/run/fapolicyd/fapolicyd.state - internal performance metrics

## SEE ALSO
fapolicyd-cli(8), fapolicyd.rules(5), fapolicyd.trust(5), fapolicyd-filter.conf(5), fagenrules(8), and fapolicyd.conf(5)

## AUTHOR
Steve Grubb


fapolicyd-cli

package: fapolicyd

title: fapolicyd-cli(8)

summary: Fapolicyd CLI Tool

text:
# fapolicyd-cli(8)

## NAME
fapolicyd-cli - Fapolicyd CLI Tool

## SYNOPSIS
fapolicyd-cli [options]

## DESCRIPTION
The fapolicyd command line utility is a tool to tell the daemon that it needs to update the trust database. Normally, the daemon learns that the trust database needs updating because it uses a dnf plugin to inform it. However, you may install an rpm by hand and it can't see that a system package was installed or updated. Or perhaps the admin updates the fapolicyd.trust file and would like the changes to take effect immediately. In either of these cases, you would need to tell the daemon that it needs to do an update by running this command.

## OPTIONS
-h, --help

Prints a list of command line options.

--check-config

Opens fapolicyd.conf and parses it to see if there are any syntax errors in the file.

--check-path

Check the PATH environmental variable against the trustdb to look for file not in the trustdb which could cause problems at run time.

--check-status

Dump the daemon's internal performance statistics. See also the fapolicyd.conf option report_interval.

--check-trustdb

Check the trustdb against the files on disk to look for mismatches that will cause problems at run time.

--check-watch_fs

Check the mounted file systems against the watch_fs daemon config entry to determine if any file systems need to be added to the configuration.

-d, --delete-db

Deletes the trust database. Normally this never needs to be done. But if for some reason the trust database becomes corrupted, then the only method of recovery is to run this command.

-D, --dump-db

Dumps the trust db contents for inspection. This will print the original trust source, path, file size, and SHA256 sum of the file as known by the trust source the entry came from.

-f, --file add|delete|update [path]

Manage the file trust database.

add

This command adds the file given by path to the trust database. It gets the size and calculates the required SHA256 hash. If the path is a directory, it will walk the directory tree to the bottom and add every regular file that it finds. By default, the path is appended to the end of the fapolicyd.trust file.

delete

This command deletes all entries that match from the trust database. It will try to match multiple entries so that entire directories can be deleted in one command. To ensure that you only match a directory and not a partial name, be sure to end with '/'.

update

This command updates the size and hash of any matching paths in the file trust database. If no path is given, then all files are updated. If an argument is passed, then only matching paths get updated. If the intent is to match against a directory, ensure that it ends with '/'.

--trust-file trust-file-name

Use after file option. Makes every command of file option operate on a single trust file named trust-file-name that is located inside trust.d directory. If a trust file with such a name does not exist inside trust.d directory, it is created.

-t, --ftype /path/to/file

Prints the mime type of the file given. A full path must be specified. This command is intended to help get the ftype parameter of rules correct by seeing how fapolicyd will classify it. Fapolicyd may differ from the file command.

-l, --list

Prints a listing of the fapolicyd rules file with a rule number to aid in troubleshooting or understanding of the debug messages.

-u, --update

Notifies fapolicyd to perform an update of the trust database.

-r, --reload-rules

Notifies fapolicyd to perform a reload of the rules.

## SEE ALSO
fapolicyd(8), fapolicyd.rules(5), fapolicyd.trust(5), and fapolicyd.conf(5)

## AUTHOR
Zoltan Fridrich


fcgiwrap

package: fcgiwrap

title: fcgiwrap(8)

summary: serve CGI applications over FastCGI

text:
# fcgiwrap(8)

## NAME
fcgiwrap - serve CGI applications over FastCGI

## SYNOPSIS
fcgiwrap [OPTIONS]

## DESCRIPTION
fcgiwrap is a simple server for running CGI applications over FastCGI. It hopes to provide clean CGI support to Nginx (and other web servers that may need it).

## OPTIONS
-c number

Number of fcgiwrap processes to prefork.

-f

Redirect STDERR output from executed CGI through FastCGI so it shows in the web server error log. Otherwise it would be returned on fcgiwrap's STDERR, which could be redirected. If running through spawn-fcgi, fcgiwrap's STDERR is sent to /dev/null, so this option provides a way to get that output back.

-s socket_url

A URL for the listen socket to bind to. By default fcgiwrap expects a listen socket to be passed on file descriptor 0, matching the FastCGI convention. The recommended way to deploy fcgiwrap is to run it under a process manager that takes care of opening the socket. However, for simple configurations and one-off tests this option may be used. Valid socket_urls include unix:/path/to/unix/socket, tcp:dot.ted.qu.ad:port and tcp6:[ipv6_addr]:port.

-h

Show a help message and exit.

## ENVIRONMENT
When running, fcgiwrap evaluates these environment variables set by the web server calling an fcgi-script. The variables DOCUMENT_ROOT and SCRIPT_NAME will be concatenated and the resulting executable run as CGI script wrapped as FastCGI, with the remainder after the script name available as PATH_INFO. To disable PATH_INFO mangling, set up your web server to pass SCRIPT_FILENAME, which should contain the complete path to the script. Then PATH_INFO will not be modified.

DOCUMENT_ROOT

directory which the script resides in

SCRIPT_NAME actual executable

SCRIPT_FILENAME complete path to CGI script. When set, overrides DOCUMENT_ROOT and SCRIPT_NAME

## EXAMPLE
The fastest way to see fcgiwrap do something is to launch it at the command line like this:

fcgiwrap -s unix:/var/run/fcgiwrap.sock

Apart from potential permission problems etc., it should be ready to accept FastCGI requests and run CGI scripts.

Most probably you will want to launch fcgiwrap by spawn-fcgi using a configuration like this:

FCGI_SOCKET=/var/run/fcgiwrap.sock

FCGI_PROGRAM=/usr/sbin/fcgiwrap

FCGI_USER=nginx

FCGI_GROUP=www

FCGI_EXTRA_OPTIONS="-M 0700"

ALLOWED_ENV="PATH"

Nginx can be configured to have the arbitrary CGI cgit run as FastCGI as follows:

location / {

fastcgi_param DOCUMENT_ROOT /var/www/localhost/htdocs/cgit/;

fastcgi_param SCRIPT_NAME cgit;

fastcgi_pass unix:/var/run/fastcgi.sock;

}

## AUTHOR
fcgiwrap was written by Grzegorz Nosek <root@localdomain.pl> with contributions by W-Mark Kubacki <wmark@hurrikane.de>.

This manual page was written by Jordi Mallach <jordi@debian.org> (with contributions by Grzegorz Nosek) for the Debian project (and may be used by others).


fcnsq

package: fcoe-utils

title: fcnsq(8)

summary: Fibre Channel Name Server Query Tool

text:
# fcnsq(8)

## NAME
fcnsq - Fibre Channel Name Server Query Tool

## SYNOPSIS
fcnsq host --gpn port_id [-q | --quiet]

fcnsq host --gnn port_id [-q | --quiet]

fcnsq host --gspn port_id [-q | --quiet]

fcnsq host --gsnn wwpn [-q | --quiet]

fcnsq ?

## DESCRIPTION
The fcnsq command performs Fibre Channel Name Server queries for a user-specified FC Host. The supported name server query commands include: Get Port Name (GPN), Get Node Name (GNN), Get Symbolic Node Name (GSNN), and Get Symbolic Port Name (GSPN) as described in FC-GS-3 for the Common Transport (CT) services.

fcnsq takes the host bsg name as the input for the target host. Host bsg name must be a valid bsg device, e.g., "host12" as derived from /dev/bsg/fc_host12. For each name server query command, the argument is either a Port ID or a World Wide Port Name. Port IDs and World Wide Names must be specified in hexadecimal. To disable verbose output, use the --quiet option.

## OPTIONS
host --gpn port_id

Get Port Name by Port ID for host.

host --gnn port_id

Get Node Name by Port ID for host.

host --gspn port_id

Get Symbolic Port Name by Port ID for host.

host --gsnn wwpn

Get Symbolic Node Name by World Wide Port Name for host.

-q, --quiet

Disable verbose output.

?

Display a help message with basic usage instructions.

## EXAMPLES
Query Get Port Name (GPN) from host12 for Port ID 0xbf0027

```
fcnsq host12 --gpn bf0027
```

Query Get Node Name (GNN) from host12 for Port ID 0xbf0027

```
fcnsq host12 --gnn bf0027
```

Query Get Symbolic Port Name (GSPN) from host12 for Port ID 0xbf0027

```
fcnsq host12 --gspn bf0027
```

Query Get Symbolic Node Name (GSNN) from host12 for WWWPN 0x1000001B213C9DDA

```
fcnsq host12 --gsnn 0x1000001B213C9DDA
```

## SEE ALSO
fcoeadm(8)

## SUPPORT
fcnsq is part of the fcoe-utils package, maintained through the Open-FCoE project. Resources for both developers and users can be found at the Open-FCoE website http://open-fcoe.org/.


fcoeadm

title: fcoeadm(8)

summary: The Open\-FCoE Administration Tool

text:
# fcoeadm(8)

## NAME
fcoeadm - The Open-FCoE Administration Tool

## SYNOPSIS
fcoeadm [-m|--mode fabric|vn2vn] -c|--create ethX

fcoeadm -d|--destroy ethX

fcoeadm -r|--reset ethX

fcoeadm -S|--Scan [ethX]

fcoeadm -i|--interface [ethX]

fcoeadm -f|--fcf [ethX]

fcoeadm -t|--target [ethX]

fcoeadm -l|--lun [ethX]

fcoeadm -s|--stats ethX [interval]

fcoeadm -b|--lesb ethX [interval]

fcoeadm -h|--help

fcoeadm -v|--version

## DESCRIPTION
The fcoeadm utility is the Fibre Channel over Ethernet (FCoE) management tool for the Open-FCoE project. fcoeadm may be used to create, destroy, and reset an FCoE instance on a given network interface. For these operations fcoeadm sends a command to a running fcoemon process, via a socket interface. fcoemon will then perform the requested operation.

fcoeadm also provides operations to query information about FCoE instances, including interface information, target information, LUN information, and port statistics. For much of this information, fcoeadm relies on the libhbalinux implementation of the HBA API. Only one operation may be given on a command.

## OPTIONS
-m, --mode fabric|vn2vn

Used together with the create option to control the FCoE mode of operation. The mode defaults to fabric but this option allows the selection of vn2vn mode.

## OPERATIONS
-c, --create ethX

Creates an FCoE instance based on the specified network interface. Note that if there is not an fcoemon configuration file for the interface (/etc/fcoe/cfg-ethX, see fcoemon), then the created FCoE instance will not require DCB.

-d, --destroy ethX

Destroys the FCoE instance on the specified network interface. This will not destroy FCoE instances created by fipvlan.

-r, --reset ethX

Resets the FCoE instance on the specified network interface. This will not reset FCoE instances created by fipvlan.

-S, --Scan ethX

Rescan for new targets and LUNs on the provided instance. This command will not rescan any NPIV instances created on the same port. This will not rescan any FCoE instance created by fipvlan.

-i, --interface [ethX]

Show information about the FCoE instance on the specified network interface, or all FCoE instances if no network interface is specified.

-f, --fcf [ethX]

Show information about the discovered Fibre Channel Forwarders (FCFs) on the specified network interface, or all discovered FCFs if no network interface is specified.

-t, --target [ethX]

Show information about the discovered targets associated with the FCoE instance on the specified network interface. If no network interface is specified, information about discovered targets from all FCoE instances will be shown.

-l, --lun [ethX]

Show detailed information about the discovered SCSI LUNs associated with the FCoE instance on the specified network interface. If no network interface is specified, information about SCSI LUNs from all FCoE instances will be shown.

-s, --stats ethX [interval]

Show the statistics (including FC4 statistics) of the FCoE connection on the specified network interface. The information will be displayed repeatedly until the user cancels the command. The statistics will be printed every specified interval (in seconds). interval should be specified as a whole number greater than 0. If interval is not specified, a default interval of one second is used.

-b, --lesb ethX [interval]

Show the Link Error Statistics Block (LESB) of the FCoE connection on the specified network interface. The information will be displayed repeatedly until the user cancels the command. The LESB statistics will be printed every specified interval (in seconds). interval should be specified in whole integers greater than 0. If the interval is not specified, a default interval of one second is used.

-h, --help

Displays the usage message of the fcoeadm command.

-v, --version

Displays the version of the fcoeadm command.

## INTERFACE NAMES
The actual name for ethX depends on the AUTO_VLAN setting in the fcoemon interface configuration (/etc/fcoe/cfg-ethX, see fcoemon).

If AUTO_VLAN is set to yes, the interface name ethX references the network device itself. If AUTO_VLAN is set to no, the interface name ethX references the VLAN device.

## EXAMPLES
Creates an FCoE instance on eth2.101

```
fcoeadm -c eth2.101
```

Creates an FCoE VN2VN instance on eth2.101

```
fcoeadm -m vn2vn -c eth2.101
```

Destroys the FCoE instance on eth2.101

```
fcoeadm -d eth2.101
```

Resets the FCoE instance on eth2.101

```
fcoeadm -r eth2.101
```

Show the information of all the adapters and their ports having FCoE instances created

```
fcoeadm -i
```

Show the information of all FCoE instances on interface eth3.

```
fcoeadm -i eth3
```

Show the information of all the discovered targets from all the ports having FCoE instances created (they may be on different adapter cards). A brief listing of discovered LUNs are listed after the target they are associated with, if any

```
fcoeadm -t
```

Show the information of all the discovered targets from a given port (eth3) having FCoE instance created. A brief listing of discovered LUNs are listed after each target they are associated with, if any

```
fcoeadm -t eth3
```

Show the detailed information of all the LUNs discovered on all FCoE connections

```
fcoeadm -l
```

Show the detailed information of all the LUNs associated with a specific interface

```
fcoeadm -l eth3.101
```

Show the statistics information of a specific port eth3 having FCoE instances created. The statistics are displayed one line per time interval. The default interval is one second if an interval is not specified

```
fcoeadm -s eth3
```

```
fcoeadm -s eth3 3
```

## SEE ALSO
fcoemon(8)

## SUPPORT
fcoeadm is part of the fcoe-utils package, maintained through the Open-FCoE project. Resources for both developers and users can be found at the Open-FCoE website http://open-fcoe.org/


fcoemon

title: fcoemon(8)

summary: Open\-FCoE service daemon

text:
# fcoemon(8)

## NAME
fcoemon - Open-FCoE service daemon

## SYNOPSIS
fcoemon [-f|--foreground] [-l|--legacy] [-d|--debug] [-s|--syslog]

fcoemon -h|--help

fcoemon -v|--version

## DESCRIPTION
The fcoemon daemon is the core component of the Open-FCoE management service.

The primary function of fcoemon is to control FCoE instances. fcoemon will create, destroy, reset, enable and disable FCoE instances based on system configuration, administrative commands, and runtime events.

On startup, fcoemon will create FCoE instances defined by the configuration files (see FILES section below). Since FCoE typically relies on the Data Center Bridging (DCB) capabilities of an Ethernet interface, fcoemon establishes a connection with the LLDP daemon lldpad to query the status of the DCB features on relevant Ethernet interfaces and receive DCB configuration change events.

During runtime, fcoemon will monitor network and lldpad events for the relevant Ethernet interfaces and perform appropriate actions (create, destroy, enable, disable) on the FCoE instances. fcoemon also provides a client interface via which the fcoeadm utility is able to issue commands.

Installation of the fcoe-utils package will set up an fcoe service which will control the execution of the fcoemon daemon.

## OPTIONS
-f, --foreground

Run fcoemon in the foreground.

-d, --debug

Enable debugging messages.

-l, --legacy

Force fcoemon to use the legacy /sys/module/libfcoe/parameters/ interface. The default is to use the newer /sys/bus/fcoe/ interfaces if they are available.

-s, --syslog

Use syslogd for logging. The default behavior is to log to stdout and stderr.

-h, --help

Show help message with basic usage instructions

-v, --version

Show the version of the fcoemon command.

## TERMINOLOGY
DCB

Data Center Bridging A set of Ethernet enhancement standards developed by the IEEE 802.1 Working Group.

See http://www.ieee802.org/1/pages/dcbridges.html for more information.

DCBX

DCB Capabilities Exchange Protocol, implemented by the DCB module of lldpad. DCBX exchanges DCB capabilities and configuration with a link partner as a series of values transferred using the Link Layer Discovery Protocol (LLDP).

PFC

Priority-based Flow Control, a DCB feature.

App:FCoE

The FCoE instance of application specific parameters in DCBX.

## CRITERIA USED FOR CONTROLLING THE FCOE INSTANCE
fcoemon uses two information sources for determining when to create an FCoE instance: the state of the network interface, which may be a VLAN interface, and, if required for the FCoE instance, the state of the DCB configuration on the physical Ethernet interface.

First of all, the network interface must be "up" for the FCoE instance to be created. Secondly, if the FCoE configuration indicates that DCB is required, then the following criteria must be satisfied before the FCoE interface is created:

•DCB is enabled on the Ethernet interface.

•The PFC DCB feature is enabled and operational.

•The App:FCoE DCB feature is enabled and operational.

•The priority indicated by the App:FCoE feature is also enabled for PFC.

Once the FCoE instance is created by fcoemon, it will only be destroyed under the following conditions:

•The driver for the Ethernet interface is unloaded.

•A user administratively destroys the FCoE instance using fcoeadm.

•The fcoemon daemon is terminated.

If DCB is required for the FCoE instance, and the DCB settings change after the interface is created, the following criteria are used to disable the FCoE instance:

•DCB is disabled on the Ethernet interface.

•The App:FCoE DCB feature is not enabled.

•The App:FCoE and PFC features are operational AND the priority indicated by App:FCoE is not enabled for PFC.

Otherwise, the FCoE instance will always remain enabled.

## CONFIGURATION
Once the fcoe-utils and lldpad packages have been installed and the corresponding services are running, there are a few simple configuration steps required to get an FCoE instance up and running. The following assumes that DCB will be required for the interface.

•Ensure that the configuration on the peer device (e.g. FCoE capable switch) has the necessary configurations (VLANs, DCB, DCBX).

•Configure any needed VLAN interfaces on the local system.

•Create and configure /etc/fcoe/cfg-<ifname> files for the network interfaces over which FCoE instances need to be created. See the FILES sections for details. Note that ifname may be for a VLAN interface.

•Restart the fcoe service (i.e. fcoemon).

•The default DCB configuration of an Ethernet interface managed by lldpad requires the following configuration using dcbtool.

```
dcbtool sc ethX dcb on          <-- enable DCB on the interface
dcbtool sc ethX app:fcoe e:1    <-- enable App:FCoE on the interface
```

These steps only need to be done one time. Note that if other DCB configuration changes have been made with dcbtool, then additional changes may need to be made in order to satisfy the DCB criteria for creating an FCoE instance. Consult dcbtool for details.

Once these configuration steps have been performed, use fcoeadm to query the status of the FCoE instances.

## FILES

### /etc/fcoe/config
This is the primary configuration file for the fcoe system service. The default options in this file are: DEBUG="no" and USE_SYSLOG="yes". The former is used to enable debugging messages from the fcoe service script and fcoemon (via the --debug option). The latter is to indicate if the log messages are to be output to the system log (via the --syslog option). SUPPORTED_DRIVERS is the list of drivers to automatically load during fcoe service start. Any changes to this file will require a restart of the fcoe service.

### /etc/sysconfig/fcoe
On systemd-enabled systems, this is the primary configuration file used for the fcoe system service. Add --debug to FCOEMON_OPTS to enable debug log messages. Any changes to this file will require a restart of the fcoe service.

### /etc/fcoe/cfg-<ifname>
These files are read by fcoemon on initialization. They are used to indicate which Ethernet or VLAN interfaces should have FCoE instances created. The option values in this file normally are: FCOE_ENABLE="yes", DCB_REQUIRED="yes", and AUTO_VLAN="yes", though if the variable values are omitted, they default to "no".

FCOE_ENABLE

is used to enable/disable creation of the FCoE instance. If FCoE_ENABLE is set to "no", then the other configuration values have no effect.

DCB_REQUIRED

indicates if the DCB service is required on the Ethernet interface.

AUTO_VLAN

indicates if VLAN discovery should be performed. If AUTO_VLAN is set to "yes", then once the link configuration has been validated, fcoemon will run run the FIP VLAN discovery protocol on the Ethernet interface. Network interfaces for any discovered FCoE VLANs will be automatically created, if they are not already configured, and FCoE instances will be created on the VLAN interfaces. If the network interface specified by the filename is already a VLAN interface, the AUTO_VLAN setting is ignored.

MODE

indicates whether operation will be in fabric or vn2vn mode. The default is fabric.

FIP_RESP

indicates whether a FIP responder should be activated on this device to support VLAN discovery in a vn2vn environment. The default is "no". Often this will be used on a vn2vn node also serving as a target. When using this option, the AUTO_VLAN should not be set and the supported VLANs should have configuration files supplied, constituting a static VLAN configuration that provides the information for the FIP responder to return. This should be set on a base device, which should probably have FCOE_ENABLE set to "no" since presumably FCoE operation will be on the configured VLANs.

Note that the attached Ethernet peer device (e.g. FCoE capable switch port) must have compatible settings For DCB and FCoE to function properly.

### /etc/init.d/fcoe
This is the fcoe system service script. This script is invoked by the init process or by the service command to start and stop the fcoemon. On systemd-enabled systems, fcoemon is controlled via the fcoe.service unit.

## VLAN NAMING CONVENTIONS
If a new VLAN device is created (see the description of the AUTO_VLAN setting above), it will have the name dev.vlan-fcoe; where dev is the name of the Ethernet parent device and vlan is the discovered VLAN ID number.

## SEE ALSO
fcoeadm(8) lldpad(8) lldptool(8) dcbtool(8)

## SUPPORT
fcoemon is part of the fcoe-utils package, maintained through the Open-FCoE project. Resources for both developers and users can be found at the Open-FCoE website http://open-fcoe.org/


fcping

title: fcping(8)

summary: Fibre Channel Ping (ELS ECHO) tool

text:
# fcping(8)

## NAME
fcping - Fibre Channel Ping (ELS ECHO) tool

## SYNOPSIS
fcping [-fqx] [ -i interval ] [ -c count ] [ -s size ] -h source target

source = interface | MAC | WWPN | FC-ID

target = -P WWPN | -N WWPN | -F FC-ID

## DESCRIPTION
The fcping command performs the Fibre Channel FC-LS-2 ECHO ELS command and displays the reply. The max payload for fcping is 2108 bytes. When no -c is given, fcping will continue until user interrupts.

## OPTIONS
-f

Flood ping

-q

Quiet! just print summary

-x

Hex dump of responses

-i interval

Wait interval seconds between each ping

-c count

Stop after sending count pings

-h source

Source is interface like ethX, MAC address, WWPN, or FC-ID

-s size

Byte-length of ping request payload (max 2108)

-F FC-ID

Destination port ID

-P WWPN

Destination world-wide port name

-N WWNN

Destination world-wide node name

## EXAMPLES
Sends ELS ECHO to Port FC-ID 0xbf0027 from interface n0.170 with max 3 pings.

```
fcping -c 3 -h n0.170 -F 0xbf0027
```

```
sending echo to 0xBF0027
echo    1 accepted                       16.170 ms
echo    2 accepted                        7.053 ms
echo    3 accepted                        6.803 ms
3 frames sent, 3 received 0 errors, 0.000% loss, avg. rt time 10.009 ms
```

Sends ELS ECHO to WWNN 0x1000001B213C9DDA from interface n0.170 with max 3 pings and payload size 1500 bytes

```
fcping -c 3 -h n0.170 -s 1500 -N 0x1000001B213C9DDA
```

```
sending echo to 0xBF0027
echo    1 accepted                        6.597 ms
echo    2 accepted                        6.925 ms
echo    3 accepted                       12.419 ms
3 frames sent, 3 received 0 errors, 0.000% loss, avg. rt time 8.647 ms
```

Sends ELS ECHO to WWNN 0x1000001B213C9DDA from interface n0.170 continuously with payload of 32 bytes and hex-dump the reply to the screen

```
fcping -x -h n0.170 -s 32 -N 0x1000001B213C9DDA
```

```
sending echo to 0xBF0027
echo    1 accepted                        6.937 ms
response length 32

     0 02000000 00000001 00010203 04050607

    10 08090a0b 0c0d0e0f 10111213 14151617
```

```
echo    2 accepted                        6.923 ms
response length 32

     0 02000000 00000002 00010203 04050607

    10 08090a0b 0c0d0e0f 10111213 14151617
```

```
echo    3 accepted                       84.929 ms
response length 32

     0 02000000 00000003 00010203 04050607

    10 08090a0b 0c0d0e0f 10111213 14151617
```

## SEE ALSO
fcoeadm(8)

## SUPPORT
fcping is part of the fcoe-utils package, maintained through the Open-FCoE project. Resources for both developers and users can be found at the Open-FCoE website http://open-fcoe.org/.


fcrls

title: fcrls(8)

text:
# fcrls(8)

## NAME
fcrls - Fibre Channel Read Link Error Status Block (RLS) tool

## SYNOPSIS
fcrls --port rport_bsg_name [--quiet]

fcrls --fcid rport_port_FC-ID [--quiet]

fcrls --help

## DESCRIPTION
The fcrls command performs Fibre Channel Read Link Error Status Block (RLS) ELS request (see FC-LS-2) via BSG over a given rport bsg name or FC-ID.

fcrls takes either a rport bsg name or a rport port FC-ID as the input. To disable verbose output, use the --quiet option.

## OPTIONS
--port rport_bsg_name

Send RLS to a rport by FC remote port bsg name, e.g., rport-7:0-1.

--fcid rport_port_FC-ID

Send RLS to a rport by port FC-ID, e.g., 0xce000d.

--quiet

Disable verbose output.

--help

Display a help message with basic usage instructions.

## EXAMPLES
Sends RLS to the FC remote port as rport-7:0-1

```
fcrls --port rport-7:0-1
```

Sends RLS to the FC remote port with 0xce000d as its port FC-ID

```
fcrls --fcid 0xce000d
```

## SEE ALSO
fcoeadm(8)

## SUPPORT
fcrls is part of the fcoe-utils package, maintained through the Open-FCoE project. Resources for both developers and users can be found at the Open-FCoE website http://open-fcoe.org/.


fipvlan

title: fipvlan(8)

text:
# fipvlan(8)

## NAME
fipvlan - Fibre Channel over Ethernet VLAN Discovery

## SYNOPSIS
fipvlan [-c|--create] [-d|--debug] [-s|--start] [-m|--mode fabric|vn2vn] [-u|--link-up] interfaces

fipvlan -a|--auto [-c|--create] [-d|--debug] [-s|--start] [-m|--mode fabric|vn2vn] [-l|--link-retry count] [-u|--link-up]

fipvlan -h|--help

fipvlan -v|--version

## DESCRIPTION
The fipvlan command performs Fibre Channel over Ethernet (FCoE) Initialization Protocol (FIP) VLAN Discovery over Ethernet interfaces. fipvlan can be used as a diagnostic tool to determine which VLANs have FCoE services available on a network, prior to configuring VLAN interfaces and the Open-FCoE initiator. fipvlan can also be used to create VLAN interfaces as they are discovered, and to start the Open-FCoE initiator. The --create and --start options are primarily intended to be used as part of an Open-FCoE boot solution. FCoE instances started in this way cannot be destroyed or reset by fcoeadm.

fipvlan takes a list of network interface names to run the VLAN discovery protocol over, or the --auto option to use all available Ethernet interfaces.

fipvlan will enable any interface which is found disabled. If no response is received on that interface it will be shutdown again when fipvlan terminates.

## OPTIONS
-a, --auto

Use all Ethernet interfaces currently available

-c, --create

Create network interfaces for discovered FCoE VLANs. If a VLAN device already exists for a discovered VLAN, a new VLAN device will not be created.

-d, --debug

Enable debugging output

-s, --start

Start the Open-FCoE initiator on discovered FCoE VLANs

-m, --mode

fabric|vn2vn Specify whether VLAN discovery is performed in the default fabric mode, or in VN2VN mode.

-f, --suffix suffix

Append the specified string suffix to VLAN interface names.

-l, --link-retry count

Retry check for link up to count times. The link state is checked every 1000 ms. The default number of retries is 20.

-u, --link-up

Leave link up if a FIP response has been received.

-h, --help

Display a help message with basic usage instructions

-v, --version

Display the fipvlan version string

## VLAN NAMING CONVENTIONS
If a new VLAN device is created, it will have the name dev.vlan; where dev is the name of the Ethernet parent device and vlan is the discovered VLAN ID number. An optional suffix may be appended to this with the the -f command line option.

## EXAMPLES
Display all discoverable VLANs with FCoE services

```
fipvlan --auto
```

Discover FCoE VLANs on interface eth2, create VLAN devices and start the Open-FCoE initiator

```
fipvlan --create --start eth2
```

In this example if FCoE services were available on VLAN 101 of network interface eth2, then a VLAN interface eth2.101 would be created and used as the parent device for the initiator.

## SEE ALSO
fcoeadm(8) fcoemon(8)

## SUPPORT
fipvlan is part of the fcoe-utils package, maintained through the Open-FCoE project. Resources for both developers and users can be found at the Open-FCoE website http://open-fcoe.org/


addpart

package: fdisk

title: addpart(8)

text:
# addpart(8)

## NAME
addpart - tell the kernel about the existence of a partition

## SYNOPSIS
addpart device partition start length

## DESCRIPTION
addpart tells the Linux kernel about the existence of the specified partition. The command is a simple wrapper around the "add partition" ioctl.

This command doesn’t manipulate partitions on a block device.

## PARAMETERS
device

The disk device.

partition

The partition number.

start

The beginning of the partition (in 512-byte sectors).

length

The length of the partition (in 512-byte sectors).

-h, --help

Display help text and exit.

-V, --version

Print version and exit.

## SEE ALSO
delpart(8), fdisk(8), parted(8), partprobe(8), partx(8)

## REPORTING BUGS
For bug reports, use the issue tracker at <https://github.com/util-linux/util-linux/issues>.

## AVAILABILITY
The addpart command is part of the util-linux package which can be downloaded from Linux Kernel Archive <https://www.kernel.org/pub/linux/utils/util-linux/>.


delpart

title: delpart(8)

text:
# delpart(8)

## NAME
delpart - tell the kernel to forget about a partition

## SYNOPSIS
delpart device partition

## DESCRIPTION
delpart asks the Linux kernel to forget about the specified partition (a number) on the specified device. The command is a simple wrapper around the "del partition" ioctl.

This command doesn’t manipulate partitions on a block device.

## OPTIONS
-h, --help

Display help text and exit.

-V, --version

Print version and exit.

## SEE ALSO
addpart(8), fdisk(8), parted(8), partprobe(8), partx(8)

## REPORTING BUGS
For bug reports, use the issue tracker at <https://github.com/util-linux/util-linux/issues>.

## AVAILABILITY
The delpart command is part of the util-linux package which can be downloaded from Linux Kernel Archive <https://www.kernel.org/pub/linux/utils/util-linux/>.


fdisk

title: fdisk(8)

summary: manipulate disk partition table

text:
# fdisk(8)

## NAME
fdisk - manipulate disk partition table

## SYNOPSIS
fdisk [options] device

fdisk -l [device...]

## DESCRIPTION
fdisk is a dialog-driven program for creation and manipulation of partition tables. It understands GPT, MBR, Sun, SGI and BSD partition tables.

Block devices can be divided into one or more logical disks called partitions. This division is recorded in the partition table, usually found in sector 0 of the disk. (In the BSD world one talks about `disk slices' and a `disklabel'.)

All partitioning is driven by device I/O limits (the topology) by default. fdisk is able to optimize the disk layout for a 4K-sector size and use an alignment offset on modern devices for MBR and GPT. It is always a good idea to follow fdisk's defaults as the default values (e.g., first and last partition sectors) and partition sizes specified by the +/-<size>{M,G,...} notation are always aligned according to the device properties.

CHS (Cylinder-Head-Sector) addressing is deprecated and not used by default. Please, do not follow old articles and recommendations with fdisk -S <n> -H <n> advices for SSD or 4K-sector devices.

Note that partx(8) provides a rich interface for scripts to print disk layouts, fdisk is mostly designed for humans. Backward compatibility in the output of fdisk is not guaranteed. The input (the commands) should always be backward compatible.

## OPTIONS
-b, --sector-size sectorsize

Specify the sector size of the disk. Valid values are 512, 1024, 2048, and 4096. (Recent kernels know the sector size. Use this option only on old kernels or to override the kernel’s ideas.) Since util-linux-2.17, fdisk differentiates between logical and physical sector size. This option changes both sector sizes to sectorsize.

-B, --protect-boot

Don’t erase the beginning of the first disk sector when creating a new disk label. This feature is supported for GPT and MBR.

-c, --compatibility[=mode]

Specify the compatibility mode, 'dos' or 'nondos'. The default is non-DOS mode. For backward compatibility, it is possible to use the option without the mode argument — then the default is used. Note that the optional mode argument cannot be separated from the -c option by a space, the correct form is for example -c=dos.

-h, --help

Display help text and exit.

-V, --version

Print version and exit.

-L, --color[=when]

Colorize the output. The optional argument when can be auto, never or always. If the when argument is omitted, it defaults to auto. The colors can be disabled; for the current built-in default see the --help output. See also the COLORS section.

-l, --list

List the partition tables for the specified devices and then exit. If no devices are given, the devices mentioned in /proc/partitions (if this file exists) are used. Devices are always listed in the order in which they are specified on the command-line, or by the kernel listed in /proc/partitions.

-x, --list-details

Like --list, but provides more details.

--lock[=mode]

Use exclusive BSD lock for device or file it operates. The optional argument mode can be yes, no (or 1 and 0) or nonblock. If the mode argument is omitted, it defaults to yes. This option overwrites environment variable $LOCK_BLOCK_DEVICE. The default is not to use any lock at all, but it’s recommended to avoid collisions with systemd-udevd(8) or other tools.

-n, --noauto-pt

Don’t automatically create a default partition table on empty device. The partition table has to be explicitly created by user (by command like 'o', 'g', etc.).

-o, --output list

Specify which output columns to print. Use --help to get a list of all supported columns. The default list of columns may be extended if list is specified in the format +list (e.g., -o +UUID).

-s, --getsz

Print the size in 512-byte sectors of each given block device. This option is DEPRECATED in favour of blockdev(8).

-t, --type type

Enable support only for disklabels of the specified type, and disable support for all other types.

-u, --units[=unit]

When listing partition tables, show sizes in 'sectors' or in 'cylinders'. The default is to show sizes in sectors. For backward compatibility, it is possible to use the option without the unit argument — then the default is used. Note that the optional unit argument cannot be separated from the -u option by a space, the correct form is for example '-u=cylinders'.

-C, --cylinders number

Specify the number of cylinders of the disk. I have no idea why anybody would want to do so.

-H, --heads number

Specify the number of heads of the disk. (Not the physical number, of course, but the number used for partition tables.) Reasonable values are 255 and 16.

-S, --sectors number

Specify the number of sectors per track of the disk. (Not the physical number, of course, but the number used for partition tables.) A reasonable value is 63.

-w, --wipe when

Wipe filesystem, RAID and partition-table signatures from the device, in order to avoid possible collisions. The argument when can be auto, never or always. When this option is not given, the default is auto, in which case signatures are wiped only when in interactive mode. In all cases detected signatures are reported by warning messages before a new partition table is created. See also wipefs(8) command.

-W, --wipe-partitions when

Wipe filesystem, RAID and partition-table signatures from a newly created partitions, in order to avoid possible collisions. The argument when can be auto, never or always. When this option is not given, the default is auto, in which case signatures are wiped only when in interactive mode and after confirmation by user. In all cases detected signatures are reported by warning messages before a new partition is created. See also wipefs(8) command.

-V, --version

Display version information and exit.

## DEVICES
The device is usually /dev/sda, /dev/sdb or so. A device name refers to the entire disk. Old systems without libata (a library used inside the Linux kernel to support ATA host controllers and devices) make a difference between IDE and SCSI disks. In such cases the device name will be /dev/hd* (IDE) or /dev/sd* (SCSI).

The partition is a device name followed by a partition number. For example, /dev/sda1 is the first partition on the first hard disk in the system. See also Linux kernel documentation (the Documentation/admin-guide/devices.txt file).

## SIZES
The "last sector" dialog accepts partition size specified by number of sectors or by +/-<size>{K,B,M,G,...} notation.

If the size is prefixed by '+' then it is interpreted as relative to the partition first sector. If the size is prefixed by '-' then it is interpreted as relative to the high limit (last available sector for the partition).

In the case the size is specified in bytes than the number may be followed by the multiplicative suffixes KiB=1024, MiB=1024*1024, and so on for GiB, TiB, PiB, EiB, ZiB and YiB. The "iB" is optional, e.g., "K" has the same meaning as "KiB".

The relative sizes are always aligned according to device I/O limits. The +/-<size>{K,B,M,G,...} notation is recommended.

For backward compatibility fdisk also accepts the suffixes KB=1000, MB=1000*1000, and so on for GB, TB, PB, EB, ZB and YB. These 10^N suffixes are deprecated.

## SCRIPT FILES
fdisk allows reading (by 'I' command) sfdisk(8) compatible script files. The script is applied to in-memory partition table, and then it is possible to modify the partition table before you write it to the device.

And vice-versa it is possible to write the current in-memory disk layout to the script file by command 'O'.

The script files are compatible between cfdisk(8), sfdisk(8), fdisk and other libfdisk applications. For more details see sfdisk(8).

## DISK LABELS
GPT (GUID Partition Table)

GPT is modern standard for the layout of the partition table. GPT uses 64-bit logical block addresses, checksums, UUIDs and names for partitions and an unlimited number of partitions (although the number of partitions is usually restricted to 128 in many partitioning tools). Note that the first sector is still reserved for a protective MBR in the GPT specification. It prevents MBR-only partitioning tools from mis-recognizing and overwriting GPT disks.

GPT is always a better choice than MBR, especially on modern hardware with a UEFI boot loader.

DOS-type (MBR)

A DOS-type partition table can describe an unlimited number of partitions. In sector 0 there is room for the description of 4 partitions (called `primary'). One of these may be an extended partition; this is a box holding logical partitions, with descriptors found in a linked list of sectors, each preceding the corresponding logical partitions. The four primary partitions, present or not, get numbers 1-4. Logical partitions are numbered starting from 5. In a DOS-type partition table the starting offset and the size of each partition is stored in two ways: as an absolute number of sectors (given in 32 bits), and as a Cylinders/Heads/Sectors triple (given in 10+8+6 bits). The former is OK — with 512-byte sectors this will work up to 2 TB. The latter has two problems. First, these C/H/S fields can be filled only when the number of heads and the number of sectors per track are known. And second, even if we know what these numbers should be, the 24 bits that are available do not suffice. DOS uses C/H/S only, Windows uses both, Linux never uses C/H/S. The C/H/S addressing is deprecated and may be unsupported in some later fdisk version.

Please, read the DOS-mode section if you want DOS-compatible partitions. fdisk does not care about cylinder boundaries by default.

BSD/Sun-type

A BSD/Sun disklabel can describe 8 partitions, the third of which should be a `whole disk' partition. Do not start a partition that actually uses its first sector (like a swap partition) at cylinder 0, since that will destroy the disklabel. Note that a BSD label is usually nested within a DOS partition.

IRIX/SGI-type

An IRIX/SGI disklabel can describe 16 partitions, the eleventh of which should be an entire `volume' partition, while the ninth should be labeled `volume header'. The volume header will also cover the partition table, i.e., it starts at block zero and extends by default over five cylinders. The remaining space in the volume header may be used by header directory entries. No partitions may overlap with the volume header. Also do not change its type or make some filesystem on it, since you will lose the partition table. Use this type of label only when working with Linux on IRIX/SGI machines or IRIX/SGI disks under Linux. A sync(2) and an ioctl(BLKRRPART) (rereading the partition table from disk) are performed before exiting when the partition table has been updated.

## DOS MODE AND DOS 6.X WARNING
Note that all this is deprecated. You don’t have to care about things like geometry and cylinders on modern operating systems. If you really want DOS-compatible partitioning then you have to enable DOS mode and cylinder units by using the '-c=dos -u=cylinders' fdisk command-line options.

The DOS 6.x FORMAT command looks for some information in the first sector of the data area of the partition, and treats this information as more reliable than the information in the partition table. DOS FORMAT expects DOS FDISK to clear the first 512 bytes of the data area of a partition whenever a size change occurs. DOS FORMAT will look at this extra information even if the /U flag is given — we consider this a bug in DOS FORMAT and DOS FDISK.

The bottom line is that if you use fdisk or cfdisk(8) to change the size of a DOS partition table entry, then you must also use dd(1) to zero the first 512 bytes of that partition before using DOS FORMAT to format the partition. For example, if you were using fdisk to make a DOS partition table entry for /dev/sda1, then (after exiting fdisk and rebooting Linux so that the partition table information is valid) you would use the command dd if=/dev/zero of=/dev/sda1 bs=512 count=1 to zero the first 512 bytes of the partition.

fdisk usually obtains the disk geometry automatically. This is not necessarily the physical disk geometry (indeed, modern disks do not really have anything like a physical geometry, certainly not something that can be described in the simplistic Cylinders/Heads/Sectors form), but it is the disk geometry that MS-DOS uses for the partition table.

Usually all goes well by default, and there are no problems if Linux is the only system on the disk. However, if the disk has to be shared with other operating systems, it is often a good idea to let an fdisk from another operating system make at least one partition. When Linux boots it looks at the partition table, and tries to deduce what (fake) geometry is required for good cooperation with other systems.

Whenever a partition table is printed out in DOS mode, a consistency check is performed on the partition table entries. This check verifies that the physical and logical start and end points are identical, and that each partition starts and ends on a cylinder boundary (except for the first partition).

Some versions of MS-DOS create a first partition which does not begin on a cylinder boundary, but on sector 2 of the first cylinder. Partitions beginning in cylinder 1 cannot begin on a cylinder boundary, but this is unlikely to cause difficulty unless you have OS/2 on your machine.

For best results, you should always use an OS-specific partition table program. For example, you should make DOS partitions with the DOS FDISK program and Linux partitions with the Linux fdisk or Linux cfdisk(8) programs.

## COLORS
The output colorization is implemented by terminal-colors.d(5) functionality. Implicit coloring can be disabled by an empty file

/etc/terminal-colors.d/fdisk.disable

for the fdisk command or for all tools by

/etc/terminal-colors.d/disable

The user-specific $XDG_CONFIG_HOME/terminal-colors.d or $HOME/.config/terminal-colors.d overrides the global setting.

Note that the output colorization may be enabled by default, and in this case terminal-colors.d directories do not have to exist yet.

The logical color names supported by fdisk are:

header

The header of the output tables.

help-title

The help section titles.

warn

The warning messages.

welcome

The welcome message.

## ENVIRONMENT
FDISK_DEBUG=all

enables fdisk debug output.

LIBFDISK_DEBUG=all

enables libfdisk debug output.

LIBBLKID_DEBUG=all

enables libblkid debug output.

LIBSMARTCOLS_DEBUG=all

enables libsmartcols debug output.

LIBSMARTCOLS_DEBUG_PADDING=on

use visible padding characters.

LOCK_BLOCK_DEVICE=<mode>

use exclusive BSD lock. The mode is "1" or "0". See --lock for more details.

## AUTHORS
Karel Zak <kzak@redhat.com>, Davidlohr Bueso <dave@gnu.org>

The original version was written by Andries E. Brouwer, A. V. Le Blanc and others.

## SEE ALSO
cfdisk(8), mkfs(8), partx(8), sfdisk(8)

## REPORTING BUGS
For bug reports, use the issue tracker at <https://github.com/util-linux/util-linux/issues>.

## AVAILABILITY
The fdisk command is part of the util-linux package which can be downloaded from Linux Kernel Archive <https://www.kernel.org/pub/linux/utils/util-linux/>.


partx

title: partx(8)

summary: tell the kernel about the presence and numbering of on\-disk partitions

text:
# partx(8)

## NAME
partx - tell the kernel about the presence and numbering of on-disk partitions

## SYNOPSIS
partx [-a|-d|-P|-r|-s|-u] [-t type] [-n M:_N_] [-] disk

partx [-a|-d|-P|-r|-s|-u] [-t type] partition [disk]

## DESCRIPTION
Given a device or disk-image, partx tries to parse the partition table and list its contents. It can also tell the kernel to add or remove partitions from its bookkeeping.

The disk argument is optional when a partition argument is provided. To force scanning a partition as if it were a whole disk (for example to list nested subpartitions), use the argument "-" (hyphen-minus). For example:

partx --show - /dev/sda3

This will see sda3 as a whole-disk rather than as a partition.

partx is not an fdisk program - adding and removing partitions does not change the disk, it just tells the kernel about the presence and numbering of on-disk partitions.

## OPTIONS
-a, --add

Add the specified partitions, or read the disk and add all partitions.

-b, --bytes

Print the sizes in bytes rather than in a human-readable format. By default, the unit, sizes are expressed in, is byte, and unit prefixes are in power of 2^10 (1024). Abbreviations of symbols are exhibited truncated in order to reach a better readability, by exhibiting alone the first letter of them; examples: "1 KiB" and "1 MiB" are respectively exhibited as "1 K" and "1 M", then omitting on purpose the mention "iB", which is part of these abbreviations.

-d, --delete

Delete the specified partitions or all partitions. It is not error to remove non-existing partitions, so this option is possible to use together with large --nr ranges without care about the current partitions set on the device.

-g, --noheadings

Do not print a header line with --show or --raw.

-l, --list

List the partitions. Note that all numbers are in 512-byte sectors. This output format is DEPRECATED in favour of --show. Do not use it in newly written scripts.

-n, --nr M:N

Specify the range of partitions. For backward compatibility also the format M-N is supported. The range may contain negative numbers, for example --nr -1:-1 means the last partition, and --nr -2:-1 means the last two partitions. Supported range specifications are: M

Specifies just one partition (e.g. --nr 3).

M:

Specifies the lower limit only (e.g. --nr 2:).

:N

Specifies the upper limit only (e.g. --nr :4).

M:N

Specifies the lower and upper limits (e.g. --nr 2:4).

-o, --output list

Define the output columns to use for --show, --pairs and --raw output. If no output arrangement is specified, then a default set is used. Use --help to get list of all supported columns. This option cannot be combined with the --add, --delete, --update or --list options.

--output-all

Output all available columns.

-P, --pairs

List the partitions using the KEY="value" format.

-r, --raw

List the partitions using the raw output format.

-s, --show

List the partitions. The output columns can be selected and rearranged with the --output option. All numbers (except SIZE) are in 512-byte sectors.

-t, --type type

Specify the partition table type.

--list-types

List supported partition types and exit.

-u, --update

Update the specified partitions.

-S, --sector-size size

Overwrite default sector size.

-v, --verbose

Verbose mode.

-h, --help

Display help text and exit.

-V, --version

Print version and exit.

## ENVIRONMENT
LIBBLKID_DEBUG=all

enables libblkid debug output.

## EXAMPLE
partx --show /dev/sdb3, partx --show --nr 3 /dev/sdb, partx --show /dev/sdb3 /dev/sdb

All three commands list partition 3 of /dev/sdb.

partx --show - /dev/sdb3

Lists all subpartitions on /dev/sdb3 (the device is used as whole-disk).

partx -o START -g --nr 5 /dev/sdb

Prints the start sector of partition 5 on /dev/sdb without header.

partx -o SECTORS,SIZE /dev/sda5 /dev/sda

Lists the length in sectors and human-readable size of partition 5 on /dev/sda.

partx --add --nr 3:5 /dev/sdd

Adds all available partitions from 3 to 5 (inclusive) on /dev/sdd.

partx -d --nr :-1 /dev/sdd

Removes the last partition on /dev/sdd.

## AUTHORS
Davidlohr Bueso <dave@gnu.org>, Karel Zak <kzak@redhat.com>

The original version was written by Andries E. Brouwer <aeb@cwi.nl>

## SEE ALSO
addpart(8), delpart(8), fdisk(8), parted(8), partprobe(8)

## REPORTING BUGS
For bug reports, use the issue tracker at <https://github.com/util-linux/util-linux/issues>.

## AVAILABILITY
The partx command is part of the util-linux package which can be downloaded from Linux Kernel Archive <https://www.kernel.org/pub/linux/utils/util-linux/>.


resizepart

title: resizepart(8)

text:
# resizepart(8)

## NAME
resizepart - tell the kernel about the new size of a partition

## SYNOPSIS
resizepart device partition length

## DESCRIPTION
resizepart tells the Linux kernel about the new size of the specified partition. The command is a simple wrapper around the "resize partition" ioctl.

This command doesn’t manipulate partitions on a block device.

## PARAMETERS
device

The disk device.

partition

The partition number.

length

The new length of the partition (in 512-byte sectors).

-h, --help

Display help text and exit.

-V, --version

Print version and exit.

## SEE ALSO
addpart(8), delpart(8), fdisk(8), parted(8), partprobe(8), partx(8)

## REPORTING BUGS
For bug reports, use the issue tracker at <https://github.com/util-linux/util-linux/issues>.

## AVAILABILITY
The resizepart command is part of the util-linux package which can be downloaded from Linux Kernel Archive <https://www.kernel.org/pub/linux/utils/util-linux/>.


feedbackd

package: feedbackd

title: feedbackd(8)

summary: A daemon to provide feedback on events

text:
# feedbackd(8)

## NAME
feedbackd - A daemon to provide feedback on events

## SYNOPSIS

```
feedbackd [OPTIONS...]
```

### DESCRIPTION
Feedbackd is a daemon that runs in the users session to trigger event feedback such as playing a sound, trigger a haptic motor or blink a LED.

The feedback triggered by a given event is determined by the feedback theme in use (see feedback-themes(5)). Events are submitted via a DBus API.

Any feedback triggered by a client via an event will be stopped latest when the client disconnects from DBus. This makes sure all feedbacks get canceled if the app that triggered it crashes.

For details refer to the event and feedback theme specs at https://gitlab.freedesktop.org/agx/feedbackd/.

Feedbackd reloads the feedback theme on SIGHUP (i.e. pkill -HUP feedbackd).

### Options
-h, --help

print help and exit

### Configuration
These gsettings are used by feedbackd:

•

org.gnome.desktop.sound

•

sound-theme: The sound theme used for sound events

•

org.sigxcpu.feedbackd

- profile: The current overall feedback profile. Valid values are full, quiet and silent.

- allow-important: List of apps that can override the feedback level (useful for e.g. allowing the alarm clock to also emit sound when device is in silent mode).

- prefer-flash: Prefer camera flash over status LED

- theme: The feedback theme to use. This can be used to override the feedback theme picked by feedbackd based on device information.

- max-haptic-strength: Limits th maximum strength used for the haptic motor [0.0, 1.0].

•

org.sigxcpu.feedbackd.application

•

profile: Per application profile levels. Valid values are

full, quiet and silent.

### See also
fbcli(1) fbd-theme-validate(1) feedback-themes(5) gsettings(1)


package: fence-agents-aliyun

title: fence_aliyun(8)

text:
# fence_aliyun(8)

## NAME
fence_aliyun - Fence agent for Aliyun (Aliyun Web Services)

## DESCRIPTION
fence_aliyun is a Power Fencing agent for Aliyun.

fence_aliyun accepts options on the command line as well as from stdin. Fenced sends parameters through stdin when it execs the agent. fence_aliyun can be run by itself with command line options. This is useful for testing and for turning outlets on or off from scripts.

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

## PARAMETERS

-o, --action=[action]

Fencing action (Default Value: reboot)

-n, --plug=[id]

Physical plug number on device, UUID or identification of machine This parameter is always required.

-r, --region=[name]

Region.

-a, --access-key=[name]

Access Key.

-s, --secret-key=[name]

Secret Key.

--ram-role=[name]

Ram Role.

--credentials-file=[path]

Path to credentials file

--credentials-file-profile=[profile]

Credentials file profile (Default Value: default)

--filter=[key=value]

Filter for list-action.

-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.

--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 given file

-V, --version

Display version information and exit

-h, --help

Display help and exit

--plug-separator=[char]

Separator for plug parameter when specifying more than 1 plug (Default Value: ,)

-C, --separator=[char]

Separator for CSV created by '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 cmd prompt after login (Default Value: 5)

--power-timeout=[seconds]

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

--power-wait=[seconds]

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

--shell-timeout=[seconds]

Wait X seconds for cmd prompt after issuing 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 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.

manpage

The operational behavior of this is not known.

validate-all

Validate if all required parameters are entered.

## STDIN PARAMETERS

action

Fencing action (Default Value: reboot)

plug

Physical plug number on device, UUID or identification of machine This parameter is always required. Obsoletes: port

region

Region.

access_key

Access Key.

secret_key

Secret Key.

ram_role

Ram Role.

credentials_file

Path to credentials file

credentials_file_profile

Credentials file profile (Default Value: default)

filter

Filter for list-action.

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: 60)

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)


package: fence-agents-alom

title: fence_alom(8)

text:
# fence_alom(8)

## NAME
fence_alom - Fence agent for Sun ALOM

## DESCRIPTION
fence_alom is a Power Fencing agent which can be used with ALOM connected machines.

fence_alom accepts options on the command line as well as from stdin. Fenced sends parameters through stdin when it execs the agent. fence_alom can be run by itself with command line options. This is useful for testing and for turning outlets on or off from scripts.

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

## PARAMETERS

-o, --action=[action]

Fencing action (Default Value: reboot)

-c, --command-prompt=[prompt]

Force Python regex for command prompt (Default Value: ['sc\>\ '])

-k, --identity-file=[filename]

Identity file (private key) for SSH

-4, --inet4-only

Forces agent to use IPv4 addresses only

-6, --inet6-only

Forces agent to use IPv6 addresses only

-a, --ip=[ip]

IP address or hostname of fencing device

-u, --ipport=[port]

TCP/UDP port to use for connection with device (Default Value: 22)

-p, --password=[password]

Login password or passphrase

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

Script to run to retrieve password

-n, --plug=[ip]

IP address or hostname of fencing device (together with --port-as-ip)

-x, --ssh

Use SSH connection (Default Value: 1)

--ssh-options=[options]

SSH options to use

-l, --username=[name]

Login name This parameter is always required.

-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.

--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 given file

-V, --version

Display version information and exit

-h, --help

Display help and exit

--plug-separator=[char]

Separator for plug parameter when specifying more than 1 plug (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 cmd prompt after login (Default Value: 5)

--port-as-ip

Make "port/plug" to be an alias to IP address

--power-timeout=[seconds]

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

--power-wait=[seconds]

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

--shell-timeout=[seconds]

Wait X seconds for cmd prompt after issuing 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)

--ssh-path=[path]

Path to ssh binary (Default Value: /usr/bin/ssh)

## ACTIONS

on

Power on machine.

off

Power off machine.

reboot

Reboot machine.

status

This returns the status of the plug/virtual machine.

monitor

Check the health of fence device

metadata

Display the XML metadata describing this resource.

manpage

The operational behavior of this is not known.

validate-all

Validate if all required parameters are entered.

## STDIN PARAMETERS

action

Fencing action (Default Value: reboot)

command_prompt

Force Python regex for command prompt (Default Value: ['sc\>\ ']) Obsoletes: cmd_prompt

identity_file

Identity file (private key) for SSH

inet4_only

Forces agent to use IPv4 addresses only

inet6_only

Forces agent to use IPv6 addresses only

ip

IP address or hostname of fencing device Obsoletes: ipaddr

ipport

TCP/UDP port to use for connection with device (Default Value: 22)

password

Login password or passphrase Obsoletes: passwd

password_script

Script to run to retrieve password Obsoletes: passwd_script

plug

IP address or hostname of fencing device (together with --port-as-ip) Obsoletes: port

ssh

Use SSH connection (Default Value: 1) Obsoletes: secure

ssh_options

SSH options to use

username

Login name This parameter is always required. Obsoletes: login

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: ,)

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)

port_as_ip

Make "port/plug" to be an alias to IP address

power_timeout

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

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)

ssh_path

Path to ssh binary (Default Value: /usr/bin/ssh)


package: fence-agents-amt

title: fence_amt(8)

text:
# fence_amt(8)

## NAME
fence_amt - Fence agent for AMT

## DESCRIPTION
fence_amt is a Power Fencing agent which can be used with Intel AMT. This agent calls support software amttool(http://www.kraxel.org/cgit/amtterm/).

fence_amt accepts options on the command line as well as from stdin. Fenced sends parameters through stdin when it execs the agent. fence_amt can be run by itself with command line options. This is useful for testing and for turning outlets on or off from scripts.

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

## PARAMETERS

-o, --action=[action]

Fencing action (Default Value: reboot)

-b, --boot-option=[option]

Change the default boot behavior of the machine. (pxe|hd|hdsafe|cd|diag)

-a, --ip=[ip]

IP address or hostname of fencing device

-u, --ipport=[port]

TCP/UDP port to use for connection with device (Default Value: 16994)

-m, --method=[method]

Method to fence (onoff|cycle) (Default Value: onoff)

-p, --password=[password]

Login password or passphrase

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

Script to run to retrieve password

-n, --plug=[ip]

IP address or hostname of fencing device (together with --port-as-ip)

-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.

--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 given file

-V, --version

Display version information and exit

-h, --help

Display help and exit

--plug-separator=[char]

Separator for plug parameter when specifying more than 1 plug (Default Value: ,)

--amttool-path=[path]

Path to amttool binary (Default Value: /usr/bin/amttool)

--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 cmd prompt after login (Default Value: 5)

--port-as-ip

Make "port/plug" to be an alias to IP address

--power-timeout=[seconds]

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

--power-wait=[seconds]

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

--shell-timeout=[seconds]

Wait X seconds for cmd prompt after issuing 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)

--use-sudo

Use sudo (without password) when calling 3rd party software

--sudo-path=[path]

Path to sudo binary (Default Value: /usr/bin/sudo)

## ACTIONS

on

Power on machine.

off

Power off machine.

reboot

Reboot machine.

status

This returns the status of the plug/virtual machine.

monitor

Check the health of fence device

metadata

Display the XML metadata describing this resource.

manpage

The operational behavior of this is not known.

validate-all

Validate if all required parameters are entered.

## STDIN PARAMETERS

action

Fencing action (Default Value: reboot)

boot_option

Change the default boot behavior of the machine. (pxe|hd|hdsafe|cd|diag)

ip

IP address or hostname of fencing device Obsoletes: ipaddr

ipport

TCP/UDP port to use for connection with device (Default Value: 16994)

method

Method to fence (onoff|cycle) (Default Value: onoff)

password

Login password or passphrase Obsoletes: passwd

password_script

Script to run to retrieve password Obsoletes: passwd_script

plug

IP address or hostname of fencing device (together with --port-as-ip) Obsoletes: port

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: ,)

amttool_path

Path to amttool binary (Default Value: /usr/bin/amttool)

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)

port_as_ip

Make "port/plug" to be an alias to IP address

power_timeout

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

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)

use_sudo

Use sudo (without password) when calling 3rd party software Obsoletes: sudo

sudo_path

Path to sudo binary (Default Value: /usr/bin/sudo)


package: fence-agents-apc

title: fence_apc(8)

text:
# fence_apc(8)

## NAME
fence_apc - Fence agent for APC over telnet/ssh

## DESCRIPTION
fence_apc is a Power Fencing agent which can be used with the APC network power switch. It logs into device via telnet/ssh and reboots a specified outlet. Lengthy telnet/ssh connections should be avoided while a GFS cluster is running because the connection will block any necessary fencing actions.

fence_apc accepts options on the command line as well as from stdin. Fenced sends parameters through stdin when it execs the agent. fence_apc can be run by itself with command line options. This is useful for testing and for turning outlets on or off from scripts.

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

## PARAMETERS

-o, --action=[action]

Fencing action (Default Value: reboot)

-c, --command-prompt=[prompt]

Force Python regex for command prompt (Default Value: ['0', '0pc>'])

-k, --identity-file=[filename]

Identity file (private key) for SSH

-4, --inet4-only

Forces agent to use IPv4 addresses only

-6, --inet6-only

Forces agent to use IPv6 addresses only

-a, --ip=[ip]

IP address or hostname of fencing device This parameter is always required.

-u, --ipport=[port]

TCP/UDP port to use for connection with device (Default Value: 23)

-p, --password=[password]

Login password or passphrase

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

Script to run to retrieve password

-n, --plug=[id]

Physical plug number on device, UUID or identification of machine This parameter is always required.

-x, --ssh

Use SSH connection

--ssh-options=[options]

SSH options to use (Default Value: -1 -c blowfish)

-s, --switch=[id]

Physical switch number on device

-l, --username=[name]

Login name This parameter is always required.

-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.

--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 given file

-V, --version

Display version information and exit

-h, --help

Display help and exit

--plug-separator=[char]

Separator for plug parameter when specifying more than 1 plug (Default Value: ,)

-C, --separator=[char]

Separator for CSV created by '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 cmd prompt after login (Default Value: 5)

--power-timeout=[seconds]

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

--power-wait=[seconds]

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

--shell-timeout=[seconds]

Wait X seconds for cmd prompt after issuing 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)

--ssh-path=[path]

Path to ssh binary (Default Value: /usr/bin/ssh)

--telnet-path=[path]

Path to telnet binary (Default Value: /usr/bin/telnet)

## 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.

manpage

The operational behavior of this is not known.

validate-all

Validate if all required parameters are entered.

## STDIN PARAMETERS

action

Fencing action (Default Value: reboot)

command_prompt

Force Python regex for command prompt (Default Value: ['0', '0pc>']) Obsoletes: cmd_prompt

identity_file

Identity file (private key) for SSH

inet4_only

Forces agent to use IPv4 addresses only

inet6_only

Forces agent to use IPv6 addresses only

ip

IP address or hostname of fencing device This parameter is always required. Obsoletes: ipaddr

ipport

TCP/UDP port to use for connection with device (Default Value: 23)

password

Login password or passphrase 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

ssh

Use SSH connection Obsoletes: secure

ssh_options

SSH options to use (Default Value: -1 -c blowfish)

switch

Physical switch number on device

username

Login name This parameter is always required. Obsoletes: login

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: 20)

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)

ssh_path

Path to ssh binary (Default Value: /usr/bin/ssh)

telnet_path

Path to telnet binary (Default Value: /usr/bin/telnet)


package: fence-agents-apc-snmp

title: fence_apc_snmp(8)

text:
# fence_apc_snmp(8)

## NAME
fence_apc_snmp - Fence agent for APC, Tripplite PDU over SNMP

fence_tripplite_snmp - Fence agent for Tripplife over SNMP (symlink)

## DESCRIPTION
fence_apc_snmp is a Power Fencing agent which can be used with the APC network power switch or Tripplite PDU devices.It logs into a device via SNMP and reboots a specified outlet. It supports SNMP v1, v2c, v3 with all combinations of authenticity/privacy settings.

fence_apc_snmp accepts options on the command line as well as from stdin. Fenced sends parameters through stdin when it execs the agent. fence_apc_snmp can be run by itself with command line options. This is useful for testing and for turning outlets on or off from scripts.

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

## PARAMETERS

-o, --action=[action]

Fencing action (Default Value: reboot)

-c, --community=[community]

Set the community string (Default Value: private)

-a, --ip=[ip]

IP address or hostname of fencing device This parameter is always required.

-u, --ipport=[port]

TCP/UDP port to use for connection with device (Default Value: 161)

-p, --password=[password]

Login password or passphrase

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

Script to run to retrieve password

-n, --plug=[id]

Physical plug number on device, UUID or identification of machine This parameter is always required.

-b, --snmp-auth-prot=[prot]

Set authentication protocol (MD5|SHA)

-P, --snmp-priv-passwd=[pass]

Set privacy protocol password

-R, --snmp-priv-passwd-script

Script to run to retrieve privacy password

-B, --snmp-priv-prot=[prot]

Set privacy protocol (DES|AES)

-E, --snmp-sec-level=[level]

Set security level (noAuthNoPriv|authNoPriv|authPriv)

-d, --snmp-version=[version]

Specifies SNMP version to use (1|2c|3) (Default Value: 1)

-l, --username=[name]

Login name

-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.

--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 given file

-V, --version

Display version information and exit

-h, --help

Display help and exit

--plug-separator=[char]

Separator for plug parameter when specifying more than 1 plug (Default Value: ,)

-C, --separator=[char]

Separator for CSV created by '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 cmd prompt after login (Default Value: 5)

--power-timeout=[seconds]

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

--power-wait=[seconds]

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

--shell-timeout=[seconds]

Wait X seconds for cmd prompt after issuing 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)

--snmpget-path=[path]

Path to snmpget binary (Default Value: /usr/bin/snmpget)

--snmpset-path=[path]

Path to snmpset binary (Default Value: /usr/bin/snmpset)

--snmpwalk-path=[path]

Path to snmpwalk binary (Default Value: /usr/bin/snmpwalk)

## 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.

manpage

The operational behavior of this is not known.

validate-all

Validate if all required parameters are entered.

## STDIN PARAMETERS

action

Fencing action (Default Value: reboot)

community

Set the community string (Default Value: private)

ip

IP address or hostname of fencing device This parameter is always required. Obsoletes: ipaddr

ipport

TCP/UDP port to use for connection with device (Default Value: 161)

password

Login password or passphrase 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

snmp_auth_prot

Set authentication protocol (MD5|SHA)

snmp_priv_passwd

Set privacy protocol password

snmp_priv_passwd_script

Script to run to retrieve privacy password

snmp_priv_prot

Set privacy protocol (DES|AES)

snmp_sec_level

Set security level (noAuthNoPriv|authNoPriv|authPriv)

snmp_version

Specifies SNMP version to use (1|2c|3) (Default Value: 1)

username

Login name Obsoletes: login

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: 20)

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)

snmpget_path

Path to snmpget binary (Default Value: /usr/bin/snmpget)

snmpset_path

Path to snmpset binary (Default Value: /usr/bin/snmpset)

snmpwalk_path

Path to snmpwalk binary (Default Value: /usr/bin/snmpwalk)


title: fence_tripplite_snmp(8)

text:
# fence_tripplite_snmp(8)

## NAME
fence_tripplite_snmp - Fence agent for APC, Tripplite PDU over SNMP

fence_tripplite_snmp - Fence agent for Tripplife over SNMP (symlink)

## DESCRIPTION
fence_tripplite_snmp is a Power Fencing agent which can be used with the APC network power switch or Tripplite PDU devices.It logs into a device via SNMP and reboots a specified outlet. It supports SNMP v1, v2c, v3 with all combinations of authenticity/privacy settings.

fence_tripplite_snmp accepts options on the command line as well as from stdin. Fenced sends parameters through stdin when it execs the agent. fence_tripplite_snmp can be run by itself with command line options. This is useful for testing and for turning outlets on or off from scripts.

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

## PARAMETERS

-o, --action=[action]

Fencing action (Default Value: reboot)

-c, --community=[community]

Set the community string (Default Value: private)

-a, --ip=[ip]

IP address or hostname of fencing device This parameter is always required.

-u, --ipport=[port]

TCP/UDP port to use for connection with device (Default Value: 161)

-p, --password=[password]

Login password or passphrase

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

Script to run to retrieve password

-n, --plug=[id]

Physical plug number on device, UUID or identification of machine This parameter is always required.

-b, --snmp-auth-prot=[prot]

Set authentication protocol (MD5|SHA)

-P, --snmp-priv-passwd=[pass]

Set privacy protocol password

-R, --snmp-priv-passwd-script

Script to run to retrieve privacy password

-B, --snmp-priv-prot=[prot]

Set privacy protocol (DES|AES)

-E, --snmp-sec-level=[level]

Set security level (noAuthNoPriv|authNoPriv|authPriv)

-d, --snmp-version=[version]

Specifies SNMP version to use (1|2c|3) (Default Value: 1)

-l, --username=[name]

Login name

-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.

--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 given file

-V, --version

Display version information and exit

-h, --help

Display help and exit

--plug-separator=[char]

Separator for plug parameter when specifying more than 1 plug (Default Value: ,)

-C, --separator=[char]

Separator for CSV created by '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 cmd prompt after login (Default Value: 5)

--power-timeout=[seconds]

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

--power-wait=[seconds]

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

--shell-timeout=[seconds]

Wait X seconds for cmd prompt after issuing 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)

--snmpget-path=[path]

Path to snmpget binary (Default Value: /usr/bin/snmpget)

--snmpset-path=[path]

Path to snmpset binary (Default Value: /usr/bin/snmpset)

--snmpwalk-path=[path]

Path to snmpwalk binary (Default Value: /usr/bin/snmpwalk)

## 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.

manpage

The operational behavior of this is not known.

validate-all

Validate if all required parameters are entered.

## STDIN PARAMETERS

action

Fencing action (Default Value: reboot)

community

Set the community string (Default Value: private)

ip

IP address or hostname of fencing device This parameter is always required. Obsoletes: ipaddr

ipport

TCP/UDP port to use for connection with device (Default Value: 161)

password

Login password or passphrase 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

snmp_auth_prot

Set authentication protocol (MD5|SHA)

snmp_priv_passwd

Set privacy protocol password

snmp_priv_passwd_script

Script to run to retrieve privacy password

snmp_priv_prot

Set privacy protocol (DES|AES)

snmp_sec_level

Set security level (noAuthNoPriv|authNoPriv|authPriv)

snmp_version

Specifies SNMP version to use (1|2c|3) (Default Value: 1)

username

Login name Obsoletes: login

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: 20)

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)

snmpget_path

Path to snmpget binary (Default Value: /usr/bin/snmpget)

snmpset_path

Path to snmpset binary (Default Value: /usr/bin/snmpset)

snmpwalk_path

Path to snmpwalk binary (Default Value: /usr/bin/snmpwalk)