Class List Method List File List

# Class: Com::Vmware::Appliance::Techpreview::Localaccounts::User::NewUserConfig

Inherits:
  VAPI::Bindings::VapiStruct
  - Object
  - VAPI::Bindings::VapiStruct
  - Com::Vmware::Appliance::Techpreview::Localaccounts::User::NewUserConfig
  show all
Defined in:
  /build/mts/release/bora-4571906/build/sdk/aggregated-bindings/ruby/com/vmware/appliance/techpreview/localaccounts.rb

## Overview

``Com::Vmware::Appliance::Techpreview::Localaccounts::User::NewUserConfig`` class Structure that defines a new user configuration.

## Instance Attribute Summary (collapse)

- - (String?) email

  Email address of the local account.

- - (String?) fullname

  User full name fullname Optional full name for a person.

- - (String) password

  User login password In Interactive mode, provide --password as part of the command, and enter the value on the prompt.

- - (Com::Vmware::Appliance::Techpreview::Localaccounts::User::UserRole?) role

  User roles.

- - (String) username

  User login name.

## Class Method Summary (collapse)

- + (VAPI::Bindings::StructType) binding_type

  Holds (gets or creates) the binding type metadata for this structure type.

## Instance Method Summary (collapse)

- - (NewUserConfig) initialize(ruby_values = nil, struct_value = nil) constructor

  Constructs a new instance.

## Constructor Details

### - (`NewUserConfig`) initialize(ruby_values = nil, struct_value = nil)

Constructs a new instance.

Parameters:

- ruby_values (`Hash`) (defaults to: `nil`) —

  a map of initial property values (optional)

- struct_value (`VAPI::Data::StructValue`) (defaults to: `nil`) —

  a raw StructValue from the wire (optional)

    338
    339
    340
    # File '/build/mts/release/bora-4571906/build/sdk/aggregated-bindings/ruby/com/vmware/appliance/techpreview/localaccounts.rb', line 338

    def initialize(ruby_values=nil, struct_value=nil)
        super(self.class.binding_type, ruby_values, struct_value)
    end

## Instance Attribute Details

### - (`String`?) email

Email address of the local account. email Optional email

Returns:

- (`String`, `nil`)

    307
    308
    309
    310
    311
    312
    313
    314
    315
    316
    317
    318
    319
    320
    321
    322
    323
    324
    325
    326
    327
    328
    329
    330
    331
    332
    333
    334
    335
    336
    337
    338
    339
    340
    341
    # File '/build/mts/release/bora-4571906/build/sdk/aggregated-bindings/ruby/com/vmware/appliance/techpreview/localaccounts.rb', line 307

    class NewUserConfig < VAPI::Bindings::VapiStruct

        class << self
            # Holds (gets or creates) the binding type metadata for this structure type.
            # @scope class
            # @return [VAPI::Bindings::StructType] the binding type
            def binding_type
                @binding_type ||= VAPI::Bindings::StructType.new(
                    'com.vmware.appliance.techpreview.localaccounts.user.new_user_config',
                    {
                        'username' => VAPI::Bindings::StringType.instance,
                        'role' => VAPI::Bindings::OptionalType.new(VAPI::Bindings::ReferenceType.new('Com::Vmware::Appliance::Techpreview::Localaccounts::User::UserRole')),
                        'password' => VAPI::Bindings::SecretType.instance,
                        'fullname' => VAPI::Bindings::OptionalType.new(VAPI::Bindings::StringType.instance),
                        'email' => VAPI::Bindings::OptionalType.new(VAPI::Bindings::StringType.instance),
                    },
                    NewUserConfig,
                    false,
                    nil)
            end
        end

        attr_accessor :username,
                      :role,
                      :password,
                      :fullname,
                      :email

        # Constructs a new instance.
        # @param ruby_values [Hash] a map of initial property values (optional)
        # @param struct_value [VAPI::Data::StructValue] a raw StructValue from the wire (optional)
        def initialize(ruby_values=nil, struct_value=nil)
            super(self.class.binding_type, ruby_values, struct_value)
        end
    end

### - (`String`?) fullname

User full name fullname Optional full name for a person

Returns:

