Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

  • PS > Connect-JS7 -Url <Url> -AskForCredentials
    • specifies the URL for the JOC Cockpit where the JS7 - REST Web Service API is available and asks interactively for credentials. The default JOC Cockpit account is root with the password root.
  • PS > Connect-JS7 <Url> <Credentials> <ControllerId> or PS > Connect-JS7 -Url <Url> -Credentials <Credentials> -Id <ControllerId>
    • -Url: specifies the URL of the JOC Cockpit which is the same URL that you use when opening the JOC Cockpit GUI in your browser, e.g. http://localhost:4446. When omitting the protocol (HTTP/HTTPS) for the URL then HTTP is used.
    • -Credentials: specifies the credentials, for example the user account and password that are used to connect to the JOC Cockpit.
      • A credential object can be created using keyboard input like this:
        • Set-JS7Credentials -AskForCredentials
      • A credential object can be created like this:
        • $credentials = ( New-Object -typename System.Management.Automation.PSCredential -ArgumentList 'root', ( 'root' | ConvertTo-SecureString -AsPlainText -Force) )
        • This example uses the default account root and password root.
        • A possible location for the above code is a user's PowerShell® Profile that would be executed for a PowerShell® session.
      • Credentials can be forwarded with the -Url parameter like this:
        • Connect-JS7 -Url http://root:root@localhost:4446
        • It is considered insecure to specify account and password with the URL .
      • You will find more examples including use of HTTPS connections with SSL certificates in the JS7 - How to connect to JOC Cockpit using the PowerShell Module article.
    • -Id: specifies the Controller ID that is registered with the JOC Cockpit. As the JOC Cockpit can manage a number of Controllers the -Id parameter can be used to select the relevant Controller.
  • The JS7 PowerShell® module allows cmdlets to be executed for the specified JOC Cockpit, Controller and Agents independently of the server and operating system that the respective JS7 component product is operated on. For example, users can invoke PowerShell® cmdlets on Windows to manage a JS7 Controller running on a Linux box and vice versa. As an exception to this rule you cannot start a remote JS7 Controller instance and you cannot start a remote JS7 Windows service, however, you can restart, terminate and abort any JS7 Controller instance on any platform.

...