ARC Control Tool

NorduGrid ARC Control Tool

usage: arcctl [-h] [-c CONFIG] [-d {CRITICAL,ERROR,WARNING,INFO,DEBUG}]
              COMPONENT ...

Named Arguments

-c, --config config file location (default is /etc/arc.conf)
-d, --debug

Possible choices: CRITICAL, ERROR, WARNING, INFO, DEBUG

verbosity level (default is “WARNING”)

Default: “WARNING”

ARC Components

COMPONENT

Possible choices: deploy, test-ca, config, service, rte, accounting, job, cache, datastaging

DESCRIPTION

Sub-commands:

deploy

Third party components deployment

arcctl deploy [-h] ACTION ...

Deployment Actions

ACTION

Possible choices: igtf-ca, vomses, voms-lsc, iptables-config

DESCRIPTION

Sub-commands:

igtf-ca

Deploy IGTF CA certificates

arcctl deploy igtf-ca [-h] [-i {igtf,egi-trustanchors,nordugrid}]
                      {classic,iota,mics,slcs} [{classic,iota,mics,slcs} ...]
Positional Arguments
bundle

Possible choices: classic, iota, mics, slcs

IGTF CA bundle name

Named Arguments
-i, --installrepo
 

Possible choices: igtf, egi-trustanchors, nordugrid

Add specified repository that contains IGTF CA certificates

vomses

Deploy VOMS client configuration files

arcctl deploy vomses [-h] (-v VOMS | -e) [-u] [-c] vo
Positional Arguments
vo VO Name
Named Arguments
-v, --voms VOMS-Admin URL
-e, --egi-vo

Fetch information from EGI VOs database

Default: False

-u, --user

Install to user’s home instead of /etc

Default: False

-c, --use-client-cert
 

Use client certificate to contact VOMS-Admin

Default: False

voms-lsc

Deploy VOMS server-side list-of-certificates files

arcctl deploy voms-lsc [-h] (-v VOMS | -e) [--pythonssl] vo
Positional Arguments
vo VO Name
Named Arguments
-v, --voms VOMS-Admin URL
-e, --egi-vo

Fetch information from EGI VOs database

Default: False

--pythonssl

Use Python SSL module to establish TLS connection (default is to call external OpenSSL binary)

Default: False

iptables-config

Generate iptables config to allow ARC CE configured services

arcctl deploy iptables-config [-h] [--any-state] [--multiport]
Named Arguments
--any-state

Do not add ‘–state NEW’ to filter configuration

Default: False

--multiport

Use one-line multiport filter instead of per-service entries

Default: False

test-ca

ARC Test CA control

arcctl test-ca [-h] [--ca-id CA_ID] [--ca-dir CA_DIR] ACTION ...

Named Arguments

--ca-id Define CA ID to work with (default is to use hostname-based hash)
--ca-dir Redefine path to CA files directory

Test CA Actions

ACTION

Possible choices: init, cleanup, hostcert, usercert

DESCRIPTION

Sub-commands:

init

Generate self-signed TestCA files

arcctl test-ca init [-h]
                    [-d {md2,md4,md5,mdc2,sha1,sha224,sha256,sha384,sha512}]
                    [-v VALIDITY] [-f]
Named Arguments
-d, --digest

Possible choices: md2, md4, md5, mdc2, sha1, sha224, sha256, sha384, sha512

Digest to use (default is “sha256”)

Default: “sha256”

-v, --validity

Validity of certificate in days (default is 90)

Default: 90

-f, --force

Overwrite files if exist

Default: False

cleanup

Cleanup TestCA files

arcctl test-ca cleanup [-h]
hostcert

Generate and sign testing host certificate

arcctl test-ca hostcert [-h]
                        [-d {md2,md4,md5,mdc2,sha1,sha224,sha256,sha384,sha512}]
                        [-v VALIDITY] [-n HOSTNAME] [-f] [-t]
Named Arguments
-d, --digest

Possible choices: md2, md4, md5, mdc2, sha1, sha224, sha256, sha384, sha512

Digest to use (default is “sha256”)

Default: “sha256”

