Class: IntersightClient::HyperflexLocalCredentialPolicy

Inherits:
PolicyAbstractPolicy show all
Defined in:
lib/intersight_client/models/hyperflex_local_credential_policy.rb

Overview

A policy specifying credentials for HyperFlex cluster such as controller VM password, hypervisor username, and password.

Defined Under Namespace

Classes: EnumAttributeValidator

Instance Attribute Summary collapse

Attributes inherited from PolicyAbstractPolicy

#description, #name

Attributes inherited from MoBaseMo

#account_moid, #ancestors, #create_time, #display_names, #domain_group_moid, #mod_time, #moid, #owners, #parent, #permission_resources, #shared_scope, #tags, #version_context

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ HyperflexLocalCredentialPolicy

Initializes the object

Parameters:

  • (defaults to: {})

    Model attributes in the form of hash



134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
 
# File 'lib/intersight_client/models/hyperflex_local_credential_policy.rb', line 134

def initialize(attributes = {})
  if (!attributes.is_a?(Hash))
    fail ArgumentError, "The input argument (attributes) must be a hash in `IntersightClient::HyperflexLocalCredentialPolicy` initialize method"
  end

  # check to see if the attribute exists and convert string to symbol for hash key
  attributes = attributes.each_with_object({}) { |(k, v), h|
    if (!self.class.acceptable_attribute_map.key?(k.to_sym))
      fail ArgumentError, "`#{k}` is not a valid attribute in `#{self.class.name}`. Please check the name to make sure it's valid. List of attributes: " + self.class.acceptable_attribute_map.keys.inspect
    end
    h[k.to_sym] = v
  }

  # call parent's initialize
  super(attributes)

  if attributes.key?(:'class_id')
    self.class_id = attributes[:'class_id']
  else
    self.class_id = 'hyperflex.LocalCredentialPolicy'
  end

  if attributes.key?(:'object_type')
    self.object_type = attributes[:'object_type']
  else
    self.object_type = 'hyperflex.LocalCredentialPolicy'
  end

  if attributes.key?(:'factory_hypervisor_password')
    self.factory_hypervisor_password = attributes[:'factory_hypervisor_password']
  else
    self.factory_hypervisor_password = false
  end

  if attributes.key?(:'hxdp_root_pwd')
    self.hxdp_root_pwd = attributes[:'hxdp_root_pwd']
  end

  if attributes.key?(:'hypervisor_admin')
    self.hypervisor_admin = attributes[:'hypervisor_admin']
  end

  if attributes.key?(:'hypervisor_admin_pwd')
    self.hypervisor_admin_pwd = attributes[:'hypervisor_admin_pwd']
  end

  if attributes.key?(:'is_hxdp_root_pwd_set')
    self.is_hxdp_root_pwd_set = attributes[:'is_hxdp_root_pwd_set']
  else
    self.is_hxdp_root_pwd_set = false
  end

  if attributes.key?(:'is_hypervisor_admin_pwd_set')
    self.is_hypervisor_admin_pwd_set = attributes[:'is_hypervisor_admin_pwd_set']
  else
    self.is_hypervisor_admin_pwd_set = false
  end

  if attributes.key?(:'cluster_profiles')
    if (value = attributes[:'cluster_profiles']).is_a?(Array)
      self.cluster_profiles = value
    end
  end

  if attributes.key?(:'organization')
    self.organization = attributes[:'organization']
  end
end

Instance Attribute Details

#class_id ⇒ Object

The fully-qualified name of the instantiated, concrete type. This property is used as a discriminator to identify the type of the payload when marshaling and unmarshaling data.



20
21
22
 
# File 'lib/intersight_client/models/hyperflex_local_credential_policy.rb', line 20

def class_id
  @class_id
end

#cluster_profiles ⇒ Object

An array of relationships to hyperflexClusterProfile resources.



44
45
46
 
# File 'lib/intersight_client/models/hyperflex_local_credential_policy.rb', line 44

