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, lock_required: 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.



15387
15388
15389
15390
15391
15392
15393
15394
15395
15396
15397
15398
15399
15400
15401
15402
15403
15404
15405
15406
15407
15408
15409
15410
15411
15412
15413
15414
15415
15416
15417
15418
15419
15420
15421
15422
15423
15424
15425
 
# File 'lib/models/porcelain.rb', line 15387

def initialize(
  allow_deprecated_key_exchanges: nil,
  bind_interface: nil,
  egress_filter: nil,
  healthy: nil,
  hostname: nil,
  id: nil,
  key_type: nil,
  lock_required: 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
  @lock_required = lock_required == nil ? false : lock_required
  @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_exchanges ⇒ Object

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



15351
15352
15353
 
# File 'lib/models/porcelain.rb', line 15351

def allow_deprecated_key_exchanges
  @allow_deprecated_key_exchanges
end

#bind_interface ⇒ Object

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.



15353
15354
15355
 
# File 'lib/models/porcelain.rb', line 15353

def bind_interface
  @bind_interface
end

#egress_filter ⇒ Object

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



15355
15356
15357
 
# File 'lib/models/porcelain.rb', line 15355

def egress_filter
  @egress_filter
end

#healthy ⇒ Object

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



15357
15358
15359
 
# File 'lib/models/porcelain.rb', line 15357

def healthy
  @healthy
end

#hostname ⇒ Object

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



15359
15360
15361
 
# File 'lib/models/porcelain.rb', line 15359

def hostname
  @hostname
end

#id ⇒ Object

Unique identifier of the Resource.



15361
15362
15363
 
# File 'lib/models/porcelain.rb', line 15361

def id
  @id
end

#key_type ⇒ Object

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



15363
15364
15365
 
# File 'lib/models/porcelain.rb', line 15363

def key_type
  @key_type
end

#lock_required ⇒ Object

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



15365
15366
15367
 
# File 'lib/models/porcelain.rb', line 15365

def lock_required
  @lock_required
end

#name ⇒ Object

Unique human-readable name of the Resource.



15367
15368
15369
 
# File 'lib/models/porcelain.rb', line 15367

def name
  @name
end

#port ⇒ Object

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



15369
15370
15371
 
# File 'lib/models/porcelain.rb', line 15369

def port
  @port
end

#port_forwarding ⇒ Object

Whether port forwarding is allowed through this server.



15371
15372
15373
 
# File 'lib/models/porcelain.rb', line 15371

def port_forwarding
  @port_forwarding
end

#port_override ⇒ Object

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.



15373
15374
15375
 
# File 'lib/models/porcelain.rb', line 15373

def port_override
  @port_override
end

#proxy_cluster_id ⇒ Object

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



15375
15376
15377
 
# File 'lib/models/porcelain.rb', line 15375

def proxy_cluster_id
  @proxy_cluster_id
end

#public_key ⇒ Object

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



15377
15378
15379
 
# File 'lib/models/porcelain.rb', line 15377

def public_key
  @public_key
end

#secret_store_id ⇒ Object

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



15379
15380
15381
 
# File 'lib/models/porcelain.rb', line 15379

def secret_store_id
  @secret_store_id
end

#subdomain ⇒ Object

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.



15381
15382
15383
 
# File 'lib/models/porcelain.rb', line 15381

def subdomain
  @subdomain
end

#tags ⇒ Object

Tags is a map of key, value pairs.



15383
15384
15385
 
# File 'lib/models/porcelain.rb', line 15383

def tags
  @tags
end

#username ⇒ Object

The username to authenticate with.



15385
15386
15387
 
# File 'lib/models/porcelain.rb', line 15385

def username
  @username
end

Instance Method Details

#to_json(options = {}) ⇒ Object 



15427
15428
15429
15430
15431
15432
15433
 
# File 'lib/models/porcelain.rb', line 15427

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