Skip to content

Latest commit

 

History

History
78 lines (51 loc) · 2.16 KB

pxc_script.md

File metadata and controls

78 lines (51 loc) · 2.16 KB

pxc script

Run a script against the current cluster

Synopsis

Run a SDK script to communicate to the specified Kubernetes and Portworx systems. Pxc will pass to the script all configuration and authentication information needed.

Pxc scripts current only support Python scripts, but more langauges will be supported in future releases.

pxc script [NAME] [flags]

Examples


  # Python

  You will need to first type the following to install the required library:

      pip3 install --user --upgrade libopenstorage-openstorage

  The following python example application can used to return the id and status
  of a Portworx cluster:

      import grpc

      from openstorage import api_pb2
      from openstorage import api_pb2_grpc
      from openstorage import connector

      # No need to setup connection information to your cluster.
      # pxc will pass all the required information.
      c = connector.Connector()
      channel = c.connect()

      try:
          clusters = api_pb2_grpc.OpenStorageClusterStub(channel)
          ic_resp = clusters.InspectCurrent(api_pb2.SdkClusterInspectCurrentRequest())
          print('Conntected to {0} with status {1}'.format(ic_resp.cluster.id, api_pb2.Status.Name(ic_resp.cluster.status)))
      except grpc.RpcError as e:
          print('Failed: code={0} msg={1}'.format(e.code(), e.details()))

  For more information please visit the python tutorial on https://libopenstorage.github.io/

  # Execute a python script called myscript.py
  pxc script myscript.py

Options

  -h, --help              help for script
  -l, --language string   Script language. Currently only python is supported. (default "python")

Options inherited from parent commands

      --pxc.config string       Config file (default is $HOME/.pxc/config.yml)
      --pxc.config-dir string   Config directory (default "/home2/lpabon/.pxc")
      --pxc.context string      Force context name for the command
      --pxc.token string        Portworx authentication token
      --pxc.v int32             [0-3] Log level verbosity

SEE ALSO

  • pxc - Portworx client
Auto generated by spf13/cobra on 29-Sep-2021