Command Line Reference

arch-mgmt

Command line tool for doing mgmt operations with the archiver.

Usage

arch-mgmt [OPTIONS] COMMAND [ARGS]...

Options

--version: Show the version and exit.

abort

Abort PVs from the connection queue in the archiver.

ARGUMENT file csv file of what pvs to abort.

Example usage:

arch-mgmt abort -a archiver.example.com pvs.csv

Usage

arch-mgmt abort [OPTIONS] [FILE]

Options

-a, --archiver-fqdn <archiver_fqdn>: Required Archiver where PVs reside.

Arguments

FILE: Optional argument

alias

Alias PVs in the archiver.

Usage

arch-mgmt alias [OPTIONS] COMMAND [ARGS]...

add

Add alias to PVs in the archiver.

ARGUMENT file csv file of what pvs to alias.

Example file:

original_pv,alias_pv_name
pv1,pv2
pv3,pv4

Example usage:

arch-mgmt alias add -a archiver.example.com pvs.csv

Usage

arch-mgmt alias add [OPTIONS] [FILE]

Options

-a, --archiver-fqdn <archiver_fqdn>: Archivers where PVs reside.

Arguments

FILE: Optional argument

remove

Remove aliases to PVs in the archiver.

ARGUMENT file csv file of what pvs to alias.

Example file:

original_pv,alias_pv_name
pv1,pv2
pv3,pv4

Example usage:

arch-mgmt alias remove -a archiver.example.com pvs.csv

Usage

arch-mgmt alias remove [OPTIONS] [FILE]

Options

-a, --archiver-fqdn <archiver_fqdn>: Archivers where PVs reside.

Arguments

FILE: Optional argument

archive

Archive PVs in the archiver.

ARGUMENT file csv file of what pvs to archive. The csv file should have the following format:

Example: PV,policy mypv1, mypv2,1Hz mypv3,1HzSCAN

Policy is optional. If not provided, the default policy will be used. You can find the options at archiver.example.com/mgmt/bpl/getPolicyList.

Example usage:

arch-mgmt archive -a archiver.example.com pvs.csv

Raises:: click.BadParameter: If no PVs are found in the input file.

Usage

arch-mgmt archive [OPTIONS] [FILE]

Options

-a, --archiver-fqdn <archiver_fqdn>: Required Archiver where PVs reside.

-d, --dry-run: Do a dry run.

-ap, --appliance <appliance>: Appliance to archive to.

Arguments

FILE: Optional argument

change-parameter

Change the archiving parameters of PVs in the archiver.

ARGUMENT file csv file of what pvs to change archiving parameters.

Example usage:

arch-mgmt change-parameter -a archiver.example.com --method SCAN --period 10.0 pvs.csv

Raises:: click.BadParameter: If neither method nor period is provided.

Usage

arch-mgmt change-parameter [OPTIONS] [FILE]

Options

-a, --archiver-fqdn <archiver_fqdn>: Archivers where PVs reside.

-m, --method <method>

Sampling method swap to.

Options:: SCAN | MONITOR

-p, --period <period>: Sampling period swap to.

Arguments

FILE: Optional argument

change-protocol

Change the protocol of PVs in the archiver.

ARGUMENT file csv file of what pvs to change protocol.

Example usage:

arch-mgmt change-protocol -a archiver.example.com --new-protocol ca pvs.csv

Usage

arch-mgmt change-protocol [OPTIONS] [FILE]

Options

-a, --archiver-fqdn <archiver_fqdn>: Required Archiver where PVs reside.

-p, --protocol <protocol>

Required Protocol to change PVs to.

Options:: CA | PVA

Arguments

FILE: Optional argument

change-type

Change the type of PVs in the archiver.

ARGUMENT file csv file of what pvs to change type.

Example usage:

arch-mgmt change-type -a archiver.example.com --new-type DBR_SCALAR_DOUBLE pvs.csv

Usage

arch-mgmt change-type [OPTIONS] [FILE]

Options

-a, --archiver-fqdn <archiver_fqdn>: Required Archiver where PVs reside.

-t, --new-type <new_type>

Required Type to change PVs to.

