title: pbs_resources_solaris5(7)

summary: pbs resources on SUN Solaris

text:
# pbs_resources_solaris5(7)

## NAME
pbs_resources_solaris - pbs resources on SUN Solaris

## DESCRIPTION
This page summarizes the resources supported by PBS for Sun workstations running Solaris 2.x. These resources are specified by including them in the -l option argument on the qsub or qalter command or in the PBS job script.

## RESOURCES
cput

Maximum amount of CPU time used by all processes in the job. Units: time.

file

The largest size of any single file that may be created by the job. Units: size.

nice

The nice value under which the job is to be run. Units: unitary.

pcput

Maximum amount of CPU time used by any single process in the job. Units: time.

pmem

Maximum amount of physical memory (workingset) used by any single process of the job. Units: size.

pvmem

Maximum amount of virtual memory used by any single process in the job. Units: size.

vmem

Maximum amount of virtual memory used by all concurrent processes in the job. Units: size.

walltime

Maximum amount of real time during which the job can be in the running state. Units: time.

arch

Specifies the administrator defined system architecture requried. This defaults to whatever the PBS_MACH string is set to in "local.mk". Units: string.

host

Name of host on which job should be run. This resource is provided for use by the site's scheduling policy. The allowable values and effect on job placement is site dependent. Units: string.

nodes

Number and/or type of nodes to be reserved for exclusive use by the job. The value is one or more node_specs joined with the '+' character, "node_spec[+node_spec...]. Each node_spec is an number of nodes required of the type declared in the node_spec and a name or one or more property or properties desired for the nodes. The number, the name, and each property in the node_spec are separated by a colon ':'. If no number is specified, one (1) is assumed. Units: string.

The name of a node is its hostname. The properties of nodes are:

.

ppn=# specifying the number of processors per node requested. Defaults to 1.

.

arbitrary string assigned by the system administrator, please check with your administrator as to the node names and properties available to you.

Examples:

.

To ask for 12 nodes of any type: -l nodes=12

.

To ask for 2 "server" nodes and 14 other nodes (a total of 16): -l nodes=2:server+14

The above consist of two node_specs "2:server" and "14".

.

To ask for (a) 1 node that is a "server" and has a "hippi" interface, (b) 10 nodes that are not servers, and (c) 3 nodes that have a large amount of memory an have hippi:

-l nodes=server:hippi+10:noserver+3:bigmem:hippi

.

To ask for three nodes by name:

-l nodes=b2005+b1803+b1813

.

To ask for 2 processors on each of four nodes:

-l nodes=4:ppn=2

.

To ask for 4 processors on one node:

-l nodes=1:ppn=4

.

To ask for 2 processors on each of two blue nodes and three processors on one red node:

-l nodes=2:blue:ppn=2+red:ppn=3

host

Allows a user to specify the desired execution location. This resource is provided for use by the site's scheduling policy. The allowable values and effect on job placement is site dependent. Units: string.

other

Allows a user to specify site specific information. This resource is provided for use by the site's scheduling policy. The allowable values and effect on job placement is site dependent. Units: string.

software

Allows a user to specify software required by the job. This is useful if certain software packages are only available on certain systems in the site. This resource is provided for use by the site's scheduling policy. The allowable values and effect on job placement is site dependent. Units: string.

## EXAMPLES
qsub -l nodes=15,walltime=2:00:00 script

or in a qsub script as a directive:

\#PBS -l nodes=15,walltime=2:00:00

qsub -l cput=1:00:00,walltime=2:00:00,file=50gb,vmem=15mb script

qalter -lcput=30:00 123.jobid

or in a qsub script as a directive:

\#PBS -l cput=1:00:00,walltime=2:00:00,file=50gb,vmem=15mb

## RESOURCE UNITS
The resource values take the following units:

time

specifies a maximum time period the resource can be used. Time is expressed in seconds as an integer, or in the form:

[[hours:]minutes:]seconds[.milliseconds]

size

specifies the maximum amount in terms of bytes or words. It is expressed in the form integer[suffix] The suffix is a multiplier defined in the following table, The size of a word is the word size on the execution host.

b or w

bytes or words.

kb or kw

Kilo (1024) bytes or words.

mb or mw

Mega (1,048,576) bytes or words.

gb or gw

Giga (1,073,741,824) bytes or words.

unitary

The maximum amount of a resource which is expressed as a simple integer.

## SEE ALSO
the PBS ERS, qsub(1B), qalter(1B), pbs_submit(3B), pbs_alterjob(3B), pbs_statjob(3b) pbs_resources_aix4(7B), pbs_resources_sp2(7B), pbs_resources_sunos4(7B), pbs_resources_unicos8(7B)


package: torque-client

title: pbs_resources_solaris7(7)

summary: pbs resources on SUN Solaris

text:
# pbs_resources_solaris7(7)

## NAME
pbs_resources_solaris - pbs resources on SUN Solaris

## DESCRIPTION
This page summarizes the resources supported by PBS for Sun workstations running Solaris 2.x. These resources are specified by including them in the -l option argument on the qsub or qalter command or in the PBS job script.

## RESOURCES
cput

Maximum amount of CPU time used by all processes in the job. Units: time.

file

The largest size of any single file that may be created by the job. Units: size.

nice

The nice value under which the job is to be run. Units: unitary.

pcput

Maximum amount of CPU time used by any single process in the job. Units: time.

pmem

Maximum amount of physical memory (workingset) used by any single process of the job. Units: size.

pvmem

Maximum amount of virtual memory used by any single process in the job. Units: size.

vmem

Maximum amount of virtual memory used by all concurrent processes in the job. Units: size.

walltime

Maximum amount of real time during which the job can be in the running state. Units: time.

arch

Specifies the administrator defined system architecture requried. This defaults to whatever the PBS_MACH string is set to in "local.mk". Units: string.

host

Name of host on which job should be run. This resource is provided for use by the site's scheduling policy. The allowable values and effect on job placement is site dependent. Units: string.

nodes

Number and/or type of nodes to be reserved for exclusive use by the job. The value is one or more node_specs joined with the '+' character, "node_spec[+node_spec...]. Each node_spec is an number of nodes required of the type declared in the node_spec and a name or one or more property or properties desired for the nodes. The number, the name, and each property in the node_spec are separated by a colon ':'. If no number is specified, one (1) is assumed. Units: string.

The name of a node is its hostname. The properties of nodes are:

.

ppn=# specifying the number of processors per node requested. Defaults to 1.

.

arbitrary string assigned by the system administrator, please check with your administrator as to the node names and properties available to you.

Examples:

.

To ask for 12 nodes of any type: -l nodes=12

.

To ask for 2 "server" nodes and 14 other nodes (a total of 16): -l nodes=2:server+14

The above consist of two node_specs "2:server" and "14".

.

To ask for (a) 1 node that is a "server" and has a "hippi" interface, (b) 10 nodes that are not servers, and (c) 3 nodes that have a large amount of memory an have hippi:

-l nodes=server:hippi+10:noserver+3:bigmem:hippi

.

To ask for three nodes by name:

-l nodes=b2005+b1803+b1813

.

To ask for 2 processors on each of four nodes:

-l nodes=4:ppn=2

.

To ask for 4 processors on one node:

-l nodes=1:ppn=4

.

To ask for 2 processors on each of two blue nodes and three processors on one red node:

-l nodes=2:blue:ppn=2+red:ppn=3

host

Allows a user to specify the desired execution location. This resource is provided for use by the site's scheduling policy. The allowable values and effect on job placement is site dependent. Units: string.

other

Allows a user to specify site specific information. This resource is provided for use by the site's scheduling policy. The allowable values and effect on job placement is site dependent. Units: string.

software

Allows a user to specify software required by the job. This is useful if certain software packages are only available on certain systems in the site. This resource is provided for use by the site's scheduling policy. The allowable values and effect on job placement is site dependent. Units: string.

## EXAMPLES
qsub -l nodes=15,walltime=2:00:00 script

or in a qsub script as a directive:

\#PBS -l nodes=15,walltime=2:00:00

qsub -l cput=1:00:00,walltime=2:00:00,file=50gb,vmem=15mb script

qalter -lcput=30:00 123.jobid

or in a qsub script as a directive:

\#PBS -l cput=1:00:00,walltime=2:00:00,file=50gb,vmem=15mb

## RESOURCE UNITS
The resource values take the following units:

time

specifies a maximum time period the resource can be used. Time is expressed in seconds as an integer, or in the form:

[[hours:]minutes:]seconds[.milliseconds]

size

specifies the maximum amount in terms of bytes or words. It is expressed in the form integer[suffix] The suffix is a multiplier defined in the following table, The size of a word is the word size on the execution host.

b or w

bytes or words.

kb or kw

Kilo (1024) bytes or words.

mb or mw

Mega (1,048,576) bytes or words.

gb or gw

Giga (1,073,741,824) bytes or words.

unitary

The maximum amount of a resource which is expressed as a simple integer.

## SEE ALSO
the PBS ERS, qsub(1B), qalter(1B), pbs_submit(3B), pbs_alterjob(3B), pbs_statjob(3b) pbs_resources_aix4(7B), pbs_resources_sp2(7B), pbs_resources_sunos4(7B), pbs_resources_unicos8(7B)


title: pbs_resources_sp2(7)

summary: pbs resources on IBM SP-2

text:
# pbs_resources_sp2(7)

## NAME
pbs_resources_sp2 - pbs resources on IBM SP-2

## DESCRIPTION
This page summarizes the resources supported by PBS for the IBM SP-2. These resources are specified by including them in the -l option argument on the qsub or qalter command or in the PBS job script.

## RESOURCES
nice

The nice value under which the job is to be run. Units: unitary.

walltime

Maximum amount of real time during which the job can be in the running state. Units: time.

arch

Specifies the administrator defined system architecture requried. This defaults to whatever the PBS_MACH string is set to in "local.mk". Units: string.

host

Name of host on which job should be run. This resource is provided for use by the site's scheduling policy. The allowable values and effect on job placement is site dependent. Units: string.

nodes

