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, public_key: nil, secret_store_id: nil, subdomain: nil, tags: nil, username: nil) ⇒ SSH

Returns a new instance of SSH.



9657
9658
9659
9660
9661
9662
9663
9664
9665
9666
9667
9668
9669
9670
9671
9672
9673
9674
9675
9676
9677
9678
9679
9680
9681
9682
9683
9684
9685
9686
9687
9688
9689
9690
9691
 
# File 'lib/models/porcelain.rb', line 9657

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,
  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
  @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.



9625
9626
9627
 
# File 'lib/models/porcelain.rb', line 9625

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.



9627
9628
9629
 
# File 'lib/models/porcelain.rb', line 9627

def bind_interface
  @bind_interface
end

#egress_filter ⇒ Object

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



9629
9630
9631
 
# File 'lib/models/porcelain.rb', line 9629

def egress_filter
  @egress_filter
end

#healthy ⇒ Object

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



9631
9632
9633
 
# File 'lib/models/porcelain.rb', line 9631

def healthy
  @healthy
end

#hostname ⇒ Object

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



9633
9634
9635
 
# File 'lib/models/porcelain.rb', line 9633

def hostname
  @hostname
end

#id ⇒ Object

Unique identifier of the Resource.



9635
9636
9637
 
# File 'lib/models/porcelain.rb', line 9635

def id
  @id
end

#key_type ⇒ Object

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



9637
9638
9639
 
# File 'lib/models/porcelain.rb', line 9637

def key_type
  @key_type
end

#name ⇒ Object

Unique human-readable name of the Resource.



9639
9640
9641
 
# File 'lib/models/porcelain.rb', line 9639

def name
  @name
end

#port ⇒ Object

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



9641
9642
9643
 
# File 'lib/models/porcelain.rb', line 9641

def port
  @port
end

#port_forwarding ⇒ Object

Whether port forwarding is allowed through this server.



9643
9644
9645
 
# File 'lib/models/porcelain.rb', line 9643

def port_forwarding
  @port_forwarding
end

#port_override ⇒ Object

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



9645
9646
9647
 
# File 'lib/models/porcelain.rb', line 9645

def port_override
  @port_override
end

#public_key ⇒ Object

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



9647
9648
9649
 
# File 'lib/models/porcelain.rb', line 9647

def public_key
  @public_key
end

#secret_store_id ⇒ Object

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



9649
9650
9651
 
# File 'lib/models/porcelain.rb', line 9649

def secret_store_id
  @secret_store_id
end

#subdomain ⇒ Object

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



9651
9652
9653
 
# File 'lib/models/porcelain.rb', line 9651

def subdomain
  @subdomain
end

#tags ⇒ Object

Tags is a map of key, value pairs.



9653
9654
9655
 
# File 'lib/models/porcelain.rb', line 9653

def tags
  @tags
end

#username ⇒ Object

The username to authenticate with.



9655
9656
9657
 
# File 'lib/models/porcelain.rb', line 9655

def username
  @username
end

Instance Method Details

#to_json(options = {}) ⇒ Object 



9693
9694
9695
9696
9697
9698
9699
 
# File 'lib/models/porcelain.rb', line 9693

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