def cluster_profiles
  @cluster_profiles
end

#factory_hypervisor_password ⇒ Object

Indicates if Hypervisor password is the factory set default password. For HyperFlex Data Platform versions 3.0 or higher, enable this if the default password was not changed on the Hypervisor. It is required to supply a new custom Hypervisor password that will be applied to the Hypervisor during deployment. For HyperFlex Data Platform versions prior to 3.0 release, this setting has no effect and the default password will be used for initial install. The Hypervisor password should be changed after deployment.



26
27
28
 
# File 'lib/intersight_client/models/hyperflex_local_credential_policy.rb', line 26

def factory_hypervisor_password
  @factory_hypervisor_password
end

#hxdp_root_pwd ⇒ Object

HyperFlex storage controller VM password must contain a minimum of 10 characters, with at least 1 lowercase, 1 uppercase, 1 numeric, and 1 of these -_@#$%^&*! special characters.



29
30
31
 
# File 'lib/intersight_client/models/hyperflex_local_credential_policy.rb', line 29

def hxdp_root_pwd
  @hxdp_root_pwd
end

#hypervisor_admin ⇒ Object

Hypervisor administrator username must contain only alphanumeric characters.



32
33
34
 
# File 'lib/intersight_client/models/hyperflex_local_credential_policy.rb', line 32

def hypervisor_admin
  @hypervisor_admin
end

#hypervisor_admin_pwd ⇒ Object

The Hypervisor root password. For HyperFlex Data Platform 3.0 or later, if the factory default password was not manually changed, you must set a new custom password. If the password was manually changed, you must not enable the factory default password property and provide the current hypervisor password. Note - All HyperFlex nodes require the same hypervisor password for installation. For HyperFlex Data Platform prior to 3.0, use the default password "Cisco123" for newly manufactured HyperFlex servers. A custom password should only be entered if hypervisor credentials were manually changed prior to deployment.



35
36
37
 
# File 'lib/intersight_client/models/hyperflex_local_credential_policy.rb', line 35

def hypervisor_admin_pwd
  @hypervisor_admin_pwd
end

#is_hxdp_root_pwd_set ⇒ Object

Indicates whether the value of the ‘hxdpRootPwd’ property has been set.



38
39
40
 
# File 'lib/intersight_client/models/hyperflex_local_credential_policy.rb', line 38

def is_hxdp_root_pwd_set
  @is_hxdp_root_pwd_set
end

#is_hypervisor_admin_pwd_set ⇒ Object

Indicates whether the value of the ‘hypervisorAdminPwd’ property has been set.



41
42
43
 
# File 'lib/intersight_client/models/hyperflex_local_credential_policy.rb', line 41

def is_hypervisor_admin_pwd_set
  @is_hypervisor_admin_pwd_set
end

#object_type ⇒ Object

The fully-qualified name of the instantiated, concrete type. The value should be the same as the ‘ClassId’ property.



23
24
25
 
# File 'lib/intersight_client/models/hyperflex_local_credential_policy.rb', line 23

def object_type
  @object_type
end

#organization ⇒ Object

Returns the value of attribute organization.



46
47
48
 
# File 'lib/intersight_client/models/hyperflex_local_credential_policy.rb', line 46

def organization
  @organization
end

Class Method Details

.acceptable_attribute_map ⇒ Object

Returns the key-value map of all the JSON attributes this model knows about, including the ones defined in its parent(s)



92
93
94
 
# File 'lib/intersight_client/models/hyperflex_local_credential_policy.rb', line 92

def self.acceptable_attribute_map
  attribute_map.merge(superclass.acceptable_attribute_map)
end

.acceptable_attributes ⇒ Object

Returns all the JSON keys this model knows about, including the ones defined in its parent(s)



87
88
89
 
# File 'lib/intersight_client/models/hyperflex_local_credential_policy.rb', line 87

def self.acceptable_attributes
  attribute_map.values.concat(superclass.acceptable_attributes)
