tapis_cli.commands.taccapis.v2.systems package¶

Systems service commands

Subpackages¶

tapis_cli.commands.taccapis.v2.systems.models package

Submodules¶

tapis_cli.commands.taccapis.v2.systems.create module¶

class tapis_cli.commands.taccapis.v2.systems.create.SystemsCreate(app, app_args, cmd_name=None)¶

Bases: tapis_cli.commands.taccapis.v2.systems.formatters.SystemsFormatOne, tapis_cli.clients.services.mixins.UploadJSONTemplate

EXTRA_VERBOSITY = 2¶

HELP_STRING = 'Create a new System'¶

LEGACY_COMMMAND_STRING = 'systems-addupdate'¶

VERBOSITY = 2¶

get_parser(prog_name)¶: Return an argparse.ArgumentParser.

take_action(parsed_args)¶: Return a two-part tuple with a tuple of column names and a tuple of values.

update_json_creds(parsed_args) → None¶: Updates system login and storage credentials in attr json_file_contents with command line arguments from parsed_args.

tapis_cli.commands.taccapis.v2.systems.default_set module¶

class tapis_cli.commands.taccapis.v2.systems.default_set.SystemsDefaultSet(app, app_args, cmd_name=None)¶

Bases: tapis_cli.commands.taccapis.v2.systems.formatters.SystemsFormatOne, tapis_cli.clients.services.mixins.ServiceIdentifier

EXTRA_VERBOSITY = 2¶

HELP_STRING = 'Set a Tapis System to user (or global) default'¶

LEGACY_COMMMAND_STRING = 'systems-setdefault'¶

VERBOSITY = 1¶

get_parser(prog_name)¶: Return an argparse.ArgumentParser.

take_action(parsed_args)¶: Return a two-part tuple with a tuple of column names and a tuple of values.

tapis_cli.commands.taccapis.v2.systems.default_unset module¶

class tapis_cli.commands.taccapis.v2.systems.default_unset.SystemsDefaultUnset(app, app_args, cmd_name=None)¶

Bases: tapis_cli.commands.taccapis.v2.systems.formatters.SystemsFormatOne, tapis_cli.clients.services.mixins.ServiceIdentifier

EXTRA_VERBOSITY = 2¶

HELP_STRING = "Unset a Tapis System as the user's (or global) default"¶

LEGACY_COMMMAND_STRING = 'systems-unsetdefault'¶

VERBOSITY = 1¶

get_parser(prog_name)¶: Return an argparse.ArgumentParser.

take_action(parsed_args)¶: Return a two-part tuple with a tuple of column names and a tuple of values.

tapis_cli.commands.taccapis.v2.systems.disable module¶

class tapis_cli.commands.taccapis.v2.systems.disable.SystemsDisable(app, app_args, cmd_name=None)¶

Bases: tapis_cli.commands.taccapis.v2.systems.formatters.SystemsFormatOne, tapis_cli.clients.services.mixins.ServiceIdentifier

EXTRA_VERBOSITY = 2¶

HELP_STRING = 'Remove a System from active use'¶

LEGACY_COMMMAND_STRING = 'systems-disable'¶

VERBOSITY = 1¶

get_parser(prog_name)¶: Return an argparse.ArgumentParser.

take_action(parsed_args)¶: Return a two-part tuple with a tuple of column names and a tuple of values.

tapis_cli.commands.taccapis.v2.systems.enable module¶

class tapis_cli.commands.taccapis.v2.systems.enable.SystemsEnable(app, app_args, cmd_name=None)¶

Bases: tapis_cli.commands.taccapis.v2.systems.formatters.SystemsFormatOne, tapis_cli.clients.services.mixins.ServiceIdentifier

EXTRA_VERBOSITY = 2¶

HELP_STRING = 'Return a disabled System to active use'¶

LEGACY_COMMMAND_STRING = 'systems-enable'¶

VERBOSITY = 1¶

get_parser(prog_name)¶: Return an argparse.ArgumentParser.

