Class: SDM::SSH

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, key_type: nil, name: nil, port: nil, port_forwarding: nil, port_override: nil, proxy_cluster_id: nil, public_key: nil, secret_store_id: nil, subdomain: nil, tags: nil, username: nil) ⇒ SSH

Returns a new instance of SSH.


11258
11259
11260
11261
11262
11263
11264
11265
11266
11267
11268
11269
11270
11271
11272
11273
11274
11275
11276
11277
11278
11279
11280
11281
11282
11283
11284
11285
11286
11287
11288
11289
11290
11291
11292
11293
11294
# File 'lib/models/porcelain.rb', line 11258

def initialize(
  allow_deprecated_key_exchanges: nil,
  bind_interface: nil,
  egress_filter: nil,
  healthy: nil,
  hostname: nil,
  id: nil,
  key_type: nil,
  name: nil,
  port: nil,
  port_forwarding: nil,
  port_override: nil,
  proxy_cluster_id: nil,
  public_key: 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
  @key_type = key_type == nil ? "" : key_type
  @name = name == nil ? "" : name
  @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
  @public_key = public_key == nil ? "" : public_key
  @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.


11224
11225
11226
# File 'lib/models/porcelain.rb', line 11224

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.


11226
11227
11228
# File 'lib/models/porcelain.rb', line 11226

def bind_interface
  @bind_interface
end

#egress_filterObject

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


11228
11229
11230
# File 'lib/models/porcelain.rb', line 11228

def egress_filter
  @egress_filter
end

#healthyObject

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


11230
11231
11232
# File 'lib/models/porcelain.rb', line 11230

def healthy
  @healthy
end

#hostnameObject

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


11232
11233
11234
# File 'lib/models/porcelain.rb', line 11232

def hostname
  @hostname
end

#idObject

Unique identifier of the Resource.


11234
11235
11236
# File 'lib/models/porcelain.rb', line 11234

def id
  @id
end

#key_typeObject

The key type to use e.g. rsa-2048 or ed25519


11236
11237
11238
# File 'lib/models/porcelain.rb', line 11236

def key_type
  @key_type
end

#nameObject

Unique human-readable name of the Resource.


11238
11239
11240
# File 'lib/models/porcelain.rb', line 11238

def name
  @name
end

#portObject

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


11240
11241
11242
# File 'lib/models/porcelain.rb', line 11240

def port
  @port
end

#port_forwardingObject

Whether port forwarding is allowed through this server.


11242
11243
11244
# File 'lib/models/porcelain.rb', line 11242

def port_forwarding
  @port_forwarding
end

#port_overrideObject

The local port used by clients to connect to this resource.


11244
11245
11246
# File 'lib/models/porcelain.rb', line 11244

def port_override
  @port_override
end

#proxy_cluster_idObject

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


11246
11247
11248
# File 'lib/models/porcelain.rb', line 11246

def proxy_cluster_id
  @proxy_cluster_id
end

#public_keyObject

The public key to append to a server's authorized keys. This will be generated after resource creation.


11248
11249
11250
# File 'lib/models/porcelain.rb', line 11248

def public_key
  @public_key
end

#secret_store_idObject

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


11250
11251
11252
# File 'lib/models/porcelain.rb', line 11250

def secret_store_id
  @secret_store_id
end

#subdomainObject

Subdomain is the local DNS address. (e.g. app-prod1 turns into app-prod1.your-org-name.sdm.network)


11252
11253
11254
# File 'lib/models/porcelain.rb', line 11252

def subdomain
  @subdomain
end

#tagsObject

Tags is a map of key, value pairs.


11254
11255
11256
# File 'lib/models/porcelain.rb', line 11254

def tags
  @tags
end

#usernameObject

The username to authenticate with.


11256
11257
11258
# File 'lib/models/porcelain.rb', line 11256

def username
  @username
end

Instance Method Details

#to_json(options = {}) ⇒ Object


11296
11297
11298
11299
11300
11301
11302
# File 'lib/models/porcelain.rb', line 11296

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