end

.attribute_map ⇒ Object

Attribute mapping from ruby-style variable name to JSON key.



71
72
73
74
75
76
77
78
79
80
81
82
83
84
 
# File 'lib/intersight_client/models/hyperflex_local_credential_policy.rb', line 71

def self.attribute_map
  {
    :'class_id' => :'ClassId',
    :'object_type' => :'ObjectType',
    :'factory_hypervisor_password' => :'FactoryHypervisorPassword',
    :'hxdp_root_pwd' => :'HxdpRootPwd',
    :'hypervisor_admin' => :'HypervisorAdmin',
    :'hypervisor_admin_pwd' => :'HypervisorAdminPwd',
    :'is_hxdp_root_pwd_set' => :'IsHxdpRootPwdSet',
    :'is_hypervisor_admin_pwd_set' => :'IsHypervisorAdminPwdSet',
    :'cluster_profiles' => :'ClusterProfiles',
    :'organization' => :'Organization'
  }
end

.build_from_hash(attributes) ⇒ Object

Builds the object from hash

Parameters:

  • Model attributes in the form of hash

Returns:

  • Returns the model itself



333
334
335
 
# File 'lib/intersight_client/models/hyperflex_local_credential_policy.rb', line 333

def self.build_from_hash(attributes)
  new.build_from_hash(attributes)
end

.openapi_all_of ⇒ Object

List of class defined in allOf (OpenAPI v3)



120
121
122
123
124
125
 
# File 'lib/intersight_client/models/hyperflex_local_credential_policy.rb', line 120

def self.openapi_all_of
  [
  :'HyperflexLocalCredentialPolicyAllOf',
  :'PolicyAbstractPolicy'
  ]
end

.openapi_discriminator_name ⇒ Object

discriminator’s property name in OpenAPI v3



128
129
130
 
# File 'lib/intersight_client/models/hyperflex_local_credential_policy.rb', line 128

def self.openapi_discriminator_name
  :'ClassId'
end

.openapi_nullable ⇒ Object

List of attributes with nullable: true



113
114
115
116
117
 
# File 'lib/intersight_client/models/hyperflex_local_credential_policy.rb', line 113

def self.openapi_nullable
  Set.new([
    :'cluster_profiles',
  ])
end

.openapi_types ⇒ Object

Attribute type mapping.



97
98
99
100
101
102
103
104
105
106
107
108
109
110
 
# File 'lib/intersight_client/models/hyperflex_local_credential_policy.rb', line 97