take_action(parsed_args)¶: Return a two-part tuple with a tuple of column names and a tuple of values.

tapis_cli.commands.taccapis.v2.systems.formatters module¶

Formatters customized for system records and listings

class tapis_cli.commands.taccapis.v2.systems.formatters.SystemsFormatOne(app, app_args, cmd_name=None)¶: Bases: tapis_cli.commands.taccapis.v2.systems.formatters.SystemsBase, tapis_cli.commands.taccapis.formatters.TaccApisFormatOne

class tapis_cli.commands.taccapis.v2.systems.formatters.SystemsFormatMany(app, app_args, cmd_name=None)¶: Bases: tapis_cli.commands.taccapis.v2.systems.formatters.SystemsBase, tapis_cli.commands.taccapis.formatters.TaccApisFormatMany

class tapis_cli.commands.taccapis.v2.systems.formatters.SystemsHistoryFormatMany(app, app_args, cmd_name=None)¶: Bases: tapis_cli.commands.taccapis.v2.systems.formatters.SystemsBase, tapis_cli.commands.taccapis.formatters.TaccApisFormatMany

tapis_cli.commands.taccapis.v2.systems.helpers module¶

tapis_cli.commands.taccapis.v2.systems.helpers.default_execution_system(agave, public_only=False)¶

Determines a default execution system for the current user

Resolves private default, followed by public default, or None

tapis_cli.commands.taccapis.v2.systems.helpers.default_storage_system(agave, public_only=False)¶

Determines a default storage system for the current user

Resolves private default, followed by public default, or None

tapis_cli.commands.taccapis.v2.systems.history module¶

class tapis_cli.commands.taccapis.v2.systems.history.SystemsHistory(app, app_args, cmd_name=None)¶

Bases: tapis_cli.commands.taccapis.v2.systems.formatters.SystemsHistoryFormatMany, tapis_cli.clients.services.mixins.ServiceIdentifier

EXTRA_VERBOSITY = 2¶

HELP_STRING = 'Show history for a System'¶

LEGACY_COMMMAND_STRING = 'systems-history'¶

VERBOSITY = 1¶

get_parser(prog_name)¶: Return an argparse.ArgumentParser.

take_action(parsed_args)¶

Run command.

Return a tuple containing the column names and an iterable containing the data to be listed.

tapis_cli.commands.taccapis.v2.systems.list module¶

class tapis_cli.commands.taccapis.v2.systems.list.SystemsList(app, app_args, cmd_name=None)¶

Bases: tapis_cli.commands.taccapis.v2.systems.formatters.SystemsFormatMany

EXTRA_VERBOSITY = 1¶

HELP_STRING = 'List available Systems'¶

LEGACY_COMMMAND_STRING = 'systems-list'¶

VERBOSITY = 0¶

get_parser(prog_name)¶: Return an argparse.ArgumentParser.

take_action(parsed_args)¶

Run command.

Return a tuple containing the column names and an iterable containing the data to be listed.

tapis_cli.commands.taccapis.v2.systems.publish module¶

class tapis_cli.commands.taccapis.v2.systems.publish.SystemsPublish(app, app_args, cmd_name=None)¶

Bases: tapis_cli.commands.taccapis.v2.systems.formatters.SystemsFormatOne, tapis_cli.clients.services.mixins.ServiceIdentifier

EXTRA_VERBOSITY = 2¶

HELP_STRING = 'Publish a System for general use'¶

LEGACY_COMMMAND_STRING = 'systems-publish'¶

VERBOSITY = 1¶

get_parser(prog_name)¶: Return an argparse.ArgumentParser.

take_action(parsed_args)¶: Return a two-part tuple with a tuple of column names and a tuple of values.

tapis_cli.commands.taccapis.v2.systems.queues_list module¶

class tapis_cli.commands.taccapis.v2.systems.queues_list.SystemsQueuesList(app, app_args, cmd_name=None)¶

