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



11542
11543
11544
11545
11546
11547
11548
11549
11550
11551
11552
11553
11554
11555
11556
11557
11558
11559
11560
11561
11562
11563
11564
11565
11566
11567
11568
11569
11570
11571
11572
11573
11574
11575
11576
11577
11578
11579
11580
11581
11582
11583
11584
11585
11586
# File 'lib/models/porcelain.rb', line 11542

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,
  proxy_cluster_id: 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
  @proxy_cluster_id = proxy_cluster_id == nil ? "" : proxy_cluster_id
  @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.



11500
11501
11502
# File 'lib/models/porcelain.rb', line 11500

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.



11502
11503
11504
# File 'lib/models/porcelain.rb', line 11502

def bind_interface
  @bind_interface
end

#databaseObject

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



11504
11505
11506
# File 'lib/models/porcelain.rb', line 11504

def database
  @database
end

#egress_filterObject

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



11506
11507
11508
# File 'lib/models/porcelain.rb', line 11506

def egress_filter
  @egress_filter
end

#healthyObject

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



11508
11509
11510
# File 'lib/models/porcelain.rb', line 11508

def healthy
  @healthy
end

#hostnameObject

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



11510
11511
11512
# File 'lib/models/porcelain.rb', line 11510

def hostname
  @hostname
end

#idObject

Unique identifier of the Resource.



11512
11513
11514
# File 'lib/models/porcelain.rb', line 11512

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.



11514
11515
11516
# File 'lib/models/porcelain.rb', line 11514

def keytab
  @keytab
end

#krb_configObject

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



11516
11517
11518
# File 'lib/models/porcelain.rb', line 11516

def krb_config
  @krb_config
end

#nameObject

Unique human-readable name of the Resource.



11518
11519
11520
# File 'lib/models/porcelain.rb', line 11518

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.



11520
11521
11522
# File 'lib/models/porcelain.rb', line 11520

def override_database
  @override_database
end

#portObject

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



11522
11523
11524
# File 'lib/models/porcelain.rb', line 11522

def port
  @port
end

#port_overrideObject

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



11524
11525
11526
# File 'lib/models/porcelain.rb', line 11524

def port_override
  @port_override
end

#proxy_cluster_idObject

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



11526
11527
11528
# File 'lib/models/porcelain.rb', line 11526

def proxy_cluster_id
  @proxy_cluster_id
end

#realmObject

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



11528
11529
11530
# File 'lib/models/porcelain.rb', line 11528

def realm
  @realm
end

#schemaObject

The Schema to use to direct initial requests.



11530
11531
11532
# File 'lib/models/porcelain.rb', line 11530

def schema
  @schema
end

#secret_store_idObject

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



11532
11533
11534
# File 'lib/models/porcelain.rb', line 11532

def secret_store_id
  @secret_store_id
end

#server_spnObject

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



11534
11535
11536
# File 'lib/models/porcelain.rb', line 11534

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)



11536
11537
11538
# File 'lib/models/porcelain.rb', line 11536

def subdomain
  @subdomain
end

#tagsObject

Tags is a map of key, value pairs.



11538
11539
11540
# File 'lib/models/porcelain.rb', line 11538

def tags
  @tags
end

#usernameObject

The username to authenticate with.



11540
11541
11542
# File 'lib/models/porcelain.rb', line 11540

def username
  @username
end

Instance Method Details

#to_json(options = {}) ⇒ Object



11588
11589
11590
11591
11592
11593
11594
# File 'lib/models/porcelain.rb', line 11588

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