def self.openapi_types
  {
    :'class_id' => :'String',
    :'object_type' => :'String',
    :'factory_hypervisor_password' => :'Boolean',
    :'hxdp_root_pwd' => :'String',
    :'hypervisor_admin' => :'String',
    :'hypervisor_admin_pwd' => :'String',
    :'is_hxdp_root_pwd_set' => :'Boolean',
    :'is_hypervisor_admin_pwd_set' => :'Boolean',
    :'cluster_profiles' => :'Array<HyperflexClusterProfileRelationship>',
    :'organization' => :'OrganizationOrganizationRelationship'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • to be compared



303
304
305
306
307
308
309
310
311
312
313
314
315
316
 
# File 'lib/intersight_client/models/hyperflex_local_credential_policy.rb', line 303

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      class_id == o.class_id &&
      object_type == o.object_type &&
      factory_hypervisor_password == o.factory_hypervisor_password &&
      hxdp_root_pwd == o.hxdp_root_pwd &&
      hypervisor_admin == o.hypervisor_admin &&
      hypervisor_admin_pwd == o.hypervisor_admin_pwd &&
      is_hxdp_root_pwd_set == o.is_hxdp_root_pwd_set &&
      is_hypervisor_admin_pwd_set == o.is_hypervisor_admin_pwd_set &&
      cluster_profiles == o.cluster_profiles &&
      organization == o.organization && super(o)
end

#_deserialize(type, value) ⇒ Object

Deserializes the data based on type

Parameters:

  • type Data type

  • value Value to be deserialized

Returns:

  • Deserialized data



364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
 
# File 'lib/intersight_client/models/hyperflex_local_credential_policy.rb', line 364

def _deserialize(type, value)
  case type.to_sym
  when :Time
    Time.parse(value)
  when :Date
    Date.parse(value)
  when :String
    value.to_s
  when :Integer
    value.to_i
  when :Float
    value.to_f
  when :Boolean
    if value.to_s =~ /\A(true|t|yes|y|1)\z/i
      true
    else
      false
    end
  when :Object
    # generic object (usually a Hash), return directly
    value
  when /\AArray<(?<inner_type>.+)>\z/
    inner_type = Regexp.last_match[:inner_type]
    value.map { |v| _deserialize(inner_type, v) }
  when /\AHash<(?<k_type>.+?), (?<v_type>.+)>\z/
    k_type = Regexp.last_match[:k_type]
    v_type = Regexp.last_match[:v_type]
    {}.tap do |hash|
      value.each do |k, v|
        hash[_deserialize(k_type, k)] = _deserialize(v_type, v)
      end
    end
  else # model
    # models (e.g. Pet) or oneOf
    klass = IntersightClient.const_get(type)
    klass.respond_to?(:openapi_one_of) ? klass.build(value) : klass.build_from_hash(value)
  end
end

#_to_hash(value) ⇒ Hash

Outputs non-array value in the form of hash For object, use to_hash. Otherwise, just return the value

Parameters:

  • Any valid value

Returns:

  • Returns the value in the form of hash



435
436
437
438
439
440
441
442
443
444
445
446
447
 
# File 'lib/intersight_client/models/hyperflex_local_credential_policy.rb', line 435

def _to_hash(value)
  if value.is_a?(Array)
    value.compact.map { |v| _to_hash(v) }
  elsif value.is_a?(Hash)
    {}.tap do |hash|
      value.each { |k, v| hash[k] = _to_hash(v) }
    end
  elsif value.respond_to? :to_hash
    value.to_hash
  else
    value
  end
end

#build_from_hash(attributes) ⇒ Object

Builds the object from hash

Parameters:

  • Model attributes in the form of hash

Returns:

  • Returns the model itself



340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
 
# File 'lib/intersight_client/models/hyperflex_local_credential_policy.rb', line 340

def build_from_hash(attributes)
  return nil unless attributes.is_a?(Hash)
  super(attributes)
  HyperflexLocalCredentialPolicy.openapi_types.each_pair do |key, type|
    if attributes[HyperflexLocalCredentialPolicy.attribute_map[key]].nil? && HyperflexLocalCredentialPolicy.openapi_nullable.include?(key)
      self.send("#{key}=", nil)
    elsif type =~ /\AArray<(.*)>/i
      # check to ensure the input is an array given that the attribute
      # is documented as an array but the input is not
      if attributes[HyperflexLocalCredentialPolicy.attribute_map[key]].is_a?(Array)
        self.send("#{key}=", attributes[HyperflexLocalCredentialPolicy.attribute_map[key]].map { |v| _deserialize($1, v) })
      end
    elsif !attributes[HyperflexLocalCredentialPolicy.attribute_map[key]].nil?
      self.send("#{key}=", _deserialize(type, attributes[HyperflexLocalCredentialPolicy.attribute_map[key]]))
    end
  end

  self
end

#eql?(o) ⇒ Boolean

Parameters:

  • to be compared

Returns:

See Also:

  • `==` method


320
321
322
 
# File 'lib/intersight_client/models/hyperflex_local_credential_policy.rb', line 320

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • Hash code



326
327
328
 
# File 'lib/intersight_client/models/hyperflex_local_credential_policy.rb', line 326

def hash
  [class_id, object_type, factory_hypervisor_password, hxdp_root_pwd, hypervisor_admin, hypervisor_admin_pwd, is_hxdp_root_pwd_set, is_hypervisor_admin_pwd_set, cluster_profiles, organization].hash
end

#list_invalid_properties ⇒ Object

Show invalid properties with the reasons. Usually used together with valid?

Returns:

  • Array for valid properties with the reasons



205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
 
# File 'lib/intersight_client/models/hyperflex_local_credential_policy.rb', line 205

def list_invalid_properties
  invalid_properties = super
  if @class_id.nil?
    invalid_properties.push('invalid value for "class_id", class_id cannot be nil.')
  end

  if @object_type.nil?
    invalid_properties.push('invalid value for "object_type", object_type cannot be nil.')
  end

  pattern = Regexp.new(/^[a-zA-Z0-9!@#$%^&*_-]{10,}$/)
  if !@hxdp_root_pwd.nil? && @hxdp_root_pwd !~ pattern
    invalid_properties.push("invalid value for \"hxdp_root_pwd\", must conform to the pattern #{pattern}.")
  end

  pattern = Regexp.new(/^[a-zA-Z0-9]{1,}$/)
  if !@hypervisor_admin.nil? && @hypervisor_admin !~ pattern
    invalid_properties.push("invalid value for \"hypervisor_admin\", must conform to the pattern #{pattern}.")
  end

  pattern = Regexp.new(/^.{7,40}$/)
  if !@hypervisor_admin_pwd.nil? && @hypervisor_admin_pwd !~ pattern
    invalid_properties.push("invalid value for \"hypervisor_admin_pwd\", must conform to the pattern #{pattern}.")
  end

  invalid_properties
end

#to_body ⇒ Hash

to_body is an alias to to_hash (backward compatibility)

Returns:

  • Returns the object in the form of hash



411
412
413
 
# File 'lib/intersight_client/models/hyperflex_local_credential_policy.rb', line 411

def to_body
  to_hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • Returns the object in the form of hash



417
418
419
420
421
422
423
424
425
426
427
428
429
 
# File 'lib/intersight_client/models/hyperflex_local_credential_policy.rb', line 417

def to_hash
  hash = super
  HyperflexLocalCredentialPolicy.attribute_map.each_pair do |attr, param|
    value = self.send(attr)
    if value.nil?
      is_nullable = HyperflexLocalCredentialPolicy.openapi_nullable.include?(attr)
      next if !is_nullable || (is_nullable && !instance_variable_defined?(:"@#{attr}"))
    end

    hash[param] = _to_hash(value)
  end
  hash
end

#to_s ⇒ String

Returns the string representation of the object

Returns:

  • String presentation of the object



405
406
407
 
# File 'lib/intersight_client/models/hyperflex_local_credential_policy.rb', line 405

def to_s
  to_hash.to_s
end

#valid? ⇒ Boolean

Check to see if the all the properties in the model are valid

Returns:

  • true if the model is valid



235
236
237
238
239
240
241
242
243
244
245
246
 
# File 'lib/intersight_client/models/hyperflex_local_credential_policy.rb', line 235

def valid?
  return false if @class_id.nil?
  class_id_validator = EnumAttributeValidator.new('String', ["hyperflex.LocalCredentialPolicy"])
  return false unless class_id_validator.valid?(@class_id)
  return false if @object_type.nil?
  object_type_validator = EnumAttributeValidator.new('String', ["hyperflex.LocalCredentialPolicy"])
  return false unless object_type_validator.valid?(@object_type)
  return false if !@hxdp_root_pwd.nil? && @hxdp_root_pwd !~ Regexp.new(/^[a-zA-Z0-9!@#$%^&*_-]{10,}$/)
  return false if !@hypervisor_admin.nil? && @hypervisor_admin !~ Regexp.new(/^[a-zA-Z0-9]{1,}$/)
  return false if !@hypervisor_admin_pwd.nil? && @hypervisor_admin_pwd !~ Regexp.new(/^.{7,40}$/)
  true && super
end