Class: SDM::SQLServerKerberosAD

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

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(allow_deprecated_encryption: nil, bind_interface: nil, database: nil, egress_filter: nil, healthy: nil, hostname: nil, id: nil, keytab: nil, krb_config: nil, name: nil, override_database: nil, port: nil, port_override: nil, realm: nil, schema: nil, secret_store_id: nil, server_spn: nil, subdomain: nil, tags: nil, username: nil) ⇒ SQLServerKerberosAD

Returns a new instance of SQLServerKerberosAD.



9826
9827
9828
9829
9830
9831
9832
9833
9834
9835
9836
9837
9838
9839
9840
9841
9842
9843
9844
9845
9846
9847
9848
9849
9850
9851
9852
9853
9854
9855
9856
9857
9858
9859
9860
9861
9862
9863
9864
9865
9866
9867
9868
# File 'lib/models/porcelain.rb', line 9826

def initialize(
  allow_deprecated_encryption: nil,
  bind_interface: nil,
  database: nil,
  egress_filter: nil,
  healthy: nil,
  hostname: nil,
  id: nil,
  keytab: nil,
  krb_config: nil,
  name: nil,
  override_database: nil,
  port: nil,
  port_override: nil,
  realm: nil,
  schema: nil,
  secret_store_id: nil,
  server_spn: nil,
  subdomain: nil,
  tags: nil,
  username: nil
)
  @allow_deprecated_encryption = allow_deprecated_encryption == nil ? false : allow_deprecated_encryption
  @bind_interface = bind_interface == nil ? "" : bind_interface
  @database = database == nil ? "" : database
  @egress_filter = egress_filter == nil ? "" : egress_filter
  @healthy = healthy == nil ? false : healthy
  @hostname = hostname == nil ? "" : hostname
  @id = id == nil ? "" : id
  @keytab = keytab == nil ? "" : keytab
  @krb_config = krb_config == nil ? "" : krb_config
  @name = name == nil ? "" : name
  @override_database = override_database == nil ? false : override_database
  @port = port == nil ? 0 : port
  @port_override = port_override == nil ? 0 : port_override
  @realm = realm == nil ? "" : realm
  @schema = schema == nil ? "" : schema
  @secret_store_id = secret_store_id == nil ? "" : secret_store_id
  @server_spn = server_spn == nil ? "" : server_spn
  @subdomain = subdomain == nil ? "" : subdomain
  @tags = tags == nil ? SDM::_porcelain_zero_value_tags() : tags
  @username = username == nil ? "" : username
end

Instance Attribute Details

#allow_deprecated_encryptionObject

Whether to allow deprecated encryption protocols to be used for this resource. For example, TLS 1.0.



9786
9787
9788
# File 'lib/models/porcelain.rb', line 9786

def allow_deprecated_encryption
  @allow_deprecated_encryption
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.



9788
9789
9790
# File 'lib/models/porcelain.rb', line 9788

def bind_interface
  @bind_interface
end

#databaseObject

The database for healthchecks, and used for clients if Override Default Database is true.



9790
9791
9792
# File 'lib/models/porcelain.rb', line 9790

def database
  @database
end

#egress_filterObject

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



9792
9793
9794
# File 'lib/models/porcelain.rb', line 9792

def egress_filter
  @egress_filter
end

#healthyObject

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



9794
9795
9796
# File 'lib/models/porcelain.rb', line 9794

def healthy
  @healthy
end

#hostnameObject

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



9796
9797
9798
# File 'lib/models/porcelain.rb', line 9796

def hostname
  @hostname
end

#idObject

Unique identifier of the Resource.



9798
9799
9800
# File 'lib/models/porcelain.rb', line 9798

def id
  @id
end

#keytabObject

The keytab file in base64 format containing an entry with the principal name (username@realm) and key version number with which to authenticate.



9800
9801
9802
# File 'lib/models/porcelain.rb', line 9800

def keytab
  @keytab
end

#krb_configObject

The Kerberos 5 configuration file (krb5.conf) specifying the Active Directory server (KDC) for the configured realm.



9802
9803
9804
# File 'lib/models/porcelain.rb', line 9802

def krb_config
  @krb_config
end

#nameObject

Unique human-readable name of the Resource.



9804
9805
9806
# File 'lib/models/porcelain.rb', line 9804

def name
  @name
end

#override_databaseObject

If set, the database configured cannot be changed by users. This setting is not recommended for most use cases, as some clients will insist their database has changed when it has not, leading to user confusion.



9806
9807
9808
# File 'lib/models/porcelain.rb', line 9806

def override_database
  @override_database
end

#portObject

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



9808
9809
9810
# File 'lib/models/porcelain.rb', line 9808

def port
  @port
end

#port_overrideObject

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



9810
9811
9812
# File 'lib/models/porcelain.rb', line 9810

def port_override
  @port_override
end

#realmObject

The Active Directory domain (realm) to which the configured username belongs.



9812
9813
9814
# File 'lib/models/porcelain.rb', line 9812

def realm
  @realm
end

#schemaObject

The Schema to use to direct initial requests.



9814
9815
9816
# File 'lib/models/porcelain.rb', line 9814

def schema
  @schema
end

#secret_store_idObject

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



9816
9817
9818
# File 'lib/models/porcelain.rb', line 9816

def secret_store_id
  @secret_store_id
end

#server_spnObject

The Service Principal Name of the Microsoft SQL Server instance in Active Directory.



9818
9819
9820
# File 'lib/models/porcelain.rb', line 9818

def server_spn
  @server_spn
end

#subdomainObject

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



9820
9821
9822
# File 'lib/models/porcelain.rb', line 9820

def subdomain
  @subdomain
end

#tagsObject

Tags is a map of key, value pairs.



9822
9823
9824
# File 'lib/models/porcelain.rb', line 9822

def tags
  @tags
end

#usernameObject

The username to authenticate with.



9824
9825
9826
# File 'lib/models/porcelain.rb', line 9824

def username
  @username
end

Instance Method Details

#to_json(options = {}) ⇒ Object



9870
9871
9872
9873
9874
9875
9876
# File 'lib/models/porcelain.rb', line 9870

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