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

Document-class: ClientOptions

ClientOptions control the behaviour of the Client connection

The primary use of ClientOptions in normal operations is adding selectors - key/value pairs added to the request URL.

For WS-CIM operations, selectors define the key attributes for the selected CIM class to address a specific instance of the class.

Methods

Public Class methods

new()

Public Instance methods

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

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

Add a property as key/value pair

Add a selector as key/value pair

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

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

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

Reset dump all operations to the dumpfile

Used for debugging on the wire-level

See also: set_dump_request

clear option flag(s)

clears specific flag(s) from options

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

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

Get subscription delivery security mode

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()

Get fragment filter See DSP0226, section 7.7.

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

Get subscription heartbeat interval (in seconds)

Set subscription heartbeat interval (in seconds)

Return enumeration elements limit

Limit number of elements returned by enumeration

max_envelope_size()

Limit size of result document

Get options (for OptionSet) as Hash

Set options (for OptionSet) from Hash

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

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

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

reset option flags

sets option flags bitmask to FLAG_NONE

Set selectors from Hash

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

Request to dump all operations to the dumpfile

Used for debugging on the wire-level

See also: clear_dump_request

Get subscription expiry timeout (in seconds)

Set subscription expiry timeout (in seconds)

timeout()

[Validate]