-v, --validity

Validity of certificate in days (default is 30)

Default: 30

-n, --hostname Generate certificate for specified hostname instead of this host
-f, --force

Overwrite files if exist

Default: False

-t, --export-tar
 

Export tar archive to use from another host

Default: False

usercert

Generate and sign testing user certificate

arcctl test-ca usercert [-h]
                        [-d {md2,md4,md5,mdc2,sha1,sha224,sha256,sha384,sha512}]
                        [-v VALIDITY] [-n USERNAME] [-i INSTALL_USER] [-t]
                        [-f] [--no-auth]
Named Arguments
-d, --digest

Possible choices: md2, md4, md5, mdc2, sha1, sha224, sha256, sha384, sha512

Digest to use (default is “sha256”)

Default: “sha256”

-v, --validity

Validity of certificate in days (default is 30)

Default: 30

-n, --username Use specified username instead of automatically generated
-i, --install-user
 Install certificates to $HOME/.globus for specified user instead of workdir
-t, --export-tar
 

Export tar archive to use from another host

Default: False

-f, --force

Overwrite files if exist

Default: False

--no-auth

Do not add user subject to allowed list

Default: False

config

ARC CE configuration control

arcctl config [-h] ACTION ...

Config Actions

ACTION

Possible choices: dump, get, describe, brief, verify

DESCRIPTION

Sub-commands:

dump

Dump ARC CE running configuration

arcctl config dump [-h]
get

Print configuration option value

arcctl config get [-h] block option
Positional Arguments
block Name of configuration block (without square breakets)
option Configuration option name
describe

Describe configuration option

arcctl config describe [-h] [-r REFERENCE] block option
Positional Arguments
block Name of configuration block (without square breakets)
option Configuration option name
Named Arguments
-r, --reference
 

