Skip to content

Commit

Permalink
Update connect_to_passhport.rst
Browse files Browse the repository at this point in the history
  • Loading branch information
elg committed Nov 4, 2019
1 parent e99f230 commit 324754c
Showing 1 changed file with 10 additions and 62 deletions.
72 changes: 10 additions & 62 deletions docs/user-side-usage/connect_to_passhport.rst
Original file line number Diff line number Diff line change
Expand Up @@ -4,72 +4,20 @@ Connect to PaSSHport
On Windows
------------

Well take the
You can use Putty to connect to the passhport bastion indicating your private key.


You can call passhport-admin's CLI, by calling ``passhport-admin`` with the ``-i``.

You can then configure passhportd through this command line. Refer to the good section in the submodule doc to know how to use them.

















Usages :

.. code-block:: none
passhport-admin target list
passhport-admin target search [<pattern>]
passhport-admin target checkaccess [<pattern>]
passhport-admin target show [<name>]
passhport-admin target create [((<name> <hostname>) [--login=<login>] [--type=<ssh>] [--comment=<comment>] [--sshoptions=<sshoptions>] [--port=<port>])]
passhport-admin target edit [(<name> [--newname=<name>] [--newhostname=<hostname>] [--newlogin=<login>] [--newcomment=<comment>] [--newsshoptions=<sshoptions>] [--newport=<port>])]
passhport-admin target (adduser | rmuser) [(<username> <targetname>)]
passhport-admin target (addusergroup | rmusergroup) [(<usergroupname> <targetname>)]
passhport-admin target delete [([-f | --force] <name>)]
list
-----

`passhport-admin target list` show all the configured targets.

**Example :**
On Linux / *nix
---------------
Use your standard SSH client and connect to the bastion as passhport user:
.. code-block:: none
admin@bastion:~$ passhport-admin target list
srv1.compagny.com
srv2.compagny.com
srv3.compagny.com
websrv.ext.client.com
webbackend.ext.client.com
admin@bastion:~$
search
---------

`passhport-admin target search [<PATTERN>]` searches in the target list for all targets that correspond to the given pattern.

**Example :**

ssh passhport@bastion.tld
If you want to be directly connected, you have to specify the target name in the command AND to activate the -t option:
.. code-block:: none
admin@bastion:~$ passhport-admin target search web
websrv.ext.client.com
webbackend.ext.client.com
admin@bastion:~$
If no pattern is given, user enters in interactive mode.
ssh -t passhport@bastion.tld targetname
If you want to launch a command directly, you can use the same syntaxe than belo

0 comments on commit 324754c

Please sign in to comment.