Class Openwsman::Client
In: openwsman.i
Parent: Object

Instances of Client represent a connection to a client used for sending WS-Management operation requests.

Methods

create   delete   delete_from_epr   dumpfile=   encoding   encoding=   enumerate   fault_string   get   get_from_epr   host   identify   invoke   last_error   new   new   password   path   port   pull   put   release   renew   response_code   scheme   send_request   subscribe   transport   unsubscribe   user  

Public Class methods

Client.new(uri)
Client.new(host, port, path, scheme, username, password)

Create a client connection.

There are two ways to connect to a client, either by specifying a URL or by passing all client parameters separately 

 Client.new("http://user:pass@host.domain.com:1234/path")
 Client.new("host.domain.com", 1234, "/path", "http", "user", "pass")
Client.new(uri)
Client.new(host, port, path, scheme, username, password)

Create a client connection.

There are two ways to connect to a client, either by specifying a URL or by passing all client parameters separately 

 Client.new("http://user:pass@host.domain.com:1234/path")
 Client.new("host.domain.com", 1234, "/path", "http", "user", "pass")

Public Instance methods

delete_from_epr(p1, p2)

WS-Delete

delete_from_epr: Remove a resource via an endpoint reference

client.dumpfile = File.open(...)

Set the dumpfile (for debugging) to dump xml requests

result = client.enumerate(options, filter, uri)

WS-Enumerate

enumerate: List resources

It is highly recommended to do an optimized enumeration by setting the client options 

  options.flags = Openwsman::FLAG_ENUMERATION_OPTIMIZATION
  options.max_elements = 999

to get the enumeration result as part of the http request.

Otherwise separate pull requests are needed resulting in extra round-trips (client -> wsman -> cimom & back), dramatically affecting performance.

client.fault_string

Get a string representation of the last fault

get_from_epr(p1, p2)

WS-Get

get_from_epr: Get a resource via an endpoint reference

host()

The host part of the client URL

client.last_error

Get a numeric representation of the last fault

password()

The password used for authentication

path()

The path of the clien URL

port()

The TCP port used in the connection

result = client.pull(options, filter, uri, context)

WS-Transport

pull: Get resources from enumeration context

result = client.release(options, uri, context)

WS-Release

release: Release enumeration context

client.reponse_code → Integer

Response code of the last request (HTTP response code)

scheme()

String representation of the transport scheme (‘http’, ‘https’)

result = client.send_request(XmlDoc.new("..."))

Send a (raw) SOAP request to the client

result = client.subscribe(options, filter, uri)

WS-Eventing

subscribe: Subscribe a listener to events

transport()

The Transport instance associated to the client

user()

The user name used for authentication

[Validate]