Redefine arc.conf.reference location (default is “/usr/share/doc/nordugrid-arc//arc.conf.reference”)

Default: “/usr/share/doc/nordugrid-arc//arc.conf.reference”

brief

Print configuration brief points

arcctl config brief [-h] [-t {storage,logs}]
Named Arguments
-t, --type

Possible choices: storage, logs

Show brief only for provided options type

verify

Verify ARC CE configuration syntax

arcctl config verify [-h]

service

ARC CE services control

arcctl service [-h] ACTION ...

Services Actions

ACTION

Possible choices: enable, disable, start, restart, stop, list

DESCRIPTION

Sub-commands:

enable

Enable ARC CE services

arcctl service enable [-h] [--now] (-a | -s SERVICE)
Named Arguments
--now

Start the services just after enable

Default: False

-a, --as-configured
 

Use information from arc.conf to get services list

Default: False

-s, --service Service name
disable

Disable ARC CE services

arcctl service disable [-h] [--now] (-a | -s SERVICE)
Named Arguments
--now

Stop the services just after disable

Default: False

-a, --as-configured
 

Use information from arc.conf to get services list

Default: False

-s, --service Service name
start

Start ARC CE services

arcctl service start [-h] (-a | -s SERVICE)
Named Arguments
-a, --as-configured
 

Use information from arc.conf to get services list

Default: False

-s, --service Service name
restart

Restart ARC CE services

arcctl service restart [-h] (-a | -s SERVICE)
Named Arguments
-a, --as-configured
 

Use information from arc.conf to get services list

Default: False

-s, --service Service name
stop

Stop ARC CE services

arcctl service stop [-h] (-a | -s SERVICE)
Named Arguments
-a, --as-configured
 

Use information from arc.conf to get services list

Default: False

-s, --service Service name
list

List ARC CE services and their states

arcctl service list [-h] [-i | -e | -a]
Named Arguments
-i, --installed
 

Show only installed services

Default: False

-e, --enabled

Show only enabled services

Default: False

-a, --active

Show only running services

Default: False

rte

RunTime Environments

arcctl rte [-h] ACTION ...

RunTime Environments Actions

ACTION

Possible choices: enable, disable, list, default, undefault, cat, params-get, params-set, params-unset, community

DESCRIPTION

Sub-commands:

enable

Enable RTE to be used by A-REX

arcctl rte enable [-h] [-f] [-d] rte [rte ...]
Positional Arguments
rte RTE name
Named Arguments
-f, --force

Force RTE enabling

Default: False

-d, --dummy

Enable dummy RTE that do nothing but published in the infosys

Default: False

disable

Disable RTE to be used by A-REX

arcctl rte disable [-h] rte [rte ...]
Positional Arguments
rte RTE name
list

List RunTime Environments

arcctl rte list [-h] [-l] [-e | -d | -a | -s | -u | -n | -c]
Named Arguments
-l, --long

Detailed listing of RTEs

Default: False

-e, --enabled

List enabled RTEs

Default: False

-d, --default

List default RTEs

Default: False

-a, --available
 

List available RTEs

Default: False

-s, --system

List available system RTEs

Default: False

-u, --user

List available user-defined RTEs

Default: False

-n, --dummy

List dummy enabled RTEs

Default: False

-c, --community
 

List deployed community RTEs

Default: False

default

Transparently use RTE for every A-REX job

arcctl rte default [-h] [-f] rte [rte ...]
Positional Arguments
rte RTE name
Named Arguments
-f, --force

Force RTE enabling

Default: False

undefault

Remove RTE from transparent A-REX usage

arcctl rte undefault [-h] rte [rte ...]
Positional Arguments
rte RTE name
cat

Print the content of RTE file

arcctl rte cat [-h] rte
Positional Arguments
rte RTE name
params-get

List configurable RTE parameters

arcctl rte params-get [-h] [-l] rte
Positional Arguments
rte RTE name
Named Arguments
-l, --long

Detailed listing of parameters

Default: False

params-set

Set configurable RTE parameter

arcctl rte params-set [-h] rte parameter value
Positional Arguments
rte RTE name
parameter RTE parameter to configure
value RTE parameter value to set
params-unset

Use default value for RTE parameter

arcctl rte params-unset [-h] rte parameter
Positional Arguments
rte RTE name
parameter RTE parameter to unset
community

Operating community-defined RunTimeEnvironments

arcctl rte community [-h] ACTION ...
Community RTE Actions
ACTION

Possible choices: add, remove, list, config-get, config-set, rte-list, rte-cat, rte-deploy, rte-remove

DESCRIPTION

Sub-commands:
add

Add new trusted community to ARC CE

arcctl rte community add [-h] [-f FINGERPRINT]
                         [-a ARCHERY | -u URL | --pubkey PUBKEY | --keyserver KEYSERVER]
                         community
Positional Arguments
community Trusted community name
Named Arguments
-f, --fingerprint
 Fingerprint of the community key
-a, --archery Use ARCHERY domain name (this is the default with community name as a domain)
-u, --url Use JSON URL
--pubkey Manually defined location (URL) of the public key
--keyserver Manually defined location of PGP keyserver
remove

Remove trusted community from ARC CE

arcctl rte community remove [-h] [-f] community
Positional Arguments
community Trusted community name
Named Arguments
-f, --force

Disable and undefault all community RTEs automatically

Default: False

list

List trusted communities

arcctl rte community list [-h] [-l]
Named Arguments
-l, --long

Print more information

Default: False

config-get

Get config variables for trusted community

arcctl rte community config-get [-h] [-l] community [option [option ...]]
Positional Arguments
community Trusted community name
option Configuration option name
Named Arguments
-l, --long

Print more information

Default: False

config-set

Set config variable for trusted community

arcctl rte community config-set [-h] community option value
Positional Arguments
community Trusted community name
option Configuration option name
value Configuration option value
rte-list

List RTEs provided by community

arcctl rte community rte-list [-h] [-l | -a | -d] community
Positional Arguments
community Trusted community name
Named Arguments
-l, --long

Print more information

Default: False

-a, --available
 

List RTEs available in the software registry

Default: False

-d, --deployed

List deployed community RTEs

Default: False

rte-cat

Print the content of RTEs provided by community

arcctl rte community rte-cat [-h] community rtename
Positional Arguments
community Trusted community name
rtename RunTimeEnvironment name
rte-deploy

Deploy RTE provided by community

arcctl rte community rte-deploy [-h] [-u URL] [-f] [--insecure]
                                community rtename
Positional Arguments
community Trusted community name
rtename RunTimeEnvironment name
Named Arguments
-u, --url Explicitly define URL to signed RTE file
-f, --force

Force RTE files redeployment if already exists

Default: False

--insecure

Do not validate community signature for URL-based deployment

Default: False

rte-remove

Remove deployed community RTE

arcctl rte community rte-remove [-h] [-f] community rtename
Positional Arguments
community Trusted community name
rtename RunTimeEnvironment name
Named Arguments
-f, --force

Disable and undefault RTE automatically

Default: False

accounting

A-REX Accounting records management

arcctl accounting [-h] ACTION ...

Accounting Actions

ACTION

Possible choices: stats, job, republish

DESCRIPTION

Sub-commands:

stats

Show A-REX AAR statistics

arcctl accounting stats [-h] [-b END_FROM] [-e END_TILL] [-s START_FROM]
                        [--filter-vo FILTER_VO] [--filter-user FILTER_USER]
                        [--filter-state FILTER_STATE]
                        [--filter-queue FILTER_QUEUE]
                        [--filter-endpoint FILTER_ENDPOINT]
                        [--filter-extra ATTRIBUTE VALUE]
                        [-o {brief,jobcount,walltime,cputime,data-staged-in,data-staged-out,wlcgvos,users,jobids,json}]
Named Arguments
-b, --end-from Define the job completion time range beginning (YYYY-MM-DD [HH:mm[:ss]])
-e, --end-till Define the job completion time range end (YYYY-MM-DD [HH:mm[:ss]])
-s, --start-from
 Define the job start time constraint (YYYY-MM-DD [HH:mm[:ss]])
--filter-vo Account jobs owned by specified WLCG VO(s)
--filter-user Account jobs owned by specified user(s)
--filter-state Account jobs in the defined state(s)
--filter-queue Account jobs submitted to the defined queue(s)
--filter-endpoint
 Account jobs submitted via defined endpoint type(s)
--filter-extra Filter extra attributes (e.g. jobname, project, vomsfqan, rte, dtrurl, etc)
-o, --output

Possible choices: brief, jobcount, walltime, cputime, data-staged-in, data-staged-out, wlcgvos, users, jobids, json

Define what kind of stats you want to output (default is “brief”)

Default: “brief”

job

Show job accounting data

arcctl accounting job [-h] ACTION ...
Job Accounting Actions
ACTION

Possible choices: info, events, transfers

DESCRIPTION

Sub-commands:
info

Show job accounting data

arcctl accounting job info [-h]
                           [-o {all,description,resources,rtes,authtokens,json}]
                           jobid
Positional Arguments
jobid Job ID
Named Arguments
-o, --output

Possible choices: all, description, resources, rtes, authtokens, json

Define what kind of job information you want to output (default is “all”)

Default: “all”

events

Show job event history

arcctl accounting job events [-h] jobid
Positional Arguments
jobid Job ID
transfers

Show job data transfers statistics

arcctl accounting job transfers [-h] jobid
Positional Arguments
jobid Job ID
republish

Republish accounting records to defined target

arcctl accounting republish [-h] -b END_FROM -e END_TILL
                            (-t TARGET_NAME | -a APEL_URL | -s SGAS_URL)
                            [--apel-topic {gLite-APEL,/queue/global.accounting.test.cpu.central}]
                            [--apel-messages {urs,summaries}]
                            [--gocdb-name GOCDB_NAME]
                            [--localid-prefix LOCALID_PREFIX]
                            [--vofilter VOFILTER] [--urbatchsize URBATCHSIZE]
Named Arguments
-b, --end-from Define republishing timeframe start (YYYY-MM-DD [HH:mm[:ss]])
-e, --end-till Define republishing timeframe end (YYYY-MM-DD [HH:mm[:ss]])
-t, --target-name
 Specify configured accounting target name from arc.conf (e.g. neic_sgas).
-a, --apel-url Specify APEL server URL (e.g. https://msg.argo.grnet.gr)
-s, --sgas-url Specify SGAS server URL (e.g. https://grid.uio.no:8001/logger)
APEL

Options to be used when target is specified using –apel-url

--apel-topic

Possible choices: gLite-APEL, /queue/global.accounting.test.cpu.central

Define APEL topic (default is gLite-APEL)

--apel-messages
 

Possible choices: urs, summaries

Define APEL messages (default is summaries)

--gocdb-name (Re)define GOCDB site name
SGAS

Options to be used when target is specified using –sgas-url

--localid-prefix
 Define optional SGAS localid prefix
Other options

Works for both APEL and SGAS targets

--vofilter Republish only jobs owned by these VOs
--urbatchsize Size of records batch to be send (default is 50 for SGAS, 500 for APEL)

job

A-REX Jobs

arcctl job [-h] [-t CACHETTL] ACTION ...

Named Arguments

-t, --cachettl

GM-Jobs output caching validity in seconds (default is 30)

Default: 30

Jobs Control Actions

ACTION

Possible choices: list, script, log, info, stdout, stderr, attr, kill, killall, clean, cleanall, stats, accounting, datastaging

DESCRIPTION

Sub-commands:

list

List available A-REX jobs

arcctl job list [-h] [-l]
                [-s {ACCEPTED,PREPARING,SUBMIT,INLRMS,FINISHING,FINISHED,DELETED,CANCELING}]
                [-o OWNER]
Named Arguments
-l, --long

Detailed listing of jobs

Default: False

-s, --state

Possible choices: ACCEPTED, PREPARING, SUBMIT, INLRMS, FINISHING, FINISHED, DELETED, CANCELING

Filter jobs by state

-o, --owner Filter jobs by owner
script

Display job script submitted to LRMS

arcctl job script [-h] jobid
Positional Arguments
jobid Job ID
log

Display job log

arcctl job log [-h] [-f] [-s] jobid
Positional Arguments
jobid Job ID
Named Arguments
-f, --follow

Follow the job log output

Default: False

-s, --service

Show ARC CE logs containing the jobID instead of job log

Default: False

info

Show job main info

arcctl job info [-h] jobid
Positional Arguments
jobid Job ID
stdout

Show job executable stdout

arcctl job stdout [-h] [-f] jobid
Positional Arguments
jobid Job ID
Named Arguments
-f, --follow

Follow the job log output

Default: False

stderr

Show job executable stderr

arcctl job stderr [-h] [-f] jobid
Positional Arguments
jobid Job ID
Named Arguments
-f, --follow

Follow the job log output

Default: False

attr

Get

arcctl job attr [-h] jobid [attr]
Positional Arguments
jobid Job ID
attr Attribute name
kill

Cancel job

arcctl job kill [-h] jobid [jobid ...]
Positional Arguments
jobid Job ID
killall

Cancel all jobs

arcctl job killall [-h]
                   [-s {ACCEPTED,PREPARING,SUBMIT,INLRMS,FINISHING,FINISHED,DELETED,CANCELING}]
                   [-o OWNER]
Named Arguments
-s, --state

Possible choices: ACCEPTED, PREPARING, SUBMIT, INLRMS, FINISHING, FINISHED, DELETED, CANCELING

Filter jobs by state

-o, --owner Filter jobs by owner
clean

Clean job

arcctl job clean [-h] jobid [jobid ...]
Positional Arguments
jobid Job ID
cleanall

Clean all jobs

arcctl job cleanall [-h]
                    [-s {ACCEPTED,PREPARING,SUBMIT,INLRMS,FINISHING,FINISHED,DELETED,CANCELING}]
                    [-o OWNER]
Named Arguments
-s, --state

Possible choices: ACCEPTED, PREPARING, SUBMIT, INLRMS, FINISHING, FINISHED, DELETED, CANCELING

Filter jobs by state

-o, --owner Filter jobs by owner
stats

Show jobs statistics

arcctl job stats [-h] [-l] [-t | -d]
Named Arguments
-l, --long

Detailed output of stats

Default: False

-t, --total

Show server total stats

Default: False

-d, --data-staging
 

Show server datastaging stats

Default: False

accounting

Show job accounting data

arcctl job accounting [-h] ACTION ...
Job Accounting Actions
ACTION

Possible choices: info, events, transfers

DESCRIPTION

Sub-commands:
info

Show job accounting data

arcctl job accounting info [-h]
                           [-o {all,description,resources,rtes,authtokens,json}]
                           jobid
Positional Arguments
jobid Job ID
Named Arguments
-o, --output

Possible choices: all, description, resources, rtes, authtokens, json

Define what kind of job information you want to output (default is “all”)

Default: “all”

events

Show job event history

arcctl job accounting events [-h] jobid
Positional Arguments
jobid Job ID
transfers

Show job data transfers statistics

arcctl job accounting transfers [-h] jobid
Positional Arguments
jobid Job ID
datastaging

Job Datastaging Information for jobs preparing or running.

arcctl job datastaging [-h] ACTION ...
Sub-commands:
get-totaltime

Show the total time spent in the preparation stage for the selected job

arcctl job datastaging get-totaltime [-h] jobid
Positional Arguments
jobid Job ID
get-details

Show details related to the files downloaded for the selected job

arcctl job datastaging get-details [-h] jobid
Positional Arguments
jobid Job ID

cache

ARC A-REX Cache control

arcctl cache [-h] ACTION ...

A-REX Cache Actions

ACTION

Possible choices: stats, list, is-cached

DESCRIPTION

Sub-commands:

stats

Show cache usage statistics

arcctl cache stats [-h]
list

List cached URLs

arcctl cache list [-h] [-l]
Named Arguments
-l, --long

Output paths to cached files

Default: False

is-cached

Checks is the URL already in A-REX cache

arcctl cache is-cached [-h] [-q] url
Positional Arguments
url URL to check
Named Arguments
-q, --quiet

Do not output path to cached file

Default: False

datastaging

DataStaging info

arcctl datastaging [-h] ACTION ...

DataStaging Control Actions

ACTION

Possible choices: summary, job, dtr

DESCRIPTION

Sub-commands:

summary

Job Datastaging Summary Information for jobs preparing or running.

arcctl datastaging summary [-h] ACTION ...
Sub-commands:
jobs

Show overview of the duration of datastaging for jobs active in the chosen (or default=1hr) timewindow

arcctl datastaging summary jobs [-h] [-d DAYS] [-hr HOURS] [-m MINUTES]
                                [-s SECONDS]
Named Arguments
-d, --days

Modification time in days (default: 0 days)

Default: 0

-hr, --hours

Modification time in hours (default: 1 hour)

Default: 1

-m, --minutes

Modification time in minutes (default: 0 minutes)

Default: 0

-s, --seconds

Modification time in seconds (default: 0 seconds)

Default: 0

files

Show the total number file and and total file-size downloaded in the chosen (or default=1hr)timewindow

arcctl datastaging summary files [-h] [-d DAYS] [-hr HOURS] [-m MINUTES]
                                 [-s SECONDS]
Named Arguments
-d, --days

Modification time in days (default: 0 days)

Default: 0

-hr, --hours

Modification time in hours (default: 1 hour)

Default: 1

-m, --minutes

Modification time in minutes (default: 0 minutes)

Default: 0

-s, --seconds

Modification time in seconds (default: 0 seconds)

Default: 0

job

Job Datastaging Information for a preparing or running job.

arcctl datastaging job [-h] ACTION ...
Sub-commands:
get-totaltime

Show the total time spent in the preparation stage for the selected job

arcctl datastaging job get-totaltime [-h] jobid
Positional Arguments
jobid Job ID
get-details

Show details related to the files downloaded for the selected job

arcctl datastaging job get-details [-h] jobid
Positional Arguments
jobid Job ID
dtr

Data-delivery transfer (DTR) information

arcctl datastaging dtr [-h] ACTION ...
Sub-commands:
state

Show summary of DTR state info

arcctl datastaging dtr state [-h]
Positional Arguments
state Default: False