Bases: tapis_cli.commands.taccapis.v2.systems.formatters.SystemsFormatMany, tapis_cli.clients.services.mixins.ServiceIdentifier

EXTRA_VERBOSITY = 2¶

HELP_STRING = 'List virtual queues on a System'¶

LEGACY_COMMMAND_STRING = 'systems-queues-list'¶

VERBOSITY = 0¶

get_parser(prog_name)¶: Return an argparse.ArgumentParser.

take_action(parsed_args)¶

Run command.

Return a tuple containing the column names and an iterable containing the data to be listed.

tapis_cli.commands.taccapis.v2.systems.roles_drop module¶

class tapis_cli.commands.taccapis.v2.systems.roles_drop.SystemsRolesDrop(app, app_args, cmd_name=None)¶

Bases: tapis_cli.commands.taccapis.v2.systems.formatters.SystemsFormatMany, tapis_cli.clients.services.mixins.ServiceIdentifier

EXTRA_VERBOSITY = 2¶

HELP_STRING = 'Drop all granted roles from a System'¶

LEGACY_COMMMAND_STRING = 'systems-roles-delete'¶

VERBOSITY = 0¶

get_parser(prog_name)¶: Return an argparse.ArgumentParser.

take_action(parsed_args)¶

Run command.

Return a tuple containing the column names and an iterable containing the data to be listed.

tapis_cli.commands.taccapis.v2.systems.roles_grant module¶

class tapis_cli.commands.taccapis.v2.systems.roles_grant.SystemsRolesGrant(app, app_args, cmd_name=None)¶

Bases: tapis_cli.commands.taccapis.v2.systems.formatters.SystemsFormatOne, tapis_cli.clients.services.mixins.ServiceIdentifier, tapis_cli.clients.services.mixins.Username

EXTRA_VERBOSITY = 2¶

HELP_STRING = 'Grant a user role on a System'¶

LEGACY_COMMMAND_STRING = 'systems-roles-addupdate'¶

VERBOSITY = 0¶

get_parser(prog_name)¶: Return an argparse.ArgumentParser.

take_action(parsed_args)¶: Return a two-part tuple with a tuple of column names and a tuple of values.

tapis_cli.commands.taccapis.v2.systems.roles_list module¶

class tapis_cli.commands.taccapis.v2.systems.roles_list.SystemsRolesList(app, app_args, cmd_name=None)¶

Bases: tapis_cli.commands.taccapis.v2.systems.formatters.SystemsFormatMany, tapis_cli.clients.services.mixins.ServiceIdentifier

EXTRA_VERBOSITY = 2¶

HELP_STRING = 'List user roles on a System'¶

LEGACY_COMMMAND_STRING = 'systems-roles-list'¶

VERBOSITY = 0¶

get_parser(prog_name)¶: Return an argparse.ArgumentParser.

take_action(parsed_args)¶

Run command.

Return a tuple containing the column names and an iterable containing the data to be listed.

tapis_cli.commands.taccapis.v2.systems.roles_revoke module¶

class tapis_cli.commands.taccapis.v2.systems.roles_revoke.SystemsRolesRevoke(app, app_args, cmd_name=None)¶

Bases: tapis_cli.commands.taccapis.v2.systems.formatters.SystemsFormatOne, tapis_cli.clients.services.mixins.ServiceIdentifier, tapis_cli.clients.services.mixins.Username

EXTRA_VERBOSITY = 2¶

HELP_STRING = 'Revoke a user role from a System'¶

LEGACY_COMMMAND_STRING = 'systems-roles-addupdate'¶

VERBOSITY = 0¶

get_parser(prog_name)¶: Return an argparse.ArgumentParser.

take_action(parsed_args)¶: Return a two-part tuple with a tuple of column names and a tuple of values.

tapis_cli.commands.taccapis.v2.systems.roles_show module¶

class tapis_cli.commands.taccapis.v2.systems.roles_show.SystemsRolesShow(app, app_args, cmd_name=None)¶