Number and/or type of nodes to be reserved for exclusive use by the job. The value is one or more node_specs joined with the '+' character, "node_spec[+node_spec...]. Each node_spec is an number of nodes required of the type declared in the node_spec and a name or one or more property or properties desired for the nodes. The number, the name, and each property in the node_spec are separated by a colon ':'. If no number is specified, one (1) is assumed. Units: string.

The name of a node is its hostname. The properties of nodes are:

.

ppn=# specifying the number of processors per node requested. Defaults to 1.

.

arbitrary string assigned by the system administrator, please check with your administrator as to the node names and properties available to you.

Examples:

.

To ask for 12 nodes of any type: -l nodes=12

.

To ask for 2 "server" nodes and 14 other nodes (a total of 16): -l nodes=2:server+14

The above consist of two node_specs "2:server" and "14".

.

To ask for (a) 1 node that is a "server" and has a "hippi" interface, (b) 10 nodes that are not servers, and (c) 3 nodes that have a large amount of memory an have hippi:

-l nodes=server:hippi+10:noserver+3:bigmem:hippi

.

To ask for three nodes by name:

-l nodes=b2005+b1803+b1813

.

To ask for 2 processors on each of four nodes:

-l nodes=4:ppn=2

.

To ask for 4 processors on one node:

-l nodes=1:ppn=4

.

To ask for 2 processors on each of two blue nodes and three processors on one red node:

-l nodes=2:blue:ppn=2+red:ppn=3

host

Allows a user to specify the desired execution location. This resource is provided for use by the site's scheduling policy. The allowable values and effect on job placement is site dependent. Units: string.

other

Allows a user to specify site specific information. This resource is provided for use by the site's scheduling policy. The allowable values and effect on job placement is site dependent. Units: string.

software

Allows a user to specify software required by the job. This is useful if certain software packages are only available on certain systems in the site. This resource is provided for use by the site's scheduling policy. The allowable values and effect on job placement is site dependent. Units: string.

## EXAMPLES
qsub -l nodes=15,walltime=2:00:00 script

or in a qsub script as a directive:

\#PBS -l nodes=15,walltime=2:00:00

## RESOURCE UNITS
The resource values take the following units:

time

specifies a maximum time period the resource can be used. Time is expressed in seconds as an integer, or in the form:

[[hours:]minutes:]seconds[.milliseconds]

unitary

The maximum amount of a resource which is expressed as a simple integer.

## SEE ALSO
the PBS ERS, qsub(1B), qalter(1B), pbs_submit(3B), pbs_alterjob(3B), pbs_statjob(3b) pbs_resources_aix4(7B), pbs_resources_irix5(7B) pbs_resources_sunos4(7B), pbs_resources_unicos8(7B)


title: pbs_resources_sunos4(7)

summary: pbs resources on SunOS 4

text:
# pbs_resources_sunos4(7)

## NAME
pbs_resources_sunos4 - pbs resources on SunOS 4

## DESCRIPTION
This page summarizes the resources supported by PBS for Sun workstations running SunOS 4.x. These resources are specified by including them in the -l option argument on the qsub or qalter command or in the PBS job script.

## RESOURCES
cput

Maximum amount of CPU time used by all processes in the job. Units: time.

file

The largest size of any single file that may be created by the job. Units: size.

nice

The nice value under which the job is to be run. Units: unitary.

pcput

Maximum amount of CPU time used by any single process in the job. Units: time.

pmem

Maximum amount of physical memory (workingset) used by any single process of the job. Units: size.

pvmem

Maximum amount of virtual memory used by any single process in the job. Units: size.

vmem

Maximum amount of virtual memory used by all concurrent processes in the job. Units: size.

walltime

Maximum amount of real time during which the job can be in the running state. Units: time.

arch

Specifies the administrator defined system architecture requried. This defaults to whatever the PBS_MACH string is set to in "local.mk". Units: string.

host

Name of host on which job should be run. This resource is provided for use by the site's scheduling policy. The allowable values and effect on job placement is site dependent. Units: string.

nodes

Number and/or type of nodes to be reserved for exclusive use by the job. The value is one or more node_specs joined with the '+' character, "node_spec[+node_spec...]. Each node_spec is an number of nodes required of the type declared in the node_spec and a name or one or more property or properties desired for the nodes. The number, the name, and each property in the node_spec are separated by a colon ':'. If no number is specified, one (1) is assumed. Units: string.

The name of a node is its hostname. The properties of nodes are:

.

ppn=# specifying the number of processors per node requested. Defaults to 1.

.

arbitrary string assigned by the system administrator, please check with your administrator as to the node names and properties available to you.

Examples:

.

To ask for 12 nodes of any type: -l nodes=12

.

To ask for 2 "server" nodes and 14 other nodes (a total of 16): -l nodes=2:server+14

The above consist of two node_specs "2:server" and "14".

.

To ask for (a) 1 node that is a "server" and has a "hippi" interface, (b) 10 nodes that are not servers, and (c) 3 nodes that have a large amount of memory an have hippi:

-l nodes=server:hippi+10:noserver+3:bigmem:hippi

.

To ask for three nodes by name:

-l nodes=b2005+b1803+b1813

.

To ask for 2 processors on each of four nodes:

-l nodes=4:ppn=2

.

To ask for 4 processors on one node:

-l nodes=1:ppn=4

.

To ask for 2 processors on each of two blue nodes and three processors on one red node:

-l nodes=2:blue:ppn=2+red:ppn=3

host

Allows a user to specify the desired execution location. This resource is provided for use by the site's scheduling policy. The allowable values and effect on job placement is site dependent. Units: string.

other

Allows a user to specify site specific information. This resource is provided for use by the site's scheduling policy. The allowable values and effect on job placement is site dependent. Units: string.

software

Allows a user to specify software required by the job. This is useful if certain software packages are only available on certain systems in the site. This resource is provided for use by the site's scheduling policy. The allowable values and effect on job placement is site dependent. Units: string.

## EXAMPLES
qsub -l nodes=15,walltime=2:00:00 script

or in a qsub script as a directive:

\#PBS -l nodes=15,walltime=2:00:00

qsub -l cput=1:00:00,walltime=2:00:00,file=50gb,mem=15mb script

qalter -lcput=30:00,pmem=8mb 123.jobid

or in a qsub script as a directive:

\#PBS -l cput=1:00:00,walltime=2:00:00,file=50gb,mem=15

## RESOURCE UNITS
The resource values take the following units:

time

specifies a maximum time period the resource can be used. Time is expressed in seconds as an integer, or in the form:

[[hours:]minutes:]seconds[.milliseconds]

size

specifies the maximum amount in terms of bytes or words. It is expressed in the form integer[suffix] The suffix is a multiplier defined in the following table, The size of a word is the word size on the execution host.

b or w

bytes or words.

kb or kw

Kilo (1024) bytes or words.

mb or mw

Mega (1,048,576) bytes or words.

gb or gw

Giga (1,073,741,824) bytes or words.

unitary

The maximum amount of a resource which is expressed as a simple integer.

## SEE ALSO
the PBS ERS, qsub(1B), qalter(1B), pbs_submit(3B), pbs_alterjob(3B), pbs_statjob(3b) pbs_resources_aix4(7B), pbs_resources_irix5(7B) pbs_resources_sp2(7B), pbs_resources_unicos8(7B)


title: pbs_resources_unicos8(7)

summary: pbs resources under Unicos

text:
# pbs_resources_unicos8(7)

## NAME
pbs_resources_unicos - pbs resources under Unicos

## DESCRIPTION
This page summarizes the resources and special features supported by PBS for Cray Research computers running Unicos versions 8 and 9. These resources are specified by including them in the -l option argument on the qsub or qalter command or in the PBS job script.

## RESOURCES
ncpus

Maximum number of multitask processes in the job. If this is set the environment variable NCPUS will be set to the given value. Units: unitary.

cput

Maximum amount of CPU time used by all processes in the job. Root processes are not limited, see limit(2). Units: time.

mem

Maximum amount of physical memory used by all concurrent processes in the job. Units: size.

mppe

The number of processing elements used by a single process in the job. Units: unitary.

mppt

Maximum amount of wall clock time used on the MPP in the job. Units: time.

mta, mtb, mtc, ..., mth

Maximum number of magnetic tape drives required in the corresponding device class of a, b, c, ..., h. Units: unitary.

nice

The nice value under which the job is to be run. Units: unitary.

pncpus

Maximum number of processors used by any single process in the job. Units: unitary.

pcput

Maximum amount of CPU time used by any single process in the job. Units: time.

pf

Maximum number of file system blocks that can be used by all process in the job. Units: size.

pmem

Maximum amount of physical memory used by any single process in the job. Units: size.

pmppt

Maximum amount of wall clock time used on the MPP by a single process in the job. Units: time.

ppf

Maximum number of file system blocks that can be used by a single process in the job. Units: size.

procs

Maximum number of processes in the job. Units: unitary.

psds

Maximum number of data blocks on the SDS (secondary data storage) for any process in the job.

sds

Maximum number of data blocks on the SDS (secondary data storage) for the job.

srfs_tmp

Session Reservable File System (SRFS) space in TMPDIR. Note, SRFS is not supported by Cray. Units: size.

srfs_wrk

SRFS space in WRKDIR. Units: size.

srfs_big

SRFS space in BIGDIR. Units: size.

srfs_fast

SRFS space in FASTDIR. Units: size.

walltime

Maximum amount of real time during which the job can be in the running state. Units: time.

arch

Specifies the administrator defined system architecture requried. This defaults to whatever the PBS_MACH string is set to in "local.mk". Units: string.

host

Name of host on which job should be run. This resource is provided for use by the site's scheduling policy. The allowable values and effect on job placement is site dependent. Units: string.

nodes

Number and/or type of nodes to be reserved for exclusive use by the job. The value is one or more node_specs joined with the '+' character, "node_spec[+node_spec...]. Each node_spec is an number of nodes required of the type declared in the node_spec and a name or one or more property or properties desired for the nodes. The number, the name, and each property in the node_spec are separated by a colon ':'. If no number is specified, one (1) is assumed. Units: string.