Options:: ArchDbrType.DBR_SCALAR_STRING | ArchDbrType.DBR_SCALAR_SHORT | ArchDbrType.DBR_SCALAR_FLOAT | ArchDbrType.DBR_SCALAR_ENUM | ArchDbrType.DBR_SCALAR_BYTE | ArchDbrType.DBR_SCALAR_INT | ArchDbrType.DBR_SCALAR_DOUBLE | ArchDbrType.DBR_WAVEFORM_STRING | ArchDbrType.DBR_WAVEFORM_SHORT | ArchDbrType.DBR_WAVEFORM_FLOAT | ArchDbrType.DBR_WAVEFORM_ENUM | ArchDbrType.DBR_WAVEFORM_BYTE | ArchDbrType.DBR_WAVEFORM_INT | ArchDbrType.DBR_WAVEFORM_DOUBLE | ArchDbrType.DBR_V4_GENERIC_BYTES

Arguments

FILE: Optional argument

clear-queue

Clear Queue of already archiving PVs in the archiver.

Example usage:

arch-mgmt clear-queue -a archiver.example.com

Usage

arch-mgmt clear-queue [OPTIONS]

Options

-a, --archiver-fqdn <archiver_fqdn>: Archivers where PVs reside.

-o, --old-time <old_time>: Time after which a PV is considered stuck.

-f, --queue-filter <queue_filter>

Filter to apply to the queue.

Options:: QueueFilter.ALL | QueueFilter.START | QueueFilter.METAINFO_GATHERING | QueueFilter.ARCHIVING

delete

Delete PVs in the archiver.

ARGUMENT file csv file of what pvs to delete.

Example usage:

arch-mgmt delete -a archiver.example.com pvs.csv

Usage

arch-mgmt delete [OPTIONS] [FILE]

Options

-a, --archiver-fqdn <archiver_fqdn>: Required Archiver where PVs reside.

Arguments

FILE: Optional argument

pause

Pause PVs in the archiver.

ARGUMENT file csv file of what pvs to pause.

Example usage:

arch-mgmt pause -a archiver.example.com pvs.csv

Usage

arch-mgmt pause [OPTIONS] [FILE]

Options

-a, --archiver-fqdn <archiver_fqdn>: Required Archiver where PVs reside.

Arguments

FILE: Optional argument

rename

Rename PVs in the archiver.

ARGUMENT file csv file of what pvs to rename.

Example file:

old_pv,new_pv
pv1,pv2
pv3,pv4

Example usage:

arch-mgmt rename -a archiver.example.com -a archiver.example.com pvs.csv

Usage

arch-mgmt rename [OPTIONS] [FILE]

Options

-a, --archiver-fqdn <archiver_fqdn>: Required Archiver where PVs reside.

-aa, --and-append: Required Append the data of the new PV to the old PV and rename them.

-d, --dry-run: Do a dry run.

Arguments

FILE: Optional argument

repolicy

Re choose the policy of PVs in the archiver.

ARGUMENT file csv file of what pvs to change protocol.

Example usage:

arch-mgmt repolicy -a archiver.example.com pvs.csv

Usage

arch-mgmt repolicy [OPTIONS] [FILE]

Options

-a, --archiver-fqdn <archiver_fqdn>: Required Archiver where PVs reside.

Arguments

FILE: Optional argument

resume

Resume Archiving PVs in the archiver.

ARGUMENT file csv file of what pvs to resume.

Example usage:

arch-mgmt resume -a archiver.example.com pvs.csv

Usage

arch-mgmt resume [OPTIONS] [FILE]

Options

-a, --archiver-fqdn <archiver_fqdn>: Required Archiver where PVs reside.

Arguments

FILE: Optional argument

statuses

Get the status of PVs in the archiver.

ARGUMENT file csv file of what pvs to get status.

Example usage:

arch-mgmt statuses -a archiver.example.com pvs.csv

Usage

arch-mgmt statuses [OPTIONS] [FILE]

Options

-a, --archiver-fqdn <archiver_fqdn>: Required Archiver where PVs reside.

-o, --output-file <output_file>: Output file.

Arguments

FILE: Optional argument