Class: SDM::SSHPassword

Inherits:
Object
  • Object
show all
Defined in:
lib/models/porcelain.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(allow_deprecated_key_exchanges: nil, bind_interface: nil, egress_filter: nil, healthy: nil, hostname: nil, id: nil, lock_required: nil, name: nil, password: nil, port: nil, port_forwarding: nil, port_override: nil, proxy_cluster_id: nil, secret_store_id: nil, subdomain: nil, tags: nil, username: nil) ⇒ SSHPassword

Returns a new instance of SSHPassword.



16163
16164
16165
16166
16167
16168
16169
16170
16171
16172
16173
16174
16175
16176
16177
16178
16179
16180
16181
16182
16183
16184
16185
16186
16187
16188
16189
16190
16191
16192
16193
16194
16195
16196
16197
16198
16199
# File 'lib/models/porcelain.rb', line 16163

def initialize(
  allow_deprecated_key_exchanges: nil,
  bind_interface: nil,
  egress_filter: nil,
  healthy: nil,
  hostname: nil,
  id: nil,
  lock_required: nil,
  name: nil,
  password: nil,
  port: nil,
  port_forwarding: nil,
  port_override: nil,
  proxy_cluster_id: nil,
  secret_store_id: nil,
  subdomain: nil,
  tags: nil,
  username: nil
)
  @allow_deprecated_key_exchanges = allow_deprecated_key_exchanges == nil ? false : allow_deprecated_key_exchanges
  @bind_interface = bind_interface == nil ? "" : bind_interface
  @egress_filter = egress_filter == nil ? "" : egress_filter
  @healthy = healthy == nil ? false : healthy
  @hostname = hostname == nil ? "" : hostname
  @id = id == nil ? "" : id
  @lock_required = lock_required == nil ? false : lock_required
  @name = name == nil ? "" : name
  @password = password == nil ? "" : password
  @port = port == nil ? 0 : port
  @port_forwarding = port_forwarding == nil ? false : port_forwarding
  @port_override = port_override == nil ? 0 : port_override
  @proxy_cluster_id = proxy_cluster_id == nil ? "" : proxy_cluster_id
  @secret_store_id = secret_store_id == nil ? "" : secret_store_id
  @subdomain = subdomain == nil ? "" : subdomain
  @tags = tags == nil ? SDM::_porcelain_zero_value_tags() : tags
  @username = username == nil ? "" : username
end

Instance Attribute Details

#allow_deprecated_key_exchangesObject

Whether deprecated, insecure key exchanges are allowed for use to connect to the target ssh server.



16129
16130
16131
# File 'lib/models/porcelain.rb', line 16129

def allow_deprecated_key_exchanges
  @allow_deprecated_key_exchanges
end

#bind_interfaceObject

The bind interface is the IP address to which the port override of a resource is bound (for example, 127.0.0.1). It is automatically generated if not provided and may also be set to one of the ResourceIPAllocationMode constants to select between VNM, loopback, or default allocation.



16131
16132
16133
# File 'lib/models/porcelain.rb', line 16131

def bind_interface
  @bind_interface
end

#egress_filterObject

A filter applied to the routing logic to pin datasource to nodes.



16133
16134
16135
# File 'lib/models/porcelain.rb', line 16133

def egress_filter
  @egress_filter
end

#healthyObject

True if the datasource is reachable and the credentials are valid.



16135
16136
16137
# File 'lib/models/porcelain.rb', line 16135

def healthy
  @healthy
end

#hostnameObject

The host to dial to initiate a connection from the egress node to this resource.



16137
16138
16139
# File 'lib/models/porcelain.rb', line 16137

def hostname
  @hostname
end

#idObject

Unique identifier of the Resource.



16139
16140
16141
# File 'lib/models/porcelain.rb', line 16139

def id
  @id
end

#lock_requiredObject

When set, require a resource lock to access the resource to ensure it can only be used by one user at a time.



16141
16142
16143
# File 'lib/models/porcelain.rb', line 16141

def lock_required
  @lock_required
end

#nameObject

Unique human-readable name of the Resource.



16143
16144
16145
# File 'lib/models/porcelain.rb', line 16143

def name
  @name
end

#passwordObject

The password to authenticate with.



16145
16146
16147
# File 'lib/models/porcelain.rb', line 16145

def password
  @password
end

#portObject

The port to dial to initiate a connection from the egress node to this resource.



16147
16148
16149
# File 'lib/models/porcelain.rb', line 16147

def port
  @port
end

#port_forwardingObject

Whether port forwarding is allowed through this server.



16149
16150
16151
# File 'lib/models/porcelain.rb', line 16149

def port_forwarding
  @port_forwarding
end

#port_overrideObject

The local port used by clients to connect to this resource. It is automatically generated if not provided on create and may be re-generated on update by specifying a value of -1.



16151
16152
16153
# File 'lib/models/porcelain.rb', line 16151

def port_override
  @port_override
end

#proxy_cluster_idObject

ID of the proxy cluster for this resource, if any.



16153
16154
16155
# File 'lib/models/porcelain.rb', line 16153

def proxy_cluster_id
  @proxy_cluster_id
end

#secret_store_idObject

ID of the secret store containing credentials for this resource, if any.



16155
16156
16157
# File 'lib/models/porcelain.rb', line 16155

def secret_store_id
  @secret_store_id
end

#subdomainObject

DNS subdomain through which this resource may be accessed on clients. (e.g. "app-prod1" allows the resource to be accessed at "app-prod1.your-org-name.sdm-proxy-domain"). Only applicable to HTTP-based resources or resources using virtual networking mode.



16157
16158
16159
# File 'lib/models/porcelain.rb', line 16157

def subdomain
  @subdomain
end

#tagsObject

Tags is a map of key, value pairs.



16159
16160
16161
# File 'lib/models/porcelain.rb', line 16159

def tags
  @tags
end

#usernameObject

The username to authenticate with.



16161
16162
16163
# File 'lib/models/porcelain.rb', line 16161

def username
  @username
end

Instance Method Details

#to_json(options = {}) ⇒ Object



16201
16202
16203
16204
16205
16206
16207
# File 'lib/models/porcelain.rb', line 16201

def to_json(options = {})
  hash = {}
  self.instance_variables.each do |var|
    hash[var.id2name.delete_prefix("@")] = self.instance_variable_get var
  end
  hash.to_json
end