The name of a node is its hostname. The properties of nodes are:

.

ppn=# specifying the number of processors per node requested. Defaults to 1.

.

arbitrary string assigned by the system administrator, please check with your administrator as to the node names and properties available to you.

Examples:

.

To ask for 12 nodes of any type: -l nodes=12

.

To ask for 2 "server" nodes and 14 other nodes (a total of 16): -l nodes=2:server+14

The above consist of two node_specs "2:server" and "14".

.

To ask for (a) 1 node that is a "server" and has a "hippi" interface, (b) 10 nodes that are not servers, and (c) 3 nodes that have a large amount of memory an have hippi:

-l nodes=server:hippi+10:noserver+3:bigmem:hippi

.

To ask for three nodes by name:

-l nodes=b2005+b1803+b1813

.

To ask for 2 processors on each of four nodes:

-l nodes=4:ppn=2

.

To ask for 4 processors on one node:

-l nodes=1:ppn=4

.

To ask for 2 processors on each of two blue nodes and three processors on one red node:

-l nodes=2:blue:ppn=2+red:ppn=3

host

Allows a user to specify the desired execution location. This resource is provided for use by the site's scheduling policy. The allowable values and effect on job placement is site dependent. Units: string.

other

Allows a user to specify site specific information. This resource is provided for use by the site's scheduling policy. The allowable values and effect on job placement is site dependent. Units: string.

software

Allows a user to specify software required by the job. This is useful if certain software packages are only available on certain systems in the site. This resource is provided for use by the site's scheduling policy. The allowable values and effect on job placement is site dependent. Units: string.

## EXAMPLES
qsub -l nodes=15,walltime=2:00:00 script

or in a qsub script as a directive:

\#PBS -l nodes=15,walltime=2:00:00

qsub -l cput=1:00:00,pcput=20:00,file=50gb,mem=15mb,mta=2 script

qalter -lcput=30:00,pmem=8mb 123.jobid

qsub -lsrfs_tmp=50mb,srfs_big=2gw script

or in a qsub script as directives:

\#PBS -l cput=1:00:00,pcput=20:00,file=50gb,mem=15mb,mta=2

\#PBS -lsrfs_tmp=50mb,srfs_big=2gw

## SPECIAL FEATURES
Cray Unicos supports checkpoint and restart. Any description of checkpoint features in PBS are applicable to Unicos.

## RESOURCE UNITS
The resource values take the following units:

time

specifies a maximum time period the resource can be used. Time is expressed in seconds as an integer, or in the form:

[[hours:]minutes:]seconds[.milliseconds]

size

specifies the maximum amount in terms of bytes or words. It is expressed in the form integer[suffix] The suffix is a multiplier defined in the following table, The size of a word is the word size on the execution host.

b or w

bytes or words.

kb or kw

Kilo (1024) bytes or words.

mb or mw

Mega (1,048,576) bytes or words.

gb or gw

Giga (1,073,741,824) bytes or words.

unitary

The maximum amount of a resource which is expressed as a simple integer.

## SEE ALSO
the PBS ERS, qsub(1B), qalter(1B), pbs_submit(3B), pbs_alterjob(3B), pbs_statjob(3b) pbs_resources_aix4(7B), pbs_resources_irix5(7B) pbs_resources_sp2(7B), pbs_resources_sunos4(7B)


title: pbs_resources_unicosmk2(7)

summary: pbs resources under Unicos MK2

text:
# pbs_resources_unicosmk2(7)

## NAME
pbs_resources_unicosmk2 - pbs resources under Unicos MK2

## DESCRIPTION
This page summarizes the resources and special features supported by PBS for Cray Research computers running Unicos MK version 2. These resources are specified by including them in the -l option argument on the qsub or qalter command or in the PBS job script.

## RESOURCES
cput

Maximum amount of CPU time used by all processes in the job. Root processes are not limited, see limit(2). Units: time.

mem

Maximum amount of physical memory used by all concurrent processes in the job. Units: size.

mppe

The number of processing elements used by a single process in the job. Units: unitary.

mppt

Maximum amount of wall clock time used on the MPP in the job. Units: time.

mta, mtb, mtc, ..., mth

Maximum number of magnetic tape drives required in the corresponding device class of a, b, c, ..., h. Units: unitary.

nice

The nice value under which the job is to be run. Units: unitary.

pncpus

Maximum number of processors used by any single process in the job. Units: unitary.

pcput

Maximum amount of CPU time used by any single process in the job. Units: time.

pf

Maximum number of file system blocks that can be used by all process in the job. Units: size.

pmem

Maximum amount of physical memory used by any single process in the job. Units: size.

pmppt

Maximum amount of wall clock time used on the MPP by a single process in the job. Units: time.

ppf

Maximum number of file system blocks that can be used by a single process in the job. Units: size.

procs

Maximum number of processes in the job. Units: unitary.

psds

Maximum number of data blocks on the SDS (secondary data storage) for any process in the job.

sds

Maximum number of data blocks on the SDS (secondary data storage) for the job.

srfs_tmp

Session Reservable File System (SRFS) space in TMPDIR. Note, SRFS is not supported by Cray. Units: size.

srfs_wrk

SRFS space in WRKDIR. Units: size.

srfs_big

SRFS space in BIGDIR. Units: size.

srfs_fast

SRFS space in FASTDIR. Units: size.

walltime

Maximum amount of real time during which the job can be in the running state. Units: time.

arch

Specifies the administrator defined system architecture requried. This defaults to whatever the PBS_MACH string is set to in "local.mk". Units: string.

host

Name of host on which job should be run. This resource is provided for use by the site's scheduling policy. The allowable values and effect on job placement is site dependent. Units: string.

nodes

Number and/or type of nodes to be reserved for exclusive use by the job. The value is one or more node_specs joined with the '+' character, "node_spec[+node_spec...]. Each node_spec is an number of nodes required of the type declared in the node_spec and a name or one or more property or properties desired for the nodes. The number, the name, and each property in the node_spec are separated by a colon ':'. If no number is specified, one (1) is assumed. Units: string.

The name of a node is its hostname. The properties of nodes are:

.

ppn=# specifying the number of processors per node requested. Defaults to 1.

.

arbitrary string assigned by the system administrator, please check with your administrator as to the node names and properties available to you.

Examples:

.

To ask for 12 nodes of any type: -l nodes=12

.

To ask for 2 "server" nodes and 14 other nodes (a total of 16): -l nodes=2:server+14

The above consist of two node_specs "2:server" and "14".

.

To ask for (a) 1 node that is a "server" and has a "hippi" interface, (b) 10 nodes that are not servers, and (c) 3 nodes that have a large amount of memory an have hippi:

-l nodes=server:hippi+10:noserver+3:bigmem:hippi

.

To ask for three nodes by name:

-l nodes=b2005+b1803+b1813

.

To ask for 2 processors on each of four nodes:

-l nodes=4:ppn=2

.

To ask for 4 processors on one node:

-l nodes=1:ppn=4

.

To ask for 2 processors on each of two blue nodes and three processors on one red node:

-l nodes=2:blue:ppn=2+red:ppn=3

host

Allows a user to specify the desired execution location. This resource is provided for use by the site's scheduling policy. The allowable values and effect on job placement is site dependent. Units: string.

other

Allows a user to specify site specific information. This resource is provided for use by the site's scheduling policy. The allowable values and effect on job placement is site dependent. Units: string.

software

Allows a user to specify software required by the job. This is useful if certain software packages are only available on certain systems in the site. This resource is provided for use by the site's scheduling policy. The allowable values and effect on job placement is site dependent. Units: string.

## EXAMPLES
qsub -l nodes=15,walltime=2:00:00 script

or in a qsub script as a directive:

\#PBS -l nodes=15,walltime=2:00:00

qsub -l cput=1:00:00,pcput=20:00,file=50gb,mem=15mb,mta=2 script

qalter -lcput=30:00,pmem=8mb 123.jobid

qsub -lsrfs_tmp=50mb,srfs_big=2gw script

or in a qsub script as directives:

\#PBS -l cput=1:00:00,pcput=20:00,file=50gb,mem=15mb,mta=2

\#PBS -lsrfs_tmp=50mb,srfs_big=2gw

## SPECIAL FEATURES
Cray Unicos MK supports checkpoint and restart. Any description of checkpoint features in PBS are applicable to Unicos MK.

## RESOURCE UNITS
The resource values take the following units:

time

specifies a maximum time period the resource can be used. Time is expressed in seconds as an integer, or in the form:

[[hours:]minutes:]seconds[.milliseconds]

size

specifies the maximum amount in terms of bytes or words. It is expressed in the form integer[suffix] The suffix is a multiplier defined in the following table, The size of a word is the word size on the execution host.

b or w

bytes or words.

kb or kw

Kilo (1024) bytes or words.

mb or mw

Mega (1,048,576) bytes or words.

gb or gw

Giga (1,073,741,824) bytes or words.

unitary

The maximum amount of a resource which is expressed as a simple integer.

## SEE ALSO
the PBS ERS, qsub(1B), qalter(1B), pbs_submit(3B), pbs_alterjob(3B), pbs_statjob(3b) pbs_resources_aix4(7B), pbs_resources_irix5(7B) pbs_resources_sp2(7B), pbs_resources_sunos4(7B)


title: pbs_server_attributes(7)

summary: pbs server attributes

text:
# pbs_server_attributes(7)

## NAME
pbs_server_attributes - pbs server attributes

## DESCRIPTION
Server attributes can be read by any client; privilege is not required. Most server attributes are alterable by a privileged client, run by a user with administrator or operator privilege. Certain attributes require the user to have full administrator privilege. The following is a list of the server attributes.

accounting_keep_days

This defines the number of days that accounting files will be kept. Default value: unset - pbs_server will never delete accounting files Format: integer

acl_group_hosts

List of group/host combinations that authorize users to submit jobs. Groups are expanded on the server. Format: "group@hostname.domain[,...]"; default value: defer to acl_users.

acl_group_sloppy

