Class: OpenNebula::User

Inherits:

PoolElement

• Object
• XMLElement
• PoolElement
• OpenNebula::User

show all

Defined in:

OpenNebula/User.rb

Constant Summary

USER_METHODS =

Constants and Class Methods

{
    :info     => "user.info",
    :allocate => "user.allocate",
    :delete   => "user.delete",
    :passwd   => "user.passwd",
    :chgrp    => "user.chgrp",
    :update   => "user.update",
    :chauth   => "user.chauth",
    :quota    => "user.quota"
}

SELF =

-1

CORE_AUTH =

Driver name for default core authentication

"core"

CIPHER_AUTH =

Driver name for default core authentication

"server_cipher"

SSH_AUTH =

Driver name for ssh authentication

"ssh"

X509_AUTH =

Driver name for x509 authentication

"x509"

X509_PROXY_AUTH =

Driver name for x509 proxy authentication

"x509_proxy"

Class Method Summary (collapse)

• + (Object) build_xml(pe_id = nil)

  Creates a User description with just its identifier this method should be used to create plain User objects.

Instance Method Summary (collapse)

• - (Object) allocate(username, password, driver = CORE_AUTH)

  Allocates a new User in OpenNebula.

• - (nil, OpenNebula::Error) chauth(auth, password = "")

  Changes the auth driver and the password of the given User.

• - (Object) chgrp(gid)

  Changes the main group

  gid	Integer the new group id.

• - (Object) delete

  Deletes the User.

• - (Object) gid

  Returns the group identifier

  return

  Integer the element's group ID.

• - (Object) info

  Retrieves the information of the given User.

• - (User) initialize(xml, client) constructor

  Class constructor.

• - (Object) passwd(password)

  Changes the password of the given User.

• - (nil, OpenNebula::Error) set_quota(quota)

  Sets the user quota limits.

• - (Object) update(new_template)

  Replaces the template contents.

Methods inherited from PoolElement

#id, #name, new_with_id, #to_str

Methods inherited from XMLElement

#[], #add_element, #attr, #delete_element, #each, #each_xpath, #element_xml, #has_elements?, #initialize_xml, #name, #retrieve_elements, #template_like_str, #template_str, #template_xml, #text, #to_hash, #to_xml

72
73
74
75
76

# File 'OpenNebula/User.rb', line 72

def initialize(xml, client)
    super(xml,client)

    @client = client
end

user = User.new(User.build_xml(3),rpc_client)

61
62
63
64
65
66
67
68
69

# File 'OpenNebula/User.rb', line 61

def User.build_xml(pe_id=nil)
    if pe_id
        user_xml = "<USER><ID>#{pe_id}</ID></USER>"
    else
        user_xml = "<USER></USER>"
    end

    XMLElement.build_xml(user_xml, 'USER')
end

92
93
94

# File 'OpenNebula/User.rb', line 92

def allocate(username, password, driver=CORE_AUTH)
    super(USER_METHODS[:allocate], username, password, driver)
end

139
140
141
142
143
144
145
146

# File 'OpenNebula/User.rb', line 139

def chauth(auth, password="")
    return Error.new('ID not defined') if !@pe_id

    rc = @client.call(USER_METHODS[:chauth],@pe_id, auth, password)
    rc = nil if !OpenNebula.is_error?(rc)

    return rc
end

123
124
125
126
127
128
129
130

# File 'OpenNebula/User.rb', line 123

def chgrp(gid)
    return Error.new('ID not defined') if !@pe_id

    rc = @client.call(USER_METHODS[:chgrp],@pe_id, gid)
    rc = nil if !OpenNebula.is_error?(rc)

    return rc
end

104
105
106

# File 'OpenNebula/User.rb', line 104

def delete()
    super(USER_METHODS[:delete])
end

168
169
170

# File 'OpenNebula/User.rb', line 168

def gid
    self['GID'].to_i
end

83
84
85

# File 'OpenNebula/User.rb', line 83

def info()
    super(USER_METHODS[:info], 'USER')
end

111
112
113
114
115
116
117
118

# File 'OpenNebula/User.rb', line 111

def passwd(password)
    return Error.new('ID not defined') if !@pe_id

    rc = @client.call(USER_METHODS[:passwd], @pe_id, password)
    rc = nil if !OpenNebula.is_error?(rc)

    return rc
end

153
154
155
156
157
158
159
160

# File 'OpenNebula/User.rb', line 153

def set_quota(quota)
    return Error.new('ID not defined') if !@pe_id

    rc = @client.call(USER_METHODS[:quota],@pe_id, quota)
    rc = nil if !OpenNebula.is_error?(rc)

    return rc
end

99
100
101

# File 'OpenNebula/User.rb', line 99

def update(new_template)
    super(USER_METHODS[:update], new_template)
end