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.



14625
14626
14627
14628
14629
14630
14631
14632
14633
14634
14635
14636
14637
14638
14639
14640
14641
14642
14643
14644
14645
14646
14647
14648
14649
14650
14651
14652
14653
14654
14655
14656
14657
14658
14659
14660
14661
 
# File 'lib/models/porcelain.rb', line 14625

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_exchanges ⇒ Object

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



14591
14592
14593
 
# File 'lib/models/porcelain.rb', line 14591

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.



14593
14594
14595
 
# File 'lib/models/porcelain.rb', line 14593

def bind_interface
  @bind_interface
end

#egress_filter ⇒ Object

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



14595
14596
14597
 
# File 'lib/models/porcelain.rb', line 14595

def egress_filter
  @egress_filter
end

#healthy ⇒ Object

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



14597
14598
14599
 
# File 'lib/models/porcelain.rb', line 14597

def healthy
  @healthy
end

#hostname ⇒ Object

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



14599
14600
14601
 
# File 'lib/models/porcelain.rb', line 14599

def hostname
  @hostname
end

#id ⇒ Object

Unique identifier of the Resource.



14601
14602
14603
 
# File 'lib/models/porcelain.rb', line 14601

def id
  @id
end

#key_type ⇒ Object

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



14603
14604
14605
 
# File 'lib/models/porcelain.rb', line 14603

def key_type
  @key_type
end

#name ⇒ Object

Unique human-readable name of the Resource.



14605
14606
14607
 
# File 'lib/models/porcelain.rb', line 14605

def name
  @name
end

#port ⇒ Object

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



14607
14608
14609
 
# File 'lib/models/porcelain.rb', line 14607

def port
  @port
end

#port_forwarding ⇒ Object

Whether port forwarding is allowed through this server.



14609
14610
14611
 
# File 'lib/models/porcelain.rb', line 14609

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.



14611
14612
14613
 
# File 'lib/models/porcelain.rb', line 14611

def port_override
  @port_override
end

#proxy_cluster_id ⇒ Object

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



14613
14614
14615
 
# File 'lib/models/porcelain.rb', line 14613

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.



14615
14616
14617
 
# File 'lib/models/porcelain.rb', line 14615

def public_key
  @public_key
end

#secret_store_id ⇒ Object

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



14617
14618
14619
 
# File 'lib/models/porcelain.rb', line 14617

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.



14619
14620
14621
 
# File 'lib/models/porcelain.rb', line 14619

def subdomain
  @subdomain
end

#tags ⇒ Object

Tags is a map of key, value pairs.



14621
14622
14623
 
# File 'lib/models/porcelain.rb', line 14621

def tags
  @tags
end

#username ⇒ Object

The username to authenticate with.



14623
14624
14625
 
# File 'lib/models/porcelain.rb', line 14623

def username
  @username
end

Instance Method Details

#to_json(options = {}) ⇒ Object 



14663
14664
14665
14666
14667
14668
14669
 
# File 'lib/models/porcelain.rb', line 14663

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