This is a default value for the queue attribute of the same name. Format: boolean, "TRUE", "True", "true", "Y", "y", "1", "FALSE", "False", "false", "N", "n", "0"; default value: false = disabled.

acl_host_enable

Attribute which when true directs the server to use the acl_hosts access control lists. Requires full manager privilege to set or alter. Format: boolean, "TRUE", "True", "true", "Y", "y", "1", "FALSE", "False", "false", "N", "n", "0"; default value: false = disabled.

acl_hosts

List of hosts which may request services from this server. This list contains the network name of the hosts. Local requests, i.e. from the server's host itself, are aways accepted even if the host is not included in the list. See section 10.1, Authorization, in the PBS External Reference Specification. Requires full manager privilege to set or alter. Format: "[+|-]hostname.domain[,...]"; default value: all hosts.

acl_logic_or

This is a default value for the queue attribute of the same name. Format: boolean, "TRUE", "True", "true", "Y", "y", "1", "FALSE", "False", "false", "N", "n", "0"; default value: false = disabled.

acl_user_enable

Attribute which when true directs the server to use the server level acl_users access list. Requires full manager privilege to set or alter. Format: boolean (see acl_group_enable); default value: disabled.

acl_user_hosts

List of user/host combinations that authorize users to submit jobs. Format: "user@hostname.domain[,...]"; default value: defer to acl_users.

acl_users

List of users allowed or denied the ability to make any requests of this server. See section 10.1, Authorization, in the PBS External Reference Specification. If acl_user_enable is set to true, only users listed in acl_users may submit to or execute jobs in the queue. Requires full manager privilege to set or alter. Format: "[+|-]user[@host][,...]"; default value: all users allowed.

acl_roots

List of super users who may submit to and execute jobs at this server. If the job execution id would be zero (0), then the job owner, root@host, must be listed in this access control list or the job is rejected. Format: "[+|-]user[@host][,...]"; default value: no root jobs allowed.

allow_node_submit

Allow job submissions from compute nodes regardless of ruserok(). Requires full manager privilege to set or alter. Format: boolean; default value: disabled.

allow_proxy_user

Specifies users can proxy from one user to another. Proxy requests will be either validated by ruserok() or by the scheduler. Format: boolean; default value: false.

auto_node_np

Automatically configure a node's np value based on the ncpus value from the status update. Requires full manager privilege to set or alter. Format: boolean; default value: disabled.

automatic_requeue_exit_code

This is an exit code, defined by the admin, that tells pbs_server to requeue the job instead of considering it as completed. This allows the user to add some additional checks that the job can run meaningfully, and if not, then the job script exits with the specified code to be requeued. Format: long; default value: none.

clone_batch_delay

Number of seconds to delay between cloning a batch for a job array. Format: integer; default value: 1.

clone_batch_size

Number of jobs to clone in a batch for a job array. Format: integer; default value: 256.

credential_lifetime

The number of a seconds that a client connection may stay connected without re-authenticating. Default is 3600 seconds.

comment

A text string which may be set by the scheduler or other privileged client to provide information to the batch system users. Format: any string; default value: none.

copy_on_rerun

When set to true, copy the output and error files over to the user-specified directory when a job is rerun. Format: boolean; default value: false.

cray_enabled

When set to true, specifies that this instance of pbs_server has Cray hardware that reports to it. Format: boolean; default value: false.

default_node

A node specification to use if there is no other supplied specification. This attribute is only used by servers where a nodes file exist in the server_priv directory providing a list of nodes to the server. If the nodes file does not exist, this attribute is not set by default and is ignored if set. The default value allows for jobs to share a single node. Format: a node specification string; default value: 1#shared.

default_queue

The queue which is the target queue when a request does not specify a queue name. Format: a queue name; default value: none, must be set to an existing queue.

disable_automatic_requeue

Normally, if a job cannot start due to a transient error, the MOM returns a special exit code to the server so that the job is requeued instead of completed. When this parameter is set, the special exit code is ignored and the job is completed. Format: boolean; default value: false.

display_job_server_suffix

When set to TRUE, Torque will display both the job ID and the host name. When set to FALSE, only the job ID will be displayed. Format: boolean; default value: true.

dont_write_nodes_file

When set to TRUE, the nodes file cannot be overwritten for any reason; qmgr commands to edit nodes will be rejected. Format: boolean; default value: false.

note_append_on_error

Append the error string to the end of the current nodes note if MOM reports a message beginning with the string "ERROR". Format: boolean; default value: true.

down_on_error

Set a node's state to "down" if MOM reports a message beginning with the string "ERROR". This might interfere with moab's node error handling. See the HEALTH CHECK section in pbs_mom(8B). This is an EXPERIMENTAL feature and may be removed in the future. Format: boolean; default value: true.

disable_server_id_check

Makes it so the user for the job doesn't have to exist on the server. The user must still exist on all the compute nodes or the job will fail when it tries to execute. Format: boolean; default value: false

extra_resc

Add additional string-type job resources. They have no effect within TORQUE and are only advisible to the scheduler. They can not be used for resources_default/min/max. Format: list; default value: none.

interactive_jobs_can_roam

By default, interactive jobs run from the login node that they submitted from. When TRUE, interactive jobs may run on login nodes other than the one where the jobs were submitted to. Only applies when cray_enabled is set. Format: boolean; default value: false.

job_exclusive_on_use

When job_exclusive_on_use is set to TRUE, pbsnodes will show job-exclusive on a node when there's at least one of its processors running a job. This differs with the default behavior which is to show job-exclusive on a node when all of its processors are running a job. Format: boolean; default value: false.

job_force_cancel_time

If configured, number of seconds after a delete where a job will be purged by the server. If not configured, no such thing happens. Format: integer; default value: not used.

job_full_report_time

Sets the time in seconds that a job should be fully reported after any kind of change to the job, even if condensed output was requested. Format: integer; default value: 300 seconds.

job_log_file_max_size

This specifies a soft limit (in kilobytes) for the job log's maximum size. The file size is checked every five minutes and if the current day file size is greater than or equal to this value, it is rolled from <filename> to <filename.1> and a new empty log is opened. If the current day file size exceeds the maximum size a second time, the <filename.1> log file is rolled to <filename.2>, the current log is rolled to <filename.1>, and a new empty log is opened. Each new log causes all other logs to roll to an extension that is one greater than its current number. Any value less than 0 is ignored by pbs_server (meaning the log will not be rolled). Format: integer; default value: none.

job_log_file_roll_depth

This sets the maximum number of new log files that are kept in a day if the job_log_file_max_size parameter is set. For example, if the roll depth is set to 3, no file can roll higher than <filename.3>. If a file is already at the specified depth, such as <filename.3>, the file is deleted so it can be replaced by the incoming file roll, <filename.2>. Format: integer; default value: none.

job_log_keep_days

This maintains job logs for the number of days designated. If set to 4, any job log file older than 4 days old is deleted. Format: integer; default value: none.

job_nanny

Enables the "job deletion nanny" feature. All job cancels will create a repeating task that will resend KILL signals if the initial job cancel failed. Further job cancels will be rejected with the message "job cancel in progress." This is useful for temporary failures with a job's execution node during a job delete request. It is possible that the job nanny might interfere with job restarts, migrations, and checkpointing. Format: boolean; default value: false.

job_start_timeout

Specifies the pbs_server to pbs_mom TCP socket timeout in seconds that is used when the pbs_server sends a job start to the pbs_mom. It is useful when the mom has extra overhead involved in starting jobs. If not specified then the tcp_timeout value is used.

job_stat_rate

Moderates how often job stat requests will be issued from pbs_server to the MOM daemons. If poll_jobs is unset or false, then all jobs that haven't been updated in job_stat_rate seconds will trigger a stat request. If poll_jobs is true, then all jobs will be updated every job_stat_rate.

(see poll_jobs) On active clusters, 60 or 120 might be reasonable. Default value: 45 seconds (PBS_RESTAT_JOB in server_limits.h) Minimum value: 4 seconds (PBS_JOBSTAT_MIN in server_limits.h)

job_sync_timeout

When a stray job is reported on multiple nodes, the server sends a kill signal to one node at a time. This timeout determines how long the server waits between kills if the job is still being reported on any nodes. Format: integer; default value: 60.

keep_completed

Number of seconds to retain completed jobs in the C state. This is overridden by the execution queue attribute of the same name. Format: integer; default value: 0.

kill_delay

The amount of the time delay between the sending of SIGTERM and SIGKILL when a qdel command is issued against a running job. This is overridden by the execution queue attribute of the same name. Format: integer seconds; default value: 2 seconds.

lock_file

Specifies the name and location of the lock file used to determine which high availability server should be active.

If a full path is specified, it is used verbatim by TORQUE. If a relative path is specified, TORQUE will prefix it with $TORQUE_HOME/server_priv. Format: string; default value: $TORQUE_HOME/server_priv/server.lock

lock_file_update_time

Specifies how often (in seconds) the thread will update the lockfile. (for threaded high availability) Format: integer; default value: 3

lock_file_check_time

Specifies how often (in seconds) a high availability server will check to see if it should become active. (for threaded high availability) Must be greater than lock_file_update_time. Format: integer; default value: 9

log_events

A bit string which specifies the type of events which are logged, see the section on Event Logging in chapter 3 of the ERS. Format: integer; default value: 511, all events.

log_file_max_size

If this is set to a value > 0 then pbs_server will roll the current log file to logfile.1 when its size is greater than or equal to the value of log_file_max_size. This value is interpreted as kilobytes.

log_file_roll_depth

If this is set to a value >=1 and log_file_max_size is set then pbs_server will continue rolling the log files to logfile.log_file_roll_depth.

log_keep_days

If this is set then logs older than X days will be removed by the server. Format: integer; default value: not enforced;

log_level

Controls the verbosity of server logs. This value ranges from 0 to 7 with 7 representing maximum verbosity. Format: integer; default value: 0, minimum verbosity.

mail_body_fmt

Override the default format for the body of outgoing mail messages. A number of printf-like format specifiers and escape sequences can be used:

\n

