Differences

This shows you the differences between two versions of the page.

--- extensions:slack [2017/05/28 00:35] – Gerard Nicol
+++ extensions:slack [2025/01/21 22:07] (current) – external edit 127.0.0.1
@@ Line 1: / Line 1: @@
-====== Overview ======
+====== TapeTrack Slack App ======
-The TapeTrack Slack App allows you to query tape libraries and move tapes from one location to another by all from within [[https://slack.com/ | Slack]].
+The TapeTrack Slack App allows you to query tape libraries and move tapes from one location to another all from within [[https://slack.com/ | Slack]].
+{{:extensions:slack_help.png?600|}}
+{{page>common:support}}
 ====== Prerequisites ======
-  - A Slack Account
+  - Active Slack Account
-  - Open Data Protection (ODPAPI) API Adapter for TapeTrack or URL of an existing Adapter.
+  - Open Data Protection API (ODPAPI) Adapter for TapeTrack or URL of an existing Adapter.
-  - TapeTrack credentials.
+  - [[common:logon|TapeTrack credentials]].
 ====== Connecting the App ======
+To install the App simply click the App icon on the Slack app directory or by clicking the icon below.
+<html>
+<a href="https://slack.com/oauth/authorize?scope=commands&client_id=164668305509.189569582598"><img alt="Add to Slack" height="40" width="139" src="https://platform.slack-edge.com/img/add_to_slack.png" srcset="https://platform.slack-edge.com/img/add_to_slack.png 1x, https://platform.slack-edge.com/img/add_to_slack@2x.png 2x" /></a>
+</html>
+As all settings are set via /tapetrack commands, there is no need to interact outside of Slack during installation.
+======  Security Considerations ======
+When adding new adapters to your Slack profile, the following information will be securely stored on GazillaByte's Servers:
+  - Adapter name.
+  - Adapter URL
+  - TapeTrack User-ID and password.
+Only the Slack user that sets these values will be able to use, list and delete this data. When listing adapters, the password will not be displayed to preserve security.
+When an adapter is added to your Slack profile, care should be taken to ensure that unauthorized users do not use your Slack account.
 ====== App Commands ======
+===== Adapters =====
+Before you can use the TapeTrack Slack App you must first add at least one ODPAPI Adapter.
+==== Adding an Adapter ====
+=== Syntax ===
+<code plain;>
+/tapetrack adapter add name adapter_url
+</code>
+=== Example ===
+<code plain;>
+/tapetrack adapter add TestBed http://testuser:testuser@testbed.tapetrack.com/dpapi-v1
+</code>
+==== Listing Adapters ====
+=== Syntax ===
+<code>
+/tapetrack adapter list
+</code>
+{{:extensions:slack_adapter_list.jpg}}
+==== Deleting an Adapter ====
+=== Syntax ===
+<code>
+/tapetrack adapter delete name
+</code>
+=== Example ===
+<code>
+/tapetrack adapter delete TestBed
+</code>
+===== Libraries =====
+==== Listing Libraries ====
+When listing libraries you can either query one of the adapters by name, or use a wildcard to match the closest adapter.
+=== Syntax ===
+<code>
+/tapetrack name library list
+</code>
+=== Example ===
+<code>
+/tapetrack * library list
+</code>
+{{:extensions:slack_library_list.jpg|}}
+In the returned list of accessible libraries you will get a library UUID along with the library description. The library UUID will be used to access that library and the tapes within it going forward.
+==== Library Information ====
+=== Syntax ===
+<code>
+/tapetrack name library info library_uuid
+</code>
+=== Example ===
+<code>
+/tapetrack name library info 41553031-0000-0000-4c54-4f004f464653
+</code>
+{{:extensions:slack_library_info.jpg?}}
+At the bottom of the library info command button is a Show button. You can click this to list the tapes that belong to that library.
+======Tapes======
+==== Listing Tapes ====
+=== Syntax ===
+<code>
+/tapetrack name object list library_uuid
+</code>
+=== Example ===
+<code>
+/tapetrack * object list 41553031-0000-0000-4c54-4f004f464653
+</code>
+{{:extensions:slack_object_list.jpg}}
+==== Tape Information ====
+=== Syntax ===
+<code>
+/tapetrack name object info library_uuid tape_id
+</code>
+=== Example ===
+<code>
+/tapetrack * object info 41553031-0000-0000-4c54-4f004f464653 000002L4
+</code>
+{{:extensions:slack_object_info.jpg}}
+====== Finding a tape ======
+To find a tape you can use the whereis command. This will tell you which libraries a given tape can be found in.
+=== Syntax ===
+<code>
+/tapetrack name whereis tape_id
+</code>
+=== Example ===
+<code>
+/tapetrack * whereis 000001L4
+</code>
+{{:extensions:slack_whereis.jpg}}
+====== Help ======
+To obtain help text run the help command.
+{{:extensions:slack_help_command.jpg}}