original_docstring: StartBulkVolumeRead enables you to initialize a bulk volume read session on a specified volume. Only two bulk volume processes
docstring: StartBulkVolumeRead enables you to initialize a bulk volume read session on a specified volume. Only two bulk volume processes
docstring_tokens: StartBulkVolumeRead enables you to initialize a bulk volume read session on a specified volume . Only two bulk volume processes
code: def startbulkread(ctx,
             # Mandatory main parameter
             volumeid,
             # Mandatory main parameter
             format,
             # Optional main parameter
             snapshotid = None,
             # Optional main parameter
             script = None,
             # Optional main parameter
             scriptparameters = None,
             # Optional main parameter
             attributes = None):
      """StartBulkVolumeRead enables you to initialize a bulk volume read session on a specified volume. Only two bulk volume processes"""
      """can run simultaneously on a volume. When you initialize the session, data is read from a SolidFire storage volume for the purposes"""
      """of storing the data on an external backup source. The external data is accessed by a web server running on an SF-series node."""
      """Communications and server interaction information for external data access is passed by a script running on the storage system."""
      """At the start of a bulk volume read operation, a snapshot of the volume is made and the snapshot is deleted when the read is complete. You can also read a snapshot of the volume by entering the ID of the snapshot as a parameter. When you read a"""
      """previous snapshot, the system does not create a new snapshot of the volume or delete the previous snapshot when the"""
      """read completes."""
      """Note: This process creates a new snapshot if the ID of an existing snapshot is not provided. Snapshots can be created if cluster fullness is at stage 2 or 3. Snapshots are not created when cluster fullness is at stage 4 or 5."""
  
      
  
      cli_utils.establish_connection(ctx)
      
      
      
      
      
  
      kwargsDict = None
      if(scriptparameters is not None and scriptparameters != ()):
          try:
              kwargsDict = simplejson.loads(scriptparameters)
          except Exception as e:
              ctx.logger.error(e.__str__())
              exit(1)
      
  
      kwargsDict = None
      if(attributes is not None and attributes != ()):
          try:
              kwargsDict = simplejson.loads(attributes)
          except Exception as e:
              ctx.logger.error(e.__str__())
              exit(1)
      
  
      
  
      ctx.logger.info(""": """"""volumeid = """ + str(volumeid)+";"+"""format = """ + str(format)+";" + """snapshotid = """+str(snapshotid)+";" + """script = """+str(script)+";" + """scriptparameters = """+str(kwargsDict)+";" + """attributes = """+str(kwargsDict)+""";"""+"")
      try:
          _StartBulkVolumeReadResult = ctx.element.start_bulk_volume_read(volume_id=volumeid, format=format, snapshot_id=snapshotid, script=script, script_parameters=kwargsDict, attributes=kwargsDict)
      except common.ApiServerError as e:
          ctx.logger.error(e.message)
          exit()
      except BaseException as e:
          ctx.logger.error(e.__str__())
          exit()
      if ctx.json:
          print(simplejson.dumps(simplejson.loads(_StartBulkVolumeReadResult), indent=4))
          return
      else:
          cli_utils.print_result(_StartBulkVolumeReadResult, ctx.logger, as_json=ctx.json, as_pickle=ctx.pickle, depth=ctx.depth, filter_tree=ctx.filter_tree)
code_tokens: def startbulkread ( ctx , volumeid , format , snapshotid = None , script = None , scriptparameters = None , attributes = None ) : """can run simultaneously on a volume. When you initialize the session, data is read from a SolidFire storage volume for the purposes""" """of storing the data on an external backup source. The external data is accessed by a web server running on an SF-series node.""" """Communications and server interaction information for external data access is passed by a script running on the storage system.""" """At the start of a bulk volume read operation, a snapshot of the volume is made and the snapshot is deleted when the read is complete. You can also read a snapshot of the volume by entering the ID of the snapshot as a parameter. When you read a""" """previous snapshot, the system does not create a new snapshot of the volume or delete the previous snapshot when the""" """read completes.""" """Note: This process creates a new snapshot if the ID of an existing snapshot is not provided. Snapshots can be created if cluster fullness is at stage 2 or 3. Snapshots are not created when cluster fullness is at stage 4 or 5.""" cli_utils . establish_connection ( ctx ) kwargsDict = None if ( scriptparameters is not None and scriptparameters != ( ) ) : try : kwargsDict = simplejson . loads ( scriptparameters ) except Exception as e : ctx . logger . error ( e . __str__ ( ) ) exit ( 1 ) kwargsDict = None if ( attributes is not None and attributes != ( ) ) : try : kwargsDict = simplejson . loads ( attributes ) except Exception as e : ctx . logger . error ( e . __str__ ( ) ) exit ( 1 ) ctx . logger . info ( """: """ """volumeid = """ + str ( volumeid ) + ";" + """format = """ + str ( format ) + ";" + """snapshotid = """ + str ( snapshotid ) + ";" + """script = """ + str ( script ) + ";" + """scriptparameters = """ + str ( kwargsDict ) + ";" + """attributes = """ + str ( kwargsDict ) + """;""" + "" ) try : _StartBulkVolumeReadResult = ctx . element . start_bulk_volume_read ( volume_id = volumeid , format = format , snapshot_id = snapshotid , script = script , script_parameters = kwargsDict , attributes = kwargsDict ) except common . ApiServerError as e : ctx . logger . error ( e . message ) exit ( ) except BaseException as e : ctx . logger . error ( e . __str__ ( ) ) exit ( ) if ctx . json : print ( simplejson . dumps ( simplejson . loads ( _StartBulkVolumeReadResult ) , indent = 4 ) ) return else : cli_utils . print_result ( _StartBulkVolumeReadResult , ctx . logger , as_json = ctx . json , as_pickle = ctx . pickle , depth = ctx . depth , filter_tree = ctx . filter_tree )
short_docstring: StartBulkVolumeRead enables you to initialize a bulk volume read session on a specified volume.
short_docstring_tokens: StartBulkVolumeRead enables you to initialize a bulk volume read session on a specified volume .
comment: # Mandatory main parameter$SEP$# Mandatory main parameter$SEP$# Optional main parameter$SEP$# Optional main parameter$SEP$# Optional main parameter$SEP$# Optional main parameter$SEP$"""StartBulkVolumeRead enables you to initialize a bulk volume read session on a specified volume. Only two bulk volume processes"""$SEP$"""can run simultaneously on a volume. When you initialize the session, data is read from a SolidFire storage volume for the purposes"""$SEP$"""of storing the data on an external backup source. The external data is accessed by a web server running on an SF-series node."""$SEP$"""Communications and server interaction information for external data access is passed by a script running on the storage system."""$SEP$"""At the start of a bulk volume read operation, a snapshot of the volume is made and the snapshot is deleted when the read is complete. You can also read a snapshot of the volume by entering the ID of the snapshot as a parameter. When you read a"""$SEP$"""previous snapshot, the system does not create a new snapshot of the volume or delete the previous snapshot when the"""$SEP$"""read completes."""$SEP$"""Note: This process creates a new snapshot if the ID of an existing snapshot is not provided. Snapshots can be created if cluster fullness is at stage 2 or 3. Snapshots are not created when cluster fullness is at stage 4 or 5."""