new line

\t

horizontal tab

\\

backslash

\'

single quote

\"

double quote

%d

details concerning the message

%h

PBS host name

%i

PBS job identifier

%j

PBS job name

%m

long reason for message

%r

short reason for message

%%

a single %

Format: a printf-like format string; Default value: "PBS Job Id: %i\nJob Name: %j\nExec host: %h\n%m\n%d\n".

mail_domain

Override the default domain for outgoing mail messages. If set, emails will be addressed to "euser@mail_domain". If unset, the job's Job_Owner attribute will be used. If set to "never", TORQUE will never send emails. Format: a domain name; Default value: none.

mail_from

Set the From: header for all outgoing emails from pbs_server. Format: an email address; Default value: "adm".

mail_subject_fmt

Override the default format for the subject of outgoing mail messages. A number of printf-like format specifiers and escape sequences can be used:

\n

new line

\t

horizontal tab

\\

backslash

\'

single quote

\"

double quote

%d

details concerning the message

%h

PBS host name

%i

PBS job identifier

%j

PBS job name

%m

long reason for message

%r

short reason for message

%%

a single %

Format: a printf-like format string; Default value: "PBS JOB %i".

mail_uid

The uid from which server generated mail is sent to users. Format: integer uid; default value: 0 for root.

managers

List of users granted batch administrator privileges. Format: user@host.sub.domain[,user@host.sub.domain...]. The host, sub-domain, or domain name may be wild carded by the use of an * character, see the description of user access control lists in chapter 10.1.1 of the ERS. Requires full manager privilege to set or alter. Default value: root on the local host.

max_job_array_size

Specifies the maximum number of jobs that can be in any requested job array. Arrays requesting more jobs than configured will be rejected. Format: integer; default value: Unlimited.

max_slot_limit

No array can request a slot limit greater than 10. Any array that does not request a slot limit receives a slot limit of 10. Using the example above, slot requests greater than 10 are rejected. A slot limit is the maximum number of jobs from an array that can run concurrently. Format: integer; default value: Unlimited.

max_running

The maximum number of jobs allowed to be selected for execution at any given time. Advisory to the Scheduler, not enforced by the server. Format: integer.

max_user_run

The maximum number of jobs owned by a single user that are allowed to be running from this queue at one time. This attribute is advisory to the Scheduler, it is not enforced by the server. Format: integer; default value: none.

max_group_run

The maximum number of jobs owned by any users in a single group that are allowed to be running from this queue at one time. This attribute is advisory to the Scheduler, it is not enforced by the server. Format: integer; default value: none.

max_threads

This is the maximum number of threads that should exist in the thread pool at any time. Format: integer; default value: ((2 * the number of procs listed in /proc/cpuinfo) + 1) * 20

max_user_queuable

When set, max_user_queuable places a system-wide limit on the amount of jobs that an individual user can queue. Format: integer; default value: unlimited.

min_threads

This is the minimum number of threads that should exist in the thread pool at any time. Format: integer; default value: (2 * the number of procs listed in /proc/cpuinfo) + 1.

moab_array_compatible

This parameter places a hold on jobs that exceed the slot limit in a job array. When one of the active jobs is completed or deleted, one of the held jobs goes to a queued state. Format: boolean; default value: true.

mom_job_sync

Enables the "job sync on MOM" feature. When MOMs send a status update, and it includes a list of jobs, server will issue job deletes for any jobs that don't actually exist. Format: boolean; default value: true.

next_job_number

This hidden attribute is used to allow a manager to set the value of the next job ID via qmgr. This attribute should rarely be modified. Some sites may find it useful if they need to recreate their pbs_server database (perhaps due to a format change between major TORQUE versions) and they keep a database of job information indexed by the job ID. The manager should be careful to avoid setting the value to something that would allow the next job number to conflict with a job already queued, however Torque will handle this in a sane manner: the job submission will be rejected and the next job number will be incremented.

net_counter

Lists the 3 numbers representing the number of connections in the last 5 seconds, 30 seconds, and 60 seconds. This is a read-only attribute. Format: string; default value: none.

no_mail_force

This attribute can be set by a manager via qmgr. When set true, Torque will not force mail to be sent to the user when the jobs mail_points is set to "n". User will not receive notice of job failures or deletions. Format: boolean; default value: false.

node_check_rate

In OpenPBS, this was the rate at which pbs_server would poll each node. In TORQUE, nodes periodically send updates without solicitation from pbs_server; this attribute is now used as the maximum number of seconds allowed without an update before pbs_server will consider the node down. Format: integer; default value: 150

node_ping_rate

Specifies the maximum interval (in seconds) between successive pings sent from the pbs_server daemon to the pbs_mom daemon to determine node/daemon health. Format: integer; default value: 300

node_pack

Controls how multiple processor nodes are allocated to jobs. If this attribute is set to true, jobs will be assigned to the multiple processor nodes with the fewest free processors. This packs jobs into the fewest possible nodes leaving multiple processor nodes free for jobs which need many processors on a node. If set to false, jobs will be scattered across nodes reducing conflicts over memory between jobs. If unset, the jobs are packed on nodes in the order that the nodes are declared to the server (in the nodes file). Default value: unset - assigned to nodes as nodes in order that were declared.

node_suffix

Adds a domainname to node names before IP lookups. Format: string; default value: none.

np_default

np_default allows the administrator to unify the number of processors (np) on all nodes. The value can be dynamically changed. A value of 0 tells pbs_server to use the value of np found in the nodes file. The maximum value is 32767. Format: integer; default value: not used.

operators

List of users granted batch operator privileges. Format of the list is identical with managers above. Requires full manager privilege to set or alter. Default value: root on the local host.

owner_purge

Allows job owners to forcibly purge their own jobs from the server. This short-circuits the normal flow of events and is hightly discouraged. Default value: unset

pass_cpuclock

If set to TRUE, the pbs_server daemon passes the option and its value to the pbs_mom daemons for direct implementation by the daemons, making the CPU frequency adjustable as part of a resource request by a job submission. If set to FALSE, the pbs_server daemon creates and passes a PBS_CPUCLOCK job

environment variable to the pbs_mom daemons that contains the value of the cpuclock attribute used as part of a resource request by a job submission. The CPU frequencies on the MOMs are not adjusted. The environment variable is for use by prologue and epilogue scripts, enabling administrators to log and research when users are making cpuclock requests, as well as researchers and developers to perform CPU clock frequency changes using a method outside of that employed by the Torque pbs_mom daemons. Format: boolean; default value: true.

poll_jobs

Controls how pbs_server will send job status requests to MOMs. When unset or false, statjob requests from clients (ie: qstat(1B) or the scheduler) may trigger job status requests to MOMs and and must wait until the MOMs have replied; this is suitable for small to medium sized clusters. When set to true, pbs_server will send periodic job status requests; this is suitable for busy clusters with lots of jobs, lots of clients, qstat(1B) is too slow, or your scheduler times out. (see job_stat_rate) Default value: TRUE

query_other_jobs

The setting of this attribute controls if general users, other than the job owner, are allowed to query the status of or select the job. Format: boolean (see acl_host_enable); Requires full manager privilege to set or alter. default value: false - users may not query or select jobs owned by other users.

record_job_info

This must be set to TRUE in order for job logging to be enabled. Format: boolean; default value: false.

record_job_script

If set to TRUE, this adds the contents of the script executed by a job to the log. For record_job_script to take effect, record_job_info must be set to TRUE. Format: boolean; default value: false.

resources_available

The list of resource and amounts available to jobs run by this server. The sum of the resource of each type used by all jobs running by this server cannot exceed the total amount listed here. Advisory to the Scheduler, not enforced by the server. Format: "resources_available.resource_name=value[,...]".

resources_cost

The cost factors of various types of resources. These values are used in determining the order of releasing members of synchronous job sets, see the section on Synchronize Job Starts. For the most part, these value are purely arbitrary and have meaning only in the relative values between systems. The cost of the resources requested by a job is the sum of the products of the various resources_cost s and the amount of each resource requested by the job. It is not necessary to assign a cost for each possible resource, only those which the site wishes to be considered in synchronous job scheduling. Format: "resources_cost.resource_name=value[,...]"; default value: none, cost of resource is not computed.

resources_default

The list of default resource values that are set as limits for a job executing on this server when the job does not specify a limit, and there is no queue default. Format: "resources_default.resource_name=value[,...]"; default value: no limit.

resources_max

The maximum amount of each resource which can be requested by a single job executing on this server if there is not a resources_max valued defined for the queue in which the job resides. Format: "resources_max.resource_name=value[,...]"; default value: infinite usage.

sched_version

A string specifying the scheduler version. Schedulers should check this string when starting and not become active if the wrong string is found. This is ignored by pbs_server.

scheduler_iteration

Has no effect.

scheduling

Controls if the server will request job scheduling by the PBS job scheduler. If true, the scheduler will be called as required; if false, the scheduler will not be called and no job will be placed into execution unless the server is directed to do so by an operator or administrator. Setting or resetting this attribute to true results in an immediate call to the scheduler. For more information, see the section Scheduler - Server Interaction in the PBS Administrator Guide. Format: boolean (see acl_host_enable); default value: value of -a option when server is invoked, if -a is not specified, the value is recovered from the prior server run. If it has never been set, the value is "false".

server_name

The name of the server which is the same as the host name. If the hostname resolves to an external IP address, then set this to a name that resolves to the internal IP.

submit_hosts

A list of hostnames allowed to submit jobs to this batch server regardless of ruserok().

system_cost

An arbitrary value factored into the resource cost of any job managed by this server for the purpose of selecting which member of synchronous set is released first, see resources_cost and section 3.2.2, Synchronize Job Starts. [default value: none, cost of resource is not computed]

tcp_timeout

Specifies the pbs_server to pbs_mom TCP socket timeout in seconds. Format: integer; default value: 6.

thread_idle_seconds

This is the number of seconds a thread can be idle in the thread pool before it is deleted. If threads should not be deleted, set to -1. Torque will always maintain at least min_threads number of threads, even if all are idle. Format: integer; default value: 300.

