Class Openwsman::ClientOptions
In: ../openwsman.i
openwsman/openwsman.rb
Parent: Object

Methods

add_option   add_property   add_property_array_item   add_selector   cim_namespace   cim_namespace=   clear_dump_request   clear_flags   delivery_mode   delivery_mode=   delivery_sec_mode   delivery_security_mode=   delivery_uri   delivery_uri=   flags   flags=   fragment   fragment=   heartbeat_interval   heartbeat_interval=   locale   locale=   max_elements   max_elements=   max_envelope_size   max_envelope_size=   new   options   options=   properties   properties=   reference   reference=   reset_flags   selectors   selectors=   set_dump_request   sub_expiry   sub_expiry=   timeout   timeout=  

Public Class methods

new()

Public Instance methods

options.add_option "Name", "Value"

Add an option (for OptionSet) as key/value pair

NOTE: the value must be properly escaped (replace & with &, etc.) in Ruby use CGI::escapeHTML()

options.add_property "Key", "Value"
options.add_property "Key", EndPointReference.new(...)

Add a property as key/value pair

  • Input parameters to ‘invoke‘d methods are represented as ClientOption properties
  • Key is evaluated as String
  • Value is evaluated as String or EndPointReference
options.add_property( "Key", "Value" )

Add a string property as key/value pair (an ‘add_property’ analogue for adding array items)

  • Input parameters to ‘invoke‘d methods are represented as ClientOption properties
options.add_selector "Key", "Value"
options.add_selector "Key", end_point_reference

Add a selector as key/value pair

NOTE: the string value must be properly escaped (replace & with &, etc.) in Ruby use CGI::escapeHTML()

options.cim_namespace → String

Get CIM Namespace for Openwsman Note: Microsoft WinRM set the resource namespace by attaching it to the resource URI

See also: Openwsman.epr_prefix_for

options.cim_namespace = "root/interop"

Set CIM Namespace for Openwsman (default is root/cimv2) Note: Microsoft WinRM set the resource namespace by attaching it to the resource URI

See also: Openwsman.epr_prefix_for

options.clear_dump_request

Reset dump all operations to the dumpfile

Used for debugging on the wire-level

See also: set_dump_request

options.clear_flags Openwsman::FLAG_ENUMERATION_OPTIMIZATION

clear option flag(s)

clears specific flag(s) from options

options.delivery_mode → Integer

Get subscription delivery mode (push, pushwithack,events,pull)

options.delivery_mode = Openwsman::WSMAN_DELIVERY_PUSH

Set subscription delivery mode (push, pushwithack,events,pull)

options.delivery_security_mode → Integer

Get subscription delivery security mode

options.delivery_security_mode = Openwsman::WSMAN_DELIVERY_SEC_HTTPS_BASIC

Set subscription delivery security mode

(auto, http basic, http digest, https basic, https digest, https mutual, https mutual basic, https mutual digest, http spnego kerberos, https spnego kerberos, https mutual spnego kerberos)

flags()
options.fragment → String

Get fragment filter See DSP0226, section 7.7.

options.fragment = "xpath/expression"

Set fragment filter See DSP0226, section 7.7. (Supported Dialects: XPATH)

options.heartbeat_interval → Integer

Get subscription heartbeat interval (in seconds)

options.heartbeat_interval = 60 # every minute

Set subscription heartbeat interval (in seconds)

options.max_elements → Integer

Return enumeration elements limit

options.max_elements = 42

Limit number of elements returned by enumeration

max_envelope_size()
options.max_envelope_size = 10240

Limit size of result document

options.options → Hash

Get options (for OptionSet) as Hash

options.options = { "Name" => "Value", ... }

Set options (for OptionSet) from Hash

NOTE: the values must be properly escaped (replace & with &, etc.) in Ruby use CGI::escapeHTML()

options.properties → Hash

Get properties as Hash

  • Input parameters to ‘invoke‘d methods are represented as ClientOption properties
options.reference → String

Get WS-Addressing reference properties Returns the string representation of a valid XML document

options.reference = ""

Set WS-Addressing reference properties Argument must the string representation of a valid XML document

options.reset_flags

reset option flags

sets option flags bitmask to FLAG_NONE

options.set_dump_request

Request to dump all operations to the dumpfile

Used for debugging on the wire-level

See also: clear_dump_request

options.sub_expiry → Integer

Get subscription expiry timeout (in seconds)

options.sub_expiry = 600 # 10 mins

Set subscription expiry timeout (in seconds)

timeout()

[Validate]