Skip site navigation (1)Skip section navigation (2)

FreeBSD Manual Pages

  
 
  

home | help
pbs_queue_attributes(7B)	      PBS	      pbs_queue_attributes(7B)

NAME
       pbs_queue_attributes - pbs queue	attributes

DESCRIPTION
       Queue  public  attributes  are  alterable  on request by	a client.  The
       client must be acting for a user	with administrator (manager) or	opera-
       tor privilege.  Certain attributes require the user to have full	admin-
       istrator	privilege before they can  be  modified.   The	following  at-
       tributes	apply to both queue types:

	 acl_group_enable
		Attribute  which when true directs the server to use the queue
		group access  control  list  acl_groups	 .   Format:  boolean,
		"TRUE",	 "True",  "true",  "Y",	 "y",  "1",  "FALSE", "False",
		"false", "N", "n", "0";	default	value: false = disabled.

	 acl_group_sloppy
		Search a job user's secondary groups if	 the  effective	 group
		doesn't	 match	the group acl.	Warning, this can be very slow
		and expensive.	Format:	boolean, "TRUE", "True", "true",  "Y",
		"y",  "1",  "FALSE",  "False", "false",	"N", "n", "0"; default
		value: false = disabled.

	 acl_groups
		List which allows or denies enqueuing of jobs owned by members
		of  the	 listed	 groups.  The groups in	the list are groups on
		the server host, not submitting	hosts.	If acl_group_enable is
		set  to	 true,	only groups listed in the acl_groups attribute
		will be	allowed	access to the queue.  See section 10.1,	Autho-
		rization,  in  the PBS External	Reference Specification.  For-
		mat: "[+|-]group_name[,...]"; default value:  all  groups  al-
		lowed.

	 acl_host_enable
		Attribute  which  when	true  directs  the  server  to use the
		acl_hosts access list.	 Format:  boolean  (see	 acl_group_en-
		able); default value: disabled.

	 acl_hosts
		List  of  hosts	which may enqueue jobs in the queue.  See sec-
		tion 10.1, Authorization, in the PBS External Reference	Speci-
		fication.   Format:  "[+|-]hostname[...]";  default value: all
		hosts allowed.

	 acl_logic_or
		Modifies the way acls are applied if both acl_user_enable  and
		acl_group_enable  are  set  to true.  If acl_logic_or is true,
		then user and group acls are logically OR'ed together  (a  job
		can  pass either the user or group acl lists to	be allowed ac-
		cess to	the queue).  If	I acl_logic_or is false, then user and
		group  acls are	logically AND'ed together (a job would have to
		pass both user and group acl  lists).	Format:	 boolean  (see
		acl_group_enable  and  acl_user_enable);  default  value: dis-
		abled.

	 acl_user_enable
		Attribute which	when true directs the server to	 use  the  the
		acl_users  access  list	 for this queue.  Format: boolean (see
		acl_group_enable); default value: disabled.

	 acl_users
		List of	users allowed or denied	the ability to enqueue jobs in
		this  queue.   See section 10.1, Authorization,	in the PBS Ex-
		ternal Reference Specification.	 If acl_user_enable is set  to
		true,  only  users  listed in the acl_groups attribute will be
		allowed	access to the queue.

		Format:	"[+|-]user[@host][,...]"; default value: all users al-
		lowed.

	 disallowed_types
		List  of  job  "types"	(interactive,batch,rerunable,nonrerun-
		able,fault_tolerant,fault_intolerant) that are not allowed  in
		this queue.

		default	value: all types allowed.

	 enabled
		Queue  will or will not	accept new jobs.  When false the queue
		is disabled and	will not accept	jobs.	Format:	 boolean  (see
		acl_group_enable); default value: disabled.

	 from_route_only
		When  true,  this queue	will not accept	jobs except when being
		routed by the server from a local routing queue.  This is used
		to force user to submit	jobs into a routing queue used to dis-
		tribute	jobs to	other queues based  on	job  resource  limits.
		Format:	boolean; default value:	disabled.

	 is_transit
		When  true,  jobs  will	be allowed into	this queue that	do not
		fit server resource limitations. This is to allow the jobs  to
		be  routed  to	a  server  that	 does have the appropriate re-
		sources.  Any queue limits are checked.

	 max_queuable
		The maximum number of jobs allowed to reside in	the  queue  at
		any given time.	 Format: integer; default value: infinite.

	 max_user_queuable
		The maximum number of jobs owned by a single user that are al-
		lowed to reside	in the queue at	any given time.	 Format: inte-
		ger; default value: infinite.

	 max_running
		The  maximum  number  of jobs allowed to be selected from this
		queue for routing or execution at any given time.  For a rout-
		ing  queue,  this  is enforced,	if set,	by the server.	For an
		execution queue, this attribute	is advisory to the  Scheduler,
		it is not enforced by the server.  Format: integer.

	 Priority
		The  priority  of  this	queue against other queues of the same
		type on	this server.  May  affect  job	selection  for	execu-
		tion/routing.	Advisory  to  the  Scheduler,  not used	by the
		server.	 Format: integer.

	 queue_type
		The type of the	queue: execution or  route.   Format:  "execu-
		tion",	"e",  "route", "r".  This attribute must be explicitly
		set.

	 resources_max
		The maximum amount of each resource which can be requested  by
		a  single  job	in this	queue.	The queue value	supersedes any
		server	wide  maximum	limit.	  Format:   "resources_max.re-
		source_name=value",  see qmgr(1B); default value: infinite us-
		age.

	 resources_min
		The minimum amount of each resource which can be requested  by
		a  single  job	in this	queue.	Format:	see resources_max, de-
		fault value: zero usage.

	 resources_default
		The list of default resource values which are  set  as	limits
		for a job residing in this queue and for which the job did not
		specify	   a	limit.	    Format:	"resources_default.re-
		source_name=value", see	qmgr(1B); default value: none;	if not
		set, the default limit for a job is determined by the first of
		the  following attributes which	is set:	server's resources_de-
		fault, queue's resources_max, server's resources_max.  If none
		of these are set, the job will unlimited resource usage.

	 started
		Jobs  may  be  scheduled  for execution	from this queue.  When
		false, the queue  is  considered  stopped.   Advisory  to  the
		Scheduler, not enforced	by the server.	[default value:	false,
		but depends on scheduler interpretation] Format: boolean  (see
		acl_group_enable).

       The following attributes	apply only to execution	queues:

	 checkpoint_defaults
		Specifies  the	queues default checkpointing values to be used
		for a job that does  not  have	any  checkpointing  specified.
		Format:	string;	default	value: none.

	 checkpoint_min
		Specifies  the minimum interval	of cpu time, in	minutes, which
		is allowed between checkpoints of a job.  If a user  specifies
		a time less than this value, this value	is used	instead.  For-
		mat: integer; default value: no	minimum.

	 resources_available
		The list of resource and amounts available to jobs running  in
		this  queue.  The sum of the resource of each type used	by all
		jobs running from this queue cannot exceed  the	 total	amount
		listed	here.	Advisory to the	Scheduler, not enforced	by the
		server.	  Format:   "resources_available.resource_name=value",
		see qmgr(1B).

	 keep_completed
		Number	of  seconds  to	 retain	completed jobs in the C	state.
		This overrides the server attribute of the same	name.  EXPERI-
		MENTAL 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  overrides	the server attribute of	the same name.
		Format:	integer	seconds; default value:	2 seconds.

	 max_user_run
		The maximum number of jobs owned by a single user that are al-
		lowed  to be running from this queue at	one time.  This	attri-
		bute 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.

       The following attributes	apply only to routing queues:

	 route_destinations
		The list of destinations to which jobs may  be	routed.	  [de-
		fault  value: none, should be set to at	least one valid	desti-
		nation]

	 alt_router
		If true, an site supplied, alternative job router function  is
		used  to  determine the	destination for	routing	jobs from this
		queue.	Otherwise, the default,	round-robin  router  is	 used.
		Format:	boolean	(see acl_group_enable);	default	value: false.

	 route_held_jobs
		If  true,  jobs	 with  a hold type set may be routed from this
		queue.	If false, held jobs are	not  to	 be  routed.   Format:
		boolean	(see acl_group_enable);	default	value: false.

	 route_waiting_jobs
		If  true,  jobs	 with a	future execution_time attribute	may be
		routed from this queue.	 If false, they	are not	to be  routed.
		Format:	boolean	(see acl_group_enable);	default	value: false.

	 route_retry_time
		Time  delay  between  route  retries.  Typically used when the
		network	between	servers	is down.  Format: integer seconds; de-
		fault value: {PBS_NET_RETRY_TIME} (30 seconds).

	 route_lifetime
		The maximum time a job is allowed to exist in a	routing	queue.
		If the job cannot be routed in this amount of time, the	job is
		aborted.  If unset or set to a value of	zero (0), the lifetime
		is infinite.  Format: integer seconds; default infinite.

       The following data items	are read-only attributes of the	 queue.	  They
       are visible to but cannot be changed by clients.

       Items which apply to all	types of queues	are:

	 total_jobs
		The number of jobs currently residing in the queue.

	 state_count
		The  total  number  of jobs currently residing in the queue in
		each state.

       These read-only attributes only apply to	execution queues:

	 resources_assigned
		The total amount of certain types of  resources	 allocated  to
		jobs running from this queue.

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

Local						      pbs_queue_attributes(7B)

NAME | DESCRIPTION | SEE ALSO

Want to link to this manual page? Use this URL:
<https://www.freebsd.org/cgi/man.cgi?query=pbs_queue_attributes&sektion=7b&manpath=FreeBSD+12.0-RELEASE+and+Ports>

home | help