timeout_for_job_delete

The specific timeout used when deleting jobs because the node they are executing on is being deleted. Format: integer; default value: 120.

timeout_for_job_requeue

The specific timeout used when requeuing jobs because the node they are executing on is being deleted. Format: integer; default value: 120.

use_jobs_subdirs

Lets an administrator direct the way pbs_server will store its job-related files. When use_jobs_subdirs is unset (or set to FALSE), job and job array files will be stored directly under $PBS_HOME/server_priv/jobs and $PBS_HOME/server_priv/arrays. When use_job_subdirs is set to TRUE, job and job array files will be distributed over 10 subdirectories under their respective parent directories. This method helps to keep a smaller number of files in a given directory. Format: boolean; default value: false.

The following attributes are read-only, they are maintained by the server and cannot be changed by a client.

pbs_version

The release version number of the server.

resources_assigned

The total amount of certain types of resources allocated to running jobs.

server_state

The current state of the server:

Active

The server is running and will invoke the job scheduler as required to schedule jobs for execution.

Idle

The server is running but will not invoke the job scheduler.

Scheduling

The server is running and there is an outstanding request to the job scheduler.

Terminating

The server is terminating. No additional jobs will be scheduled.

Terminating, Delayed

The server is terminating in delayed mode. The server will not run any new jobs and will shutdown when the last currently executing job completes.

state_count

The total number of jobs managed by the server currently in each state.

total_jobs

The total number of jobs currently managed by the server.

## SEE ALSO
the PBS ERS, qmgr(1B), pbs_resources(7B)


title: tss2-tcti-tabrmd(7)

summary: tabrmd TCTI library

text:
# tss2-tcti-tabrmd(7)

## NAME
tcti-tabrmd - tabrmd TCTI library

## SYNOPSIS
A TPM Command Transmission Interface (TCTI) module for interaction with the tpm2-abrmd.

## DESCRIPTION
tcti-tabrmd is a library that abstracts the IPC magic necessary to communicate with the tpm2-abrmd. Consult the “TSS System Level API and TPM Command Transmission Interface Specification” for a detailed discussion of the TCTI API.

## AUTHOR
Philip Tricca <philip.b.tricca@intel.com>

## SEE ALSO
tpm2-abrmd(8)

## COLOPHON
This page is part of the 3.0.0 release of Intel's TPM2 Access Broker & Resource Management Daemon. A description of the project, information about reporting bugs, and the latest version of this page can be found at https://github.com/01org/tpm2-abrmd/.


tuned-profiles

package: tuned

title: tuned-profiles(7)

text:
# tuned-profiles(7)

## NAME
tuned-profiles - description of basic TuneD profiles

## DESCRIPTION
These are the base profiles which are mostly shipped in the base tuned package. They are targeted to various goals. Mostly they provide performance optimizations but there are also profiles targeted to low power consumption, low latency and others. You can mostly deduce the purpose of the profile by its name or you can see full description below.

The profiles are stored in subdirectories below /usr/lib/tuned/profiles/. If you need to customize the profiles, you can copy them to /etc/tuned/profiles/ and modify them as you need. When loading profiles with the same name, /etc/tuned/profiles/ takes precedence. In such case you will not lose your customized profiles between TuneD updates.

The power saving profiles contain settings that are typically not enabled by default as they will noticeably impact the latency/performance of your system as opposed to the power saving mechanisms that are enabled by default. On the other hand the performance profiles disable the additional power saving mechanisms of TuneD as they would negatively impact throughput or latency.

## PROFILES
At the moment we're providing the following pre-defined profiles:

balanced

It is the default profile. It provides balanced power saving and performance. At the moment it enables CPU and disk plugins of TuneD and it makes sure the conservative governor is active (if supported by the current cpufreq driver). It enables ALPM power saving for SATA host adapters and sets the link power management policy to medium_power. It also sets the CPU energy performance bias to normal. It also enables AC97 audio power saving or (it depends on your system) HDA-Intel power savings with 10 seconds timeout. In case your system contains supported Radeon graphics card (with enabled KMS) it configures it to automatic power saving.

balanced-battery

Profile mainly used by tuned-ppd if balanced profile is requested and machine runs on battery. It's based on the balanced profile. It additionaly sets energy_performance_preference to balance_power, enables amd-pstate core performance boost, and enables video panel_power_savings.

powersave

Maximal power saving, at the moment it enables USB autosuspend (in case environment variable USB_AUTOSUSPEND is set to 1), enables ALPM power saving for SATA host adapters and sets the link power management policy to min_power. It also enables WiFi power saving and makes sure the ondemand governor is active (if supported by the current cpufreq driver). It sets the CPU energy performance bias to powersave. It also enables AC97 audio power saving or (it depends on your system) HDA-Intel power savings (with 10 seconds timeout). In case your system contains supported Radeon graphics card (with enabled KMS) it configures it to automatic power saving. On Asus Eee PCs dynamic Super Hybrid Engine is enabled.

throughput-performance

Profile for typical throughput performance tuning. Disables power saving mechanisms and enables sysctl settings that improve the throughput performance of your disk and network IO. CPU governor is set to performance and CPU energy performance bias is set to performance. Disk readahead values are increased.

accelerator-performance

This profile contains the same tuning as the throughput-performance profile. Additionally, it locks the CPU to low C states so that the latency is less than 100us. This improves the performance of certain accelerators, such as GPUs.

latency-performance

Profile for low latency performance tuning. Disables power saving mechanisms. CPU governor is set to performance and locked to the low C states (by PM QoS). CPU energy performance bias to performance.

network-throughput

Profile for throughput network tuning. It is based on the throughput-performance profile. It additionally increases kernel network buffers.

network-latency

Profile for low latency network tuning. It is based on the latency-performance profile. It additionally disables transparent hugepages, NUMA balancing and tunes several other network related sysctl parameters.

desktop

Profile optimized for desktops based on balanced profile. It additionally enables scheduler autogroups for better response of interactive applications.

hpc-compute

Profile optimized for high-performance computing. It is based on the latency-performance profile.

virtual-guest

Profile optimized for virtual guests based on throughput-performance profile. It additionally decreases virtual memory swappiness and increases dirty_ratio settings.

virtual-host

Profile optimized for virtual hosts based on throughput-performance profile. It additionally enables more aggressive writeback of dirty pages.

intel-sst

Profile optimized for systems with user-defined Intel Speed Select Technology configurations. This profile is intended to be used as an overlay on other profiles (e.g. cpu-partitioning profile), example: tuned-adm profile cpu-partitioning intel-sst

optimize-serial-console

Profile which tunes down I/O activity to the serial console by reducing the printk value. This should make the serial console more responsive. This profile is intended to be used as an overlay on other profiles (e.g. throughput-performance profile), example: tuned-adm profile throughput-performance optimize-serial-console

aws

Profile optimized for AWS EC2 instances. It is based on the throughput-performance profile.

## FILES

```
/etc/tuned/profiles/*
/usr/lib/tuned/profiles/*
```

## SEE ALSO
tuned(8) tuned-adm(8) tuned-profiles-atomic(7) tuned-profiles-sap(7) tuned-profiles-sap-hana(7) tuned-profiles-oracle(7) tuned-profiles-realtime(7) tuned-profiles-nfv-host(7) tuned-profiles-nfv-guest(7) tuned-profiles-cpu-partitioning(7) tuned-profiles-compat(7) tuned-profiles-postgresql(7) tuned-profiles-openshift(7)

## AUTHOR

```
Jaroslav Škarvada <jskarvad@redhat.com>
Jan Kaluža <jkaluza@redhat.com>
Jan Včelák <jvcelak@redhat.com>
Marcela Mašláňová <mmaslano@redhat.com>
Phil Knirsch <pknirsch@redhat.com>
```


tuned-profiles-atomic

package: tuned-profiles-atomic

title: tuned-profiles-atomic(7)

summary: profiles\-atomic - description of profiles provided for the Project Atomic

text:
# tuned-profiles-atomic(7)

## NAME
tuned-profiles-atomic - description of profiles provided for the Project Atomic

## DESCRIPTION
These profiles are provided for the Project Atomic. They provides performance optimizations for the Atomic hosts (bare metal) and virtual guests.

## PROFILES
The following profiles are provided:

atomic-host

Profile optimized for Atomic hosts (bare metal). It is based on throughput-performance profile. It additionally increases SELinux AVC cache, PID limit and tunes netfilter connections tracking.

atomic-guest

Profile optimized for virtual Atomic guests. It is based on virtual-guest profile. It additionally increases SELinux AVC cache, PID limit and tunes netfilter connections tracking.

## FILES

```
/etc/tuned/*
/usr/lib/tuned/*
```

## SEE ALSO
tuned(8) tuned-adm(8) tuned-profiles(7) tuned-profiles-sap(7) tuned-profiles-sap-hana(7) tuned-profiles-mssql(7) tuned-profiles-oracle(7) tuned-profiles-realtime(7) tuned-profiles-nfv-host(7) tuned-profiles-nfv-guest(7) tuned-profiles-cpu-partitioning(7) tuned-profiles-compat(7) tuned-profiles-postgresql(7) tuned-profiles-openshift(7) tuned-profiles-spectrumscale-ece(7)

## AUTHOR

```
Jaroslav Škarvada <jskarvad@redhat.com>
```


tuned-profiles-compat

package: tuned-profiles-compat

title: tuned-profiles-compat(7)

summary: profiles\-compat - description of profiles provided for backward compatibility

text:
# tuned-profiles-compat(7)

## NAME
tuned-profiles-compat - description of profiles provided for backward compatibility

## DESCRIPTION
These profiles are provided for backward compatibility with the tuned-1x. They are no longer maintained and may be dropped anytime in the future. It's not recommended to use them for purposes other than backward compatibility. Some of them are only aliases to base TuneD profiles. Please do not use the compat profiles on new installations and rather use profiles from base tuned package or other tuned subpackages.

## PROFILES
The following profiles are considered compatibility profiles:

default

It is the lowest of the available profiles in regard to power saving and only enables CPU and disk plugins of TuneD.

