API voor scripts op toegangsconsole en clients

De script-functie voor de Bomgar toegangsconsole bestaat uit drie delen:

  1. Bestandsindeling voor de Bomgar toegangsconsole-scripts
  2. Opdrachtregel-parameters voor de toegangsconsole
  3. API voor Bomgar client-scripts

Bestand met Bomgar toegangsconsole-scripts

Een Bomgar Console Script (BRCS) is een bestand dat een serie opdrachten bevat die door de Bomgar toegangsconsole kunnen worden uitgevoerd. De extensie van de bestandsnaam heeft het formaat “brcs-<SiteNaamBedrijf>” (SiteNaamBedrijf is de naam die voor toegang tot uw Bomgar site wordt gebruikt). Tijdens installatie gebruikt de Bomgar toegangsconsole het besturingssysteem om de toegangsconsole met het BRCS-bestandstype te associëren. Daarom kunnen gebruikers op een BRCS-bestand dubbelklikken waarna het automatisch door de Bomgar toegangsconsole wordt uitgevoerd.

BRCS-bestanden hebben de volgende indeling:

  • BRCS1.0
  • <command>
  • <command>

Formeler wordt dit uitgedrukt als:

  • brcs_file = header , newline , commands ;
  • header = "BRCS" , version ;
  • version = digit , "." , digit ;
  • commands = command { newline , command } ;
  • cijfer = "0" | "1" | "2" | "3" | "4" | "5" | "6" | "7" | "8" | "9" ;
  • newline = "\n" | "\r\n" ;

NB: Script-bestanden kunnen maximaal 10 opdrachten bevatten.

Elke opdracht bestaat uit een set sleutelwaarde-paren gescheiden door ”&”. De sleutel wordt in elk paar van de waarde gescheiden door ”=”. Voor sleutels en waarden wordt het percentage-coderingsalgoritme gebruikt zoals beschreven in RFC3986 sectie 2.1. Dit wordt algemeen url-coding of url-escaping genoemd. Dit komt u vaak tegen op de adresbalk van webbrowsers om de parameters weer te geven die aan een web server worden doorgegeven. Opdrachten hebben het volgende opmaak:

  • action=<action>&parameter1=value1&parameter2=value2...

Formeler wordt dit uitgedrukt als:

  • command = "action=", value, [ parameters ] ;
  • parameters = "&", parameter, [ parameters ] ;
  • parameter = url_encoded_string, "=", url_encoded_string ;
  • url_encoded_string = {* see RFC 3986 *} ;

Opdrachtregel-parameters voor de toegangsconsole

Er bestaan twee opdrachtregel-parameters in de toegangsconsole als ondersteuning voor BRCS:

  • run-script <BRCS-opdracht>
  • run-script-file <pad naar BRCS-bestand>

Met deze opdrachtregel-parameters kunnen gebruikers inloggen via de opdrachtregel in BRCS implementeren.

Wanneer een script vanaf de opdrachtregel wordt uitgevoerd, kunt u verschillend gedrag zien, afhankelijk van de status van de toegangsconsole:

  • Als de toegangsconsole niet wordt uitgevoerd en de gebruiker probeert een script vanaf de opdrachtregel uit te voeren, dan start de toegangsconsole de inlogdialoog op. Het script wordt uitgevoerd nadat het inloggen is geslaagd.
  • Als de toegangsconsole al wordt uitgevoerd, maar de gebruiker is niet ingelogd, dan wordt de inlogdialoog weergegeven. Het script wordt uitgevoerd nadat de gebruiker is ingelogd.
  • Als de toegangsconsole al draait, de gebruiker is al ingelogd en de gebruiker probeert een script vanaf de opdrachtregel uit te voeren, dan voert de huidige toegangsconsole het script uit.

Retourcode toegangsconsole:

  • Als op de opdrachtregel een ongeldig script wordt gegeven, dan wordt de toegangsconsole afgesloten met een retourcode > 0.
  • Als op de opdrachtregel een geldig script wordt gegeven, dan wordt de toegangsconsole afgesloten met een retourcode = 0.

Voorbeelden:

  • bomgar-acc-x64.exe --run-script "action=start_jump_item_session&client.hostname=ABCEF02&session.custom.external_key=123456789"
  • bomgar-acc-x64.exe --run-script-file my_script_file.brcs-beta60

API voor scripts op Bomgar clients

Met de API voor client scripts kunt u een Bomgar Console Script (BRCS)-bestand genereren waarmee u vanuit externe toepassingen opdrachten naar de Bomgar toegangsconsole kunt sturen.

Klanten kunnen de API voor client-scripts gebruiken om BRCS-bestanden te genereren waarmee een sessie met een specifieke jumpsnelkoppeling kan worden opgestart of om alleen maar op de toegangsconsole in te loggen.

De URL met de API voor client-scripts is https://access.example.com/api/client_script.

Deze API ondersteunt een client type (rep, een uit te voeren bewerking (generate), een commando om in het script-bestand op te nemen en een aantal parameters die aan de opdracht worden meegegeven. Hier volgt een voorbeeld van een geldig API-verzoek voor een client-script:

  • https://access.example.com/api/client_script?type=rep&operation=generate&action=start_jump_item_session&client.hostname=ABCDEFG02

Met het bovenstaande verzoek krijgt de gebruiker een prompt om een script-bestand voor een Bomgar toegangsconsole te downloaden. Nadat de gebruiker het script-bestand heeft gedownload, kan hij of zij het met de toegangsconsole uitvoeren. In dit geval bevat het script-bestand opdrachten om een sessie te starten met de Jump-client waarvan de hostnaam, opmerkingen of publiek of privé-IP-adres de tekenreeks “ABCDEF02” bevat.

Parameters voor API voor client-scripts

type=rep De Bomgar client waar deze opdracht betrekking op heeft. Momenteel ondersteunt de API alleen rep als type client.
operation=generate

De uit te voeren bewerking. Momenteel ondersteunt de API alleen generate als bewerking.

action=<command>&parameter=[value]

De uit te voeren opdracht en de benodigde parameters. De speciale acties zijn:

  • inloggen
  • start_jump_item_session

Twee acties worden automatisch aan het BRCS-bestand toegevoegd: login en delete_script_file. De actie delete_script_file heeft geen parameters.