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",
    :addgroup => "user.addgroup",
    :delgroup => "user.delgroup",
    :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)

• - (nil, OpenNebula::Error) addgroup(gid)

  Adds the User to a secondary group.

• - (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 primary group

  gid	Integer the new group id.

• - (Object) delete

  Deletes the User.

• - (nil, OpenNebula::Error) delgroup(gid)

  Removes the User from a secondary group.

• - (Object) gid

  Returns the group identifier

  return

  Integer the element's group ID.

• - (Object) info (also: #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.

• - (nil, OpenNebula::Error) update(new_template, append = false)

  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

74
75
76
77
78

# File 'opennebula/user.rb', line 74

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

    @client = client
end

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

63
64
65
66
67
68
69
70
71

# File 'opennebula/user.rb', line 63

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

145
146
147

# File 'opennebula/user.rb', line 145

def addgroup(gid)
    return call(USER_METHODS[:addgroup], @pe_id, gid)
end

96
97
98

# File 'opennebula/user.rb', line 96

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

165
166
167
168
169
170
171
172

# File 'opennebula/user.rb', line 165

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

132
133
134
135
136
137
138
139

# File 'opennebula/user.rb', line 132

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

113
114
115

# File 'opennebula/user.rb', line 113

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

154
155
156

# File 'opennebula/user.rb', line 154

def delgroup(gid)
    return call(USER_METHODS[:delgroup], @pe_id, gid)
end

194
195
196

# File 'opennebula/user.rb', line 194

def gid
    self['GID'].to_i
end

85
86
87

# File 'opennebula/user.rb', line 85

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

120
121
122
123
124
125
126
127

# File 'opennebula/user.rb', line 120

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

179
180
181
182
183
184
185
186

# File 'opennebula/user.rb', line 179

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

108
109
110

# File 'opennebula/user.rb', line 108

def update(new_template, append=false)
    super(USER_METHODS[:update], new_template, append ? 1 : 0)
end