desktop-powersave

A power saving profile directed at desktop systems. Enables ALPM power saving for SATA host adapters as well as the CPU, ethernet and disk plugins of TuneD.

server-powersave

A power saving profile directed at server systems. Enables ALPM power saving for SATA host adapters, and activates the CPU and disk plugins of TuneD.

laptop-ac-powersave

Medium power saving profile directed at laptops running on AC. Enables ALPM power saving for SATA host adapters, WiFi power saving as well as CPU, ethernet and disk plugins of TuneD.

laptop-battery-powersave

Strong power saving profile directed at laptops running on battery. Currently an alias to powersave profile.

spindown-disk

Strong power saving profile directed at machines with classic HDDs. It enables aggressive disk spin-down. Disk writeback values are increased and disk swappiness is lowered. Log syncing is disabled. All partitions are remounted with 'noatime' option.

enterprise-storage

Server profile for high disk throughput performance tuning. Disables power saving mechanisms and enables hugepages. Disk readahead values are increased. CPU governor is set to performance.

## FILES

```
/etc/tuned/*
/usr/lib/tuned/*
```

## SEE ALSO
tuned(8) tuned-adm(8) tuned-profiles(7) tuned-profiles-atomic(7) tuned-profiles-sap(7) tuned-profiles-sap-hana(7) tuned-profiles-mssql(7) tuned-profiles-oracle(7) tuned-profiles-realtime(7) tuned-profiles-nfv-host(7) tuned-profiles-nfv-guest(7) tuned-profiles-cpu-partitioning(7) tuned-profiles-postgresql(7) tuned-profiles-openshift(7) tuned-profiles-spectrumscale-ece(7)

## AUTHOR

```
Jaroslav Škarvada <jskarvad@redhat.com>
Jan Kaluža <jkaluza@redhat.com>
Jan Včelák <jvcelak@redhat.com>
Marcela Mašláňová <mmaslano@redhat.com>
Phil Knirsch <pknirsch@redhat.com>
```


tuned-profiles-mssql

package: tuned-profiles-mssql

title: tuned-profiles-mssql(7)

summary: profiles\-mssql - description of profile provided for the MS SQL Server

text:
# tuned-profiles-mssql(7)

## NAME
tuned-profiles-mssql - description of profile provided for the MS SQL Server

## DESCRIPTION
The profile is provided for the MS SQL Server.

## PROFILES
The following profile is provided:

mssql

Profile optimized for the MS SQL Server. It's based on the throughput-performance profile.

## FILES

```
/etc/tuned/*
/usr/lib/tuned/*
```

## SEE ALSO
tuned(8) tuned-adm(8) tuned-profiles(7) tuned-profiles-atomic(7) tuned-profiles-sap(7) tuned-profiles-sap-hana(7) tuned-profiles-oracle(7) tuned-profiles-realtime(7) tuned-profiles-nfv-host(7) tuned-profiles-nfv-guest(7) tuned-profiles-cpu-partitioning(7) tuned-profiles-compat(7) tuned-profiles-postgresql(7) tuned-profiles-openshift(7) tuned-profiles-spectrumscale-ece(7)

## AUTHOR

```
Jaroslav Škarvada <jskarvad@redhat.com>
```


tuned-profiles-nfv-guest

package: tuned-profiles-nfv-guest

title: tuned-profiles-nfv-guest(7)

summary: profiles\-nfv\-guest - description of profile provided for the NFV guest

text:
# tuned-profiles-nfv-guest(7)

## NAME
tuned-profiles-nfv-guest - description of profile provided for the NFV guest

## DESCRIPTION
The profile is provided for the Network Function Virtualization (NFV) guest.

## PROFILES
The following profile is provided:

realtime-virtual-guest

Profile optimized for virtual guests based on realtime profile.

## FILES

```
/etc/tuned/*
/usr/lib/tuned/*
```

## SEE ALSO
tuned(8) tuned-adm(8) tuned-profiles(7) tuned-profiles-atomic(7) tuned-profiles-sap(7) tuned-profiles-sap-hana(7) tuned-profiles-mssql(7) tuned-profiles-oracle(7) tuned-profiles-realtime(7) tuned-profiles-nfv-host(7) tuned-profiles-cpu-partitioning(7) tuned-profiles-compat(7) tuned-profiles-postgresql(7) tuned-profiles-openshift(7) tuned-profiles-spectrumscale-ece(7)

## AUTHOR

```
Jaroslav Škarvada <jskarvad@redhat.com>
```


tuned-profiles-nfv-host

package: tuned-profiles-nfv-host

title: tuned-profiles-nfv-host(7)

summary: profiles\-nfv\-host - description of profile provided for the NFV host

text:
# tuned-profiles-nfv-host(7)

## NAME
tuned-profiles-nfv-host - description of profile provided for the NFV host

## DESCRIPTION
The profile is provided for the Network Function Virtualization (NFV) host.

## PROFILES
The following profile is provided:

realtime-virtual-host

Profile optimized for virtual hosts based on realtime profile.

## FILES

```
/etc/tuned/*
/usr/lib/tuned/*
```

## SEE ALSO
tuned(8) tuned-adm(8) tuned-profiles(7) tuned-profiles-atomic(7) tuned-profiles-sap(7) tuned-profiles-sap-hana(7) tuned-profiles-mssql(7) tuned-profiles-oracle(7) tuned-profiles-realtime(7) tuned-profiles-nfv-guest(7) tuned-profiles-cpu-partitioning(7) tuned-profiles-compat(7) tuned-profiles-postgresql(7) tuned-profiles-openshift(7) tuned-profiles-spectrumscale-ece(7)

## AUTHOR

```
Jaroslav Škarvada <jskarvad@redhat.com>
```


tuned-profiles-openshift

package: tuned-profiles-openshift

title: tuned-profiles-openshift(7)

summary: profiles\-openshift - description of profiles provided for the OpenShift platform

text:
# tuned-profiles-openshift(7)

## NAME
tuned-profiles-openshift - description of profiles provided for the OpenShift platform

## DESCRIPTION
These profiles are provided for the OpenShift platform.

## PROFILES
The following profiles are provided:

openshift

Parent profile containing tuning shared by OpenShift control plane and worker nodes.

openshift-control-plane

Profile optimized for OpenShift control plane.

openshift-node

Profile optimized for general workloads on OpenShift worker nodes.

## FILES

```
/etc/tuned/*
/usr/lib/tuned/*
```

## SEE ALSO
tuned(8) tuned-adm(8) tuned-profiles(7) tuned-profiles-atomic(7) tuned-profiles-sap(7) tuned-profiles-sap-hana(7) tuned-profiles-mssql(7) tuned-profiles-oracle(7) tuned-profiles-realtime(7) tuned-profiles-nfv-host(7) tuned-profiles-nfv-guest(7) tuned-profiles-cpu-partitioning(7) tuned-profiles-compat(7) tuned-profiles-postgresql(7) tuned-profiles-spectrumscale-ece(7)

## AUTHOR

```
Jaroslav Škarvada <jskarvad@redhat.com>
Jiří Mencák <jmencak@redhat.com>
```


tuned-profiles-oracle

package: tuned-profiles-oracle

title: tuned-profiles-oracle(7)

summary: profiles\-oracle - description of profiles provided for the Oracle

text:
# tuned-profiles-oracle(7)

## NAME
tuned-profiles-oracle - description of profiles provided for the Oracle

## DESCRIPTION
These profiles are provided for the Oracle loads.

## PROFILES
The following profiles are provided:

oracle

Profile optimized for Oracle databases based on throughput-performance profile. It additionally disables transparent huge pages and modifies some other performance related kernel parameters.

## FILES

```
/etc/tuned/*
/usr/lib/tuned/*
```

## SEE ALSO
tuned(8) tuned-adm(8) tuned-profiles(7) tuned-profiles-atomic(7) tuned-profiles-sap(7) tuned-profiles-sap-hana(7) tuned-profiles-mssql(7) tuned-profiles-realtime(7) tuned-profiles-nfv-host(7) tuned-profiles-nfv-guest(7) tuned-profiles-cpu-partitioning(7) tuned-profiles-compat(7) tuned-profiles-postgresql(7) tuned-profiles-openshift(7) tuned-profiles-spectrumscale-ece(7)

## AUTHOR

```
Jaroslav Škarvada <jskarvad@redhat.com>
```


tuned-profiles-postgresql

package: tuned-profiles-postgresql

title: tuned-profiles-postgresql(7)

summary: profiles\-postgresql - description of profiles provided for PostgreSQL Server

text:
# tuned-profiles-postgresql(7)

## NAME
tuned-profiles-postgresql - description of profiles provided for PostgreSQL Server

## DESCRIPTION
These profiles are provided for the PostgreSQL Database server.

## PROFILES
The following profiles are provided:

postgresql

Profile optimized for PostgreSQL databases based on throughput-performance profile. It additionally disables transparent huge pages and modifies some other performance related kernel parameters.

## FILES

```
/etc/tuned/*
/usr/lib/tuned/*
```

## SEE ALSO
tuned(8) tuned-adm(8) tuned-profiles(7) tuned-profiles-atomic(7) tuned-profiles-sap(7) tuned-profiles-sap-hana(7) tuned-profiles-mssql(7) tuned-profiles-oracle(7) tuned-profiles-realtime(7) tuned-profiles-nfv-host(7) tuned-profiles-nfv-guest(7) tuned-profiles-cpu-partitioning(7) tuned-profiles-compat(7) tuned-profiles-openshift(7) tuned-profiles-spectrumscale-ece(7)

## AUTHOR

```
Jaroslav Škarvada <jskarvad@redhat.com>
Tigran Mkrtchyan <tigran.mkrtchyan@desy.de>
```


tuned-profiles-realtime

package: tuned-profiles-realtime

title: tuned-profiles-realtime(7)

summary: profiles\-realtime - description of profiles provided for the realtime

text:
# tuned-profiles-realtime(7)

## NAME
tuned-profiles-realtime - description of profiles provided for the realtime