- (`String`, `nil`)

    307
    308
    309
    310
    311
    312
    313
    314
    315
    316
    317
    318
    319
    320
    321
    322
    323
    324
    325
    326
    327
    328
    329
    330
    331
    332
    333
    334
    335
    336
    337
    338
    339
    340
    341
    # File '/build/mts/release/bora-4571906/build/sdk/aggregated-bindings/ruby/com/vmware/appliance/techpreview/localaccounts.rb', line 307

    class NewUserConfig < VAPI::Bindings::VapiStruct

        class << self
            # Holds (gets or creates) the binding type metadata for this structure type.
            # @scope class
            # @return [VAPI::Bindings::StructType] the binding type
            def binding_type
                @binding_type ||= VAPI::Bindings::StructType.new(
                    'com.vmware.appliance.techpreview.localaccounts.user.new_user_config',
                    {
                        'username' => VAPI::Bindings::StringType.instance,
                        'role' => VAPI::Bindings::OptionalType.new(VAPI::Bindings::ReferenceType.new('Com::Vmware::Appliance::Techpreview::Localaccounts::User::UserRole')),
                        'password' => VAPI::Bindings::SecretType.instance,
                        'fullname' => VAPI::Bindings::OptionalType.new(VAPI::Bindings::StringType.instance),
                        'email' => VAPI::Bindings::OptionalType.new(VAPI::Bindings::StringType.instance),
                    },
                    NewUserConfig,
                    false,
                    nil)
            end
        end

        attr_accessor :username,
                      :role,
                      :password,
                      :fullname,
                      :email

        # Constructs a new instance.
        # @param ruby_values [Hash] a map of initial property values (optional)
        # @param struct_value [VAPI::Data::StructValue] a raw StructValue from the wire (optional)
        def initialize(ruby_values=nil, struct_value=nil)
            super(self.class.binding_type, ruby_values, struct_value)
        end
    end

### - (`String`) password

User login password In Interactive mode, provide --password as part of the command, and enter the value on the prompt. When accessed remotely, provide --password value as part the command.

Returns:

- (`String`)

    307
    308
    309
    310
    311
    312
    313
    314
    315
    316
    317
    318
    319
    320
    321
    322
    323
    324
    325
    326
    327
    328
    329
    330
    331
    332
    333
    334
    335
    336
    337
    338
    339
    340
    341
    # File '/build/mts/release/bora-4571906/build/sdk/aggregated-bindings/ruby/com/vmware/appliance/techpreview/localaccounts.rb', line 307

    class NewUserConfig < VAPI::Bindings::VapiStruct

        class << self
            # Holds (gets or creates) the binding type metadata for this structure type.
            # @scope class
            # @return [VAPI::Bindings::StructType] the binding type
            def binding_type
                @binding_type ||= VAPI::Bindings::StructType.new(
                    'com.vmware.appliance.techpreview.localaccounts.user.new_user_config',
                    {
                        'username' => VAPI::Bindings::StringType.instance,
                        'role' => VAPI::Bindings::OptionalType.new(VAPI::Bindings::ReferenceType.new('Com::Vmware::Appliance::Techpreview::Localaccounts::User::UserRole')),
                        'password' => VAPI::Bindings::SecretType.instance,
                        'fullname' => VAPI::Bindings::OptionalType.new(VAPI::Bindings::StringType.instance),
                        'email' => VAPI::Bindings::OptionalType.new(VAPI::Bindings::StringType.instance),
                    },
                    NewUserConfig,
                    false,
                    nil)
            end
        end

        attr_accessor :username,
                      :role,
                      :password,
                      :fullname,
                      :email

        # Constructs a new instance.
        # @param ruby_values [Hash] a map of initial property values (optional)
        # @param struct_value [VAPI::Data::StructValue] a raw StructValue from the wire (optional)
        def initialize(ruby_values=nil, struct_value=nil)
            super(self.class.binding_type, ruby_values, struct_value)
        end
    end

### - (`Com::Vmware::Appliance::Techpreview::Localaccounts::User::UserRole`?) role

User roles. The default role is operator. role Default role is operator

Returns:

