Skip to content

HostAccountProps

Properties for defining a HostAccount.

See https://www.alibabacloud.com/help/ros/developer-reference/aliyun-bastionhost-hostaccount

Initializer

using AlibabaCloud.SDK.ROS.CDK.Bastionhost;
new HostAccountProps {
    object HostAccountName,
    object HostId,
    object InstanceId,
    object ProtocolName,
    object HostShareKeyId = null,
    object PassPhrase = null,
    object Password = null,
    object PrivateKey = null,
    object PrivilegeType = null,
    object RotationMode = null
};

Properties

Name Type Description
HostAccountName object Property hostAccountName: The name of the new host account.
HostId object Property hostId: The ID of the host.
InstanceId object Property instanceId: The ID of the bastion host instance.
ProtocolName object Property protocolName: The protocol name of the host account.
HostShareKeyId object Property hostShareKeyId: The ID of the host share key.
PassPhrase object Property passPhrase: The passphrase of the host account.
Password object Property password: The password of the host account.
PrivateKey object Property privateKey: The private key of the new host account.
PrivilegeType object Property privilegeType: The permission type of the account.
RotationMode object Property rotationMode: The password change mode for the account.

HostAccountNameRequired

public object HostAccountName { get; set; }
  • Type: object

Property hostAccountName: The name of the new host account.

The name can be up to 128 characters long.


HostIdRequired

public object HostId { get; set; }
  • Type: object

Property hostId: The ID of the host.


InstanceIdRequired

public object InstanceId { get; set; }
  • Type: object

Property instanceId: The ID of the bastion host instance.


ProtocolNameRequired

public object ProtocolName { get; set; }
  • Type: object

Property protocolName: The protocol name of the host account.

Valid values: SSH, RDP.


HostShareKeyIdOptional

public object HostShareKeyId { get; set; }
  • Type: object

Property hostShareKeyId: The ID of the host share key.

This parameter is required when the protocol is SSH.


PassPhraseOptional

public object PassPhrase { get; set; }
  • Type: object

Property passPhrase: The passphrase of the host account.

This parameter is required when the protocol is SSH and the private key is encrypted.


PasswordOptional

public object Password { get; set; }
  • Type: object

Property password: The password of the host account.

This parameter is required when the protocol is SSH or RDP.


PrivateKeyOptional

public object PrivateKey { get; set; }
  • Type: object

Property privateKey: The private key of the new host account.

The value is a Base64-encoded string.

This parameter is used only when ProtocolName is set to SSH. You do not need to set this parameter if ProtocolName is set to RDP. You can set both a password and a private key for the host account. When connecting to the asset, Bastionhost prioritizes the private key for the connection.


PrivilegeTypeOptional

public object PrivilegeType { get; set; }
  • Type: object

Property privilegeType: The permission type of the account.

If you do not set this parameter, the default value is Normal.

  • Privileged: privileged account
  • Normal: normal account

This parameter is supported only in Bastionhost V3.2.47 and later.


RotationModeOptional

public object RotationMode { get; set; }
  • Type: object

Property rotationMode: The password change mode for the account.

If you do not set this parameter, the default value is Self.

  • Privileged: Use a privileged account to change the password.
  • Self: Do not use a privileged account to change the password.

This parameter is supported only in Bastionhost V3.2.47 and later.