## DESCRIPTION
These profiles are provided for the realtime.

## PROFILES
The following profiles are provided:

realtime

Profile optimized for realtime.

## FILES

```
/etc/tuned/*
/usr/lib/tuned/*
```

## SEE ALSO
tuned(8) tuned-adm(8) tuned-profiles(7) tuned-profiles-atomic(7) tuned-profiles-sap(7) tuned-profiles-sap-hana(7) tuned-profiles-mssql(7) tuned-profiles-oracle(7) tuned-profiles-nfv-host(7) tuned-profiles-nfv-guest(7) tuned-profiles-cpu-partitioning(7) tuned-profiles-compat(7) tuned-profiles-postgresql(7) tuned-profiles-openshift(7) tuned-profiles-spectrumscale-ece(7)

## AUTHOR

```
Jaroslav Škarvada <jskarvad@redhat.com>
```


tuned-profiles-sap

package: tuned-profiles-sap

title: tuned-profiles-sap(7)

summary: profiles\-sap - description of profiles provided for the SAP NetWeaver

text:
# tuned-profiles-sap(7)

## NAME
tuned-profiles-sap - description of profiles provided for the SAP NetWeaver

## DESCRIPTION
These profiles provides performance optimizations for the SAP NetWeaver applications.

## PROFILES
The following profiles are provided:

sap-netweaver

A performance optimized profile for the SAP NetWeaver applications. It is based on throughput-performance profile. It additionally tunes sysctl settings regarding shared memory, semaphores and maximum number of memory map areas a process may have.

## FILES

```
/etc/tuned/*
/usr/lib/tuned/*
```

## SEE ALSO
tuned(8) tuned-adm(8) tuned-profiles(7) tuned-profiles-atomic(7) tuned-profiles-sap-hana(7) tuned-profiles-mssql(7) tuned-profiles-oracle(7) tuned-profiles-realtime(7) tuned-profiles-nfv-host(7) tuned-profiles-nfv-guest(7) tuned-profiles-cpu-partitioning(7) tuned-profiles-compat(7) tuned-profiles-postgresql(7) tuned-profiles-openshift(7) tuned-profiles-spectrumscale-ece(7)

## AUTHOR

```
Jaroslav Škarvada <jskarvad@redhat.com>
```


tuned-profiles-sap-hana

package: tuned-profiles-sap-hana

title: tuned-profiles-sap-hana(7)

summary: profiles\-sap\-hana - description of profiles provided for the SAP HANA

text:
# tuned-profiles-sap-hana(7)

## NAME
tuned-profiles-sap-hana - description of profiles provided for the SAP HANA

## DESCRIPTION
These profiles provides performance optimizations for the SAP HANA applications.

## PROFILES
The following profiles are provided:

sap-hana

A performance optimized profile for the SAP HANA applications. It allows sleep states down to C3 and enables sysctl settings that improve throughput performance of disk and network IO. CPU governor is set to performance and CPU energy performance bias is set to performance. It also disables transparent hugepages, locks CPU to the low C states (by PM QoS) and tunes sysctl regarding semaphores.

sap-hana-kvm-guest

A performance optimized profile for the SAP HANA application when running as virtual guest on KVM. It loads the cpuidle-haltpoll driver to ensure lower latencies (at the cost of a higher power consumption). The clocksource is set to TSC, skew_tick is enabled.

## FILES

```
/etc/tuned/*
/usr/lib/tuned/*
```

## SEE ALSO
tuned(8) tuned-adm(8) tuned-profiles(7) tuned-profiles-atomic(7) tuned-profiles-sap(7) tuned-profiles-mssql(7) tuned-profiles-oracle(7) tuned-profiles-realtime(7) tuned-profiles-nfv-host(7) tuned-profiles-nfv-guest(7) tuned-profiles-cpu-partitioning(7) tuned-profiles-compat(7) tuned-profiles-postgresql(7) tuned-profiles-openshift(7) tuned-profiles-spectrumscale-ece(7)

## AUTHOR

```
Jaroslav Škarvada <jskarvad@redhat.com>
```


tuned-profiles-spectrumscale-ece

package: tuned-profiles-spectrumscale

title: tuned-profiles-spectrumscale-ece(7)

summary: profiles\-spectrumscale-ece - description of profiles provided for Spectrum Scale Erasure Code Edition

text:
# tuned-profiles-spectrumscale-ece(7)

## NAME
tuned-profiles-spectrumscale-ece - description of profiles provided for Spectrum Scale Erasure Code Edition

## DESCRIPTION
These profiles are provided for Spectrum Scale Erasure Code Edition servers.

## PROFILES
The following profiles are provided:

spectrumscale-ece

Profile optimized for Spectrum Scale Erasure Code Edition based on throughput-performance profile. It additionally enables automatic NUMA balancing and modifies some other performance related kernel parameters.

## FILES

```
/etc/tuned/*
/usr/lib/tuned/*
```

## SEE ALSO
tuned(8) tuned-adm(8) tuned-profiles(7) tuned-profiles-atomic(7) tuned-profiles-sap(7) tuned-profiles-sap-hana(7) tuned-profiles-mssql(7) tuned-profiles-oracle(7) tuned-profiles-realtime(7) tuned-profiles-nfv-host(7) tuned-profiles-nfv-guest(7) tuned-profiles-cpu-partitioning(7) tuned-profiles-compat(7) tuned-profiles-postgresql(7) tuned-profiles-openshift(7)

## AUTHOR

```
Luis Bolinches <luis.bolinches@fi.ibm.com>
```


hwdb

package: udev

title: hwdb(7)

summary: Hardware Database

text:
# hwdb(7)

## NAME
hwdb - Hardware Database

## DESCRIPTION
The hardware database is a key-value store for associating modalias-like keys to udev-property-like values. It is used primarily by udev to add the relevant properties to matching devices, but it can also be queried directly.

## HARDWARE DATABASE FILES
The hwdb files are read from the files located in the system hwdb directory /usr/lib/udev/hwdb.d and the local administration directory /etc/udev/hwdb.d. All hwdb files are collectively sorted and processed in lexical order, regardless of the directories in which they live. However, files with identical filenames replace each other. Files in /etc/ have the highest priority and take precedence over files with the same name in /usr/lib/. This can be used to override a system-supplied hwdb file with a local file if needed; a symlink in /etc/ with the same name as a hwdb file in /usr/lib/, pointing to /dev/null, disables that hwdb file entirely. hwdb files must have the extension .hwdb; other extensions are ignored.

Each hwdb file contains data records consisting of matches and associated key-value pairs. Every record in the hwdb starts with one or more match strings, specifying a shell glob to compare the lookup string against. Multiple match lines are specified in consecutive lines. Every match line is compared individually, and they are combined by OR. Every match line must start at the first character of the line.

Match patterns consist of literal characters, and shell-style wildcards:

•Asterisk "*" matches any number of characters

•Question mark "?" matches a single character

•Character list "[chars]" matches one of the characters chars listed between "[" and "]". A range may be specified as with a dash as "[first-last]". The match may be inverted with a caret "[^...]".

The match lines are followed by one or more key-value pair lines, which are recognized by a leading space character. The key name and value are separated by "=". An empty line signifies the end of a record. Lines beginning with "#" are ignored.

In case multiple records match a given lookup string, the key-value pairs from all records are combined. If a key is specified multiple times, the value from the record with the highest priority is used (each key can have only a single value). The priority is higher when the record is in a file that sorts later lexicographically, and in case of records in the same file, later records have higher priority.

The content of all hwdb files is read by systemd-hwdb(8) and compiled to a binary database located at /etc/udev/hwdb.bin, or alternatively /usr/lib/udev/hwdb.bin if you want ship the compiled database in an immutable image. During runtime, only the binary database is used.

## EXAMPLES
Example 1. General syntax of hwdb files

```
# /usr/lib/udev/hwdb.d/example.hwdb
# Comments can be placed before any records. This is a good spot
# to describe what that file is used for, what kind of properties
# it defines, and the ordering convention.
# A record with three matches and one property
mouse:*:name:*Trackball*:*
mouse:*:name:*trackball*:*
mouse:*:name:*TrackBall*:*

 ID_INPUT_TRACKBALL=1
# The rule above could be also be written in a form that
# matches Tb, tb, TB, tB:
mouse:*:name:*[tT]rack[bB]all*:*

 ID_INPUT_TRACKBALL=1
# A record with a single match and five properties
mouse:usb:v046dp4041:name:Logitech MX Master:*

 MOUSE_DPI=1000@166

 MOUSE_WHEEL_CLICK_ANGLE=15

 MOUSE_WHEEL_CLICK_ANGLE_HORIZONTAL=26

 MOUSE_WHEEL_CLICK_COUNT=24

 MOUSE_WHEEL_CLICK_COUNT_HORIZONTAL=14
```

Example 2. Overriding of properties

```
# /usr/lib/udev/hwdb.d/60-keyboard.hwdb
evdev:atkbd:dmi:bvn*:bvr*:bd*:svnAcer*:pn*:*

 KEYBOARD_KEY_a1=help

 KEYBOARD_KEY_a2=setup

 KEYBOARD_KEY_a3=battery
# Match vendor name "Acer" and any product name starting with "X123"
evdev:atkbd:dmi:bvn*:bvr*:bd*:svnAcer:pnX123*:*

 KEYBOARD_KEY_a2=wlan
# /etc/udev/hwdb.d/70-keyboard.hwdb
# disable wlan key on all at keyboards
evdev:atkbd:*

 KEYBOARD_KEY_a2=reserved

 PROPERTY_WITH_SPACES=some string
```

If the hwdb consists of those two files, a keyboard with the lookup string "evdev:atkbd:dmi:bvnAcer:bvr:bdXXXXX:bd08/05/2010:svnAcer:pnX123:" will match all three records, and end up with the following properties:

```
KEYBOARD_KEY_a1=help
KEYBOARD_KEY_a2=reserved
KEYBOARD_KEY_a3=battery
PROPERTY_WITH_SPACES=some string
```

## SEE ALSO
systemd-hwdb(8)