- (`Com::Vmware::Appliance::Techpreview::Localaccounts::User::UserRole`, `nil`)

    307
    308
    309
    310
    311
    312
    313
    314
    315
    316
    317
    318
    319
    320
    321
    322
    323
    324
    325
    326
    327
    328
    329
    330
    331
    332
    333
    334
    335
    336
    337
    338
    339
    340
    341
    # File '/build/mts/release/bora-4571906/build/sdk/aggregated-bindings/ruby/com/vmware/appliance/techpreview/localaccounts.rb', line 307

    class NewUserConfig < VAPI::Bindings::VapiStruct

        class << self
            # Holds (gets or creates) the binding type metadata for this structure type.
            # @scope class
            # @return [VAPI::Bindings::StructType] the binding type
            def binding_type
                @binding_type ||= VAPI::Bindings::StructType.new(
                    'com.vmware.appliance.techpreview.localaccounts.user.new_user_config',
                    {
                        'username' => VAPI::Bindings::StringType.instance,
                        'role' => VAPI::Bindings::OptionalType.new(VAPI::Bindings::ReferenceType.new('Com::Vmware::Appliance::Techpreview::Localaccounts::User::UserRole')),
                        'password' => VAPI::Bindings::SecretType.instance,
                        'fullname' => VAPI::Bindings::OptionalType.new(VAPI::Bindings::StringType.instance),
                        'email' => VAPI::Bindings::OptionalType.new(VAPI::Bindings::StringType.instance),
                    },
                    NewUserConfig,
                    false,
                    nil)
            end
        end

        attr_accessor :username,
                      :role,
                      :password,
                      :fullname,
                      :email

        # Constructs a new instance.
        # @param ruby_values [Hash] a map of initial property values (optional)
        # @param struct_value [VAPI::Data::StructValue] a raw StructValue from the wire (optional)
        def initialize(ruby_values=nil, struct_value=nil)
            super(self.class.binding_type, ruby_values, struct_value)
        end
    end

### - (`String`) username

User login name

Returns:

- (`String`)

    307
    308
    309
    310
    311
    312
    313
    314
    315
    316
    317
    318
    319
    320
    321
    322
    323
    324
    325
    326
    327
    328
    329
    330
    331
    332
    333
    334
    335
    336
    337
    338
    339
    340
    341
    # File '/build/mts/release/bora-4571906/build/sdk/aggregated-bindings/ruby/com/vmware/appliance/techpreview/localaccounts.rb', line 307

    class NewUserConfig < VAPI::Bindings::VapiStruct

        class << self
            # Holds (gets or creates) the binding type metadata for this structure type.
            # @scope class
            # @return [VAPI::Bindings::StructType] the binding type
            def binding_type
                @binding_type ||= VAPI::Bindings::StructType.new(
                    'com.vmware.appliance.techpreview.localaccounts.user.new_user_config',
                    {
                        'username' => VAPI::Bindings::StringType.instance,
                        'role' => VAPI::Bindings::OptionalType.new(VAPI::Bindings::ReferenceType.new('Com::Vmware::Appliance::Techpreview::Localaccounts::User::UserRole')),
                        'password' => VAPI::Bindings::SecretType.instance,
                        'fullname' => VAPI::Bindings::OptionalType.new(VAPI::Bindings::StringType.instance),
                        'email' => VAPI::Bindings::OptionalType.new(VAPI::Bindings::StringType.instance),
                    },
                    NewUserConfig,
                    false,
                    nil)
            end
        end

        attr_accessor :username,
                      :role,
                      :password,
                      :fullname,
                      :email

        # Constructs a new instance.
        # @param ruby_values [Hash] a map of initial property values (optional)
        # @param struct_value [VAPI::Data::StructValue] a raw StructValue from the wire (optional)
        def initialize(ruby_values=nil, struct_value=nil)
            super(self.class.binding_type, ruby_values, struct_value)
        end
    end

## Class Method Details

### + (`VAPI::Bindings::StructType`) binding_type

Holds (gets or creates) the binding type metadata for this structure type.

Returns:

- (`VAPI::Bindings::StructType`) —

  the binding type

    313
    314
    315
    316
    317
    318
    319
    320
    321
    322
    323
    324
    325
    326
    # File '/build/mts/release/bora-4571906/build/sdk/aggregated-bindings/ruby/com/vmware/appliance/techpreview/localaccounts.rb', line 313

    def binding_type
        @binding_type ||= VAPI::Bindings::StructType.new(
            'com.vmware.appliance.techpreview.localaccounts.user.new_user_config',
            {
                'username' => VAPI::Bindings::StringType.instance,
                'role' => VAPI::Bindings::OptionalType.new(VAPI::Bindings::ReferenceType.new('Com::Vmware::Appliance::Techpreview::Localaccounts::User::UserRole')),
                'password' => VAPI::Bindings::SecretType.instance,
                'fullname' => VAPI::Bindings::OptionalType.new(VAPI::Bindings::StringType.instance),
                'email' => VAPI::Bindings::OptionalType.new(VAPI::Bindings::StringType.instance),
            },
            NewUserConfig,
            false,
            nil)
    end