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

Methods

agent   agent=   auth_method   auth_method=   auth_method?   auth_name   auth_request_callback   auth_value   cainfo   cainfo=   calocal   calocal=   caoid   caoid=   capath   capath=   cert   cert=   certhumbprint   certhumbprint=   close   error_string   key   key=   password   password=   proxy   proxy=   proxy_password   proxy_password=   proxy_username   proxy_username=   proxyauth   proxyauth=   timeout   timeout=   username   username=   verify_host=   verify_host?   verify_peer=   verify_peer?  

Public Class methods

auth_request_callback(client, auth_type)

called when authentication credentials missing or wrong

Public Instance methods

transport.agent → String

Get the HTTP agent identifier string

transport.agent = "Client identifier"

Set the HTTP agent identifier (User-agent:) string

This is how the client will show up in the servers http log. Defaults to "Openwsman"

transport.auth_method → String

Set the authentication method

auth_method=(p1)

Set the authentication method

Value must be one of:

  • Openwsman::NO_AUTH_STR
  • Openwsman::BASIC_AUTH_STR
  • Openwsman::DIGEST_AUTH_STR
  • Openwsman::PASS_AUTH_STR
  • Openwsman::NTLM_AUTH_STR
  • Openwsman::GSSNEGOTIATE_AUTH_STR
transport.auth_method?(Integer) → Boolean

Check if the passed method id is valid for authentication

transport.auth_name(Integer) → String

Set the authentication method string corresponding to the given auth method id

Value must be one of:

  • Openwsman::NO_AUTH
  • Openwsman::BASIC_AUTH
  • Openwsman::DIGEST_AUTH
  • Openwsman::PASS_AUTH
  • Openwsman::NTLM_AUTH
  • Openwsman::GSSNEGOTIATE_AUTH
auth_value()

Get the authentication method integer id

transport.cainfo → String

Get the certification authority (CAINFO)

cainfo=(p1)

Set the certification authority (CAINFO)

transport.calocal → Boolean

Windows client

Use local CA ?

calocal=(p1)

Windows client

Use local CA ?

caoid()

Windows client

Get the CA OID

caoid=(p1)

Windows client

Set the CA OID

Reference

support.microsoft.com/kb/287547

capath()

Get the path to the certification authority (CAINFO) store

capath=(p1)

Set the path to the certification authority (CAINFO) store

cert()

Get the certificate

cert=(p1)

Set the certificate

transport.certhumbprint → String

Set the certification thumbprint

certhumbprint=(p1)

Set the certification thumbprint

close()

Close the transport. No further communication possible.

transport.error_string(Integer) → String

Get string corresponding to given error code

key()

Get the key

key=(p1)

Set the key

transport.password → String

Server credentials

Get the password part of the http transport credentials

transport.password = "Password"

Server credentials

Set the password part of the http transport credentials

proxy()

Get http proxy URL

proxy=(p1)

Set http proxy URL

Pass nil to disable proxy communication

Example
  transport.proxy = "http://your.proxy.com:80"
transport.proxy_password → String

Windows clients: HTTP proxy credentials

Get the password part of the http proxy credentials

transport.proxy_password = "proxy_password"

Windows clients: HTTP proxy credentials

Set the password part of the http proxy credentials

transport.proxy_username → String

Windows clients: HTTP proxy credentials

Get the username part of the http proxy credentials

transport.proxy_username = "proxy_username"

Windows clients: HTTP proxy credentials

Set the username part of the http proxy credentials

transport.proxyauth → String

Linux clients: HTTP proxy credentials

Get the proxy username and password as "username:password"

proxyauth=(p1)

Linux clients: HTTP proxy credentials

Set the proxy username and password

Example
  transport.proxyauth = "username:password"
timeout()
timeout=(p1)

Set the transport timeout in seconds

Note

This is the http layer timeout. Not to be confused with the WS-Management operation timeout set via Openwsman::ClientOptions.timeout

transport.username → String

Server credentials

Get the username part of the http transport credentials

transport.username = "Username"

Server credentials

Set the username part of the http transport credentials

verify_host=(p1)

verify the host in SSL communication ?

If passed false, nil, or 0: disable peer verification else: enable peer verification

verify_host?()
verify_peer=(p1)

verify the peer in SSL communication ?

If passed false, nil, or 0: disable peer verification else: enable peer verification

verify_peer?()

[Validate]