Bases: tapis_cli.commands.taccapis.v2.systems.formatters.SystemsFormatOne, tapis_cli.clients.services.mixins.ServiceIdentifier, tapis_cli.clients.services.mixins.Username

EXTRA_VERBOSITY = 2¶

HELP_STRING = 'Show roles on a System for the specified User'¶

LEGACY_COMMMAND_STRING = 'systems-roles-list'¶

VERBOSITY = 0¶

get_parser(prog_name)¶: Return an argparse.ArgumentParser.

take_action(parsed_args)¶: Return a two-part tuple with a tuple of column names and a tuple of values.

tapis_cli.commands.taccapis.v2.systems.search module¶

class tapis_cli.commands.taccapis.v2.systems.search.SystemsSearch(app, app_args, cmd_name=None)¶

Bases: tapis_cli.commands.taccapis.v2.systems.formatters.SystemsFormatMany, tapis_cli.commands.taccapis.searchable.SearchableCommand

EXTRA_VERBOSITY = 1¶

HELP_STRING = 'Search available Systems'¶

LEGACY_COMMMAND_STRING = 'systems-search'¶

VERBOSITY = 0¶

get_parser(prog_name)¶: Return an argparse.ArgumentParser.

take_action(parsed_args)¶

Run command.

Return a tuple containing the column names and an iterable containing the data to be listed.

tapis_cli.commands.taccapis.v2.systems.show module¶

class tapis_cli.commands.taccapis.v2.systems.show.SystemsShow(app, app_args, cmd_name=None)¶

Bases: tapis_cli.commands.taccapis.v2.systems.formatters.SystemsFormatOne, tapis_cli.clients.services.mixins.ServiceIdentifier

EXTRA_VERBOSITY = 2¶

HELP_STRING = 'Show details of a System'¶

LEGACY_COMMMAND_STRING = 'systems-list'¶

VERBOSITY = 2¶

get_parser(prog_name)¶: Return an argparse.ArgumentParser.

take_action(parsed_args)¶: Return a two-part tuple with a tuple of column names and a tuple of values.

tapis_cli.commands.taccapis.v2.systems.status module¶

class tapis_cli.commands.taccapis.v2.systems.status.SystemsStatus(app, app_args, cmd_name=None)¶

Bases: tapis_cli.commands.taccapis.v2.systems.show.SystemsShow

Show status of a System

EXTRA_VERBOSITY = 0¶

HELP_STRING = 'Show status of a System'¶

LEGACY_COMMMAND_STRING = 'systems-status'¶

VERBOSITY = 0¶

tapis_cli.commands.taccapis.v2.systems.unpublish module¶

class tapis_cli.commands.taccapis.v2.systems.unpublish.SystemsUnpublish(app, app_args, cmd_name=None)¶

Bases: tapis_cli.commands.taccapis.v2.systems.formatters.SystemsFormatOne, tapis_cli.clients.services.mixins.ServiceIdentifier

EXTRA_VERBOSITY = 2¶

HELP_STRING = 'Unpublish a public System'¶

LEGACY_COMMMAND_STRING = 'systems-unpublish'¶

VERBOSITY = 1¶

get_parser(prog_name)¶: Return an argparse.ArgumentParser.

take_action(parsed_args)¶: Return a two-part tuple with a tuple of column names and a tuple of values.

tapis_cli.commands.taccapis.v2.systems.update module¶

class tapis_cli.commands.taccapis.v2.systems.update.SystemsUpdate(app, app_args, cmd_name=None)¶

Bases: tapis_cli.commands.taccapis.v2.systems.create.SystemsCreate, tapis_cli.clients.services.mixins.ServiceIdentifier

HELP_STRING = 'Update an existing System'¶

LEGACY_COMMMAND_STRING = 'systems-addupdate'¶

get_parser(prog_name)¶: Return an argparse.ArgumentParser.

take_action(parsed_args)¶: Return a two-part tuple with a tuple of column names and a tuple of values.