Skip to main content

Class Operator

Namespace: Consul
Assembly: Consul.dll 

public class Operator : IOperatorEndpoint

Inheritance​

object ← Operator

Implements​

IOperatorEndpoint

Inherited Members​

object.Equals(object) , object.Equals(object, object) , object.GetHashCode() , object.GetType() , object.MemberwiseClone() , object.ReferenceEquals(object, object) , object.ToString()

Methods​

AreaCreate(AreaRequest, CancellationToken)​

CreateArea will create a new network area, a generated ID will be returned on success.

public Task<WriteResult<string>> AreaCreate(AreaRequest area, CancellationToken ct)

Parameters​

area AreaRequest

ct CancellationToken

Returns​

Task <WriteResult <string >>

AreaCreate(AreaRequest)​

public Task<WriteResult<string>> AreaCreate(AreaRequest area)

Parameters​

area AreaRequest

Returns​

Task <WriteResult <string >>

AreaCreate(AreaRequest, WriteOptions, CancellationToken)​

CreateArea will create a new network area, a generated ID will be returned on success.

public Task<WriteResult<string>> AreaCreate(AreaRequest area, WriteOptions q, CancellationToken ct = default)

Parameters​

area AreaRequest

q WriteOptions

ct CancellationToken

Returns​

Task <WriteResult <string >>

AreaDelete(string, CancellationToken)​

AreaDelete deletes the given network area.

public Task<WriteResult> AreaDelete(string areaId, CancellationToken ct)

Parameters​

areaId string

ct CancellationToken

Returns​

Task <WriteResult >

AreaDelete(string)​

public Task<WriteResult> AreaDelete(string areaId)

Parameters​

areaId string

Returns​

Task <WriteResult >

AreaDelete(string, WriteOptions, CancellationToken)​

AreaDelete deletes the given network area.

public Task<WriteResult> AreaDelete(string areaId, WriteOptions q, CancellationToken ct = default)

Parameters​

areaId string

q WriteOptions

ct CancellationToken

Returns​

Task <WriteResult >

AreaGet(string, CancellationToken)​

AreaGet returns a single network area

public Task<QueryResult<Area[]>> AreaGet(string areaId, CancellationToken ct)

Parameters​

areaId string

ct CancellationToken

Returns​

Task <QueryResult <Area []>>

AreaGet(string)​

public Task<QueryResult<Area[]>> AreaGet(string areaId)

Parameters​

areaId string

Returns​

Task <QueryResult <Area []>>

AreaGet(string, QueryOptions, CancellationToken)​

AreaGet returns a single network area

public Task<QueryResult<Area[]>> AreaGet(string areaId, QueryOptions q, CancellationToken ct = default)

Parameters​

areaId string

q QueryOptions

ct CancellationToken

Returns​

Task <QueryResult <Area []>>

AreaList(CancellationToken)​

AreaList returns all the available network areas

public Task<QueryResult<List<Area>>> AreaList(CancellationToken ct)

Parameters​

ct CancellationToken

Returns​

Task <QueryResult <List <Area >>>

AreaList()​

public Task<QueryResult<List<Area>>> AreaList()

Returns​

Task <QueryResult <List <Area >>>

AreaList(QueryOptions, CancellationToken)​

AreaList returns all the available network areas

public Task<QueryResult<List<Area>>> AreaList(QueryOptions q, CancellationToken ct = default)

Parameters​

q QueryOptions

ct CancellationToken

Returns​

Task <QueryResult <List <Area >>>

AreaUpdate(AreaRequest, string, CancellationToken)​

AreaUpdate will update the configuration of the network area with the given area Id.

public Task<WriteResult<string>> AreaUpdate(AreaRequest area, string areaId, CancellationToken ct)

Parameters​

area AreaRequest

areaId string

ct CancellationToken

Returns​

Task <WriteResult <string >>

AreaUpdate(AreaRequest, string)​

public Task<WriteResult<string>> AreaUpdate(AreaRequest area, string areaId)

Parameters​

area AreaRequest

areaId string

Returns​

Task <WriteResult <string >>

AreaUpdate(AreaRequest, string, WriteOptions, CancellationToken)​

AreaUpdate will update the configuration of the network area with the given area Id.

public Task<WriteResult<string>> AreaUpdate(AreaRequest area, string areaId, WriteOptions q, CancellationToken ct = default)

Parameters​

area AreaRequest

areaId string

q WriteOptions

ct CancellationToken

Returns​

Task <WriteResult <string >>

AutopilotGetConfiguration(CancellationToken)​

Retrieves the current Autopilot configuration

public Task<QueryResult<AutopilotConfiguration>> AutopilotGetConfiguration(CancellationToken cancellationToken)

Parameters​

cancellationToken CancellationToken

Cancellation token for the request

Returns​

Task <QueryResult <AutopilotConfiguration >>

A query result containing the Autopilot configuration

AutopilotGetConfiguration()​

public Task<QueryResult<AutopilotConfiguration>> AutopilotGetConfiguration()

Returns​

Task <QueryResult <AutopilotConfiguration >>

AutopilotGetConfiguration(QueryOptions, CancellationToken)​

Retrieves the current Autopilot configuration with query options

public Task<QueryResult<AutopilotConfiguration>> AutopilotGetConfiguration(QueryOptions q, CancellationToken cancellationToken = default)

Parameters​

q QueryOptions

Query options including datacenter and consistency mode

cancellationToken CancellationToken

Cancellation token for the request

Returns​

Task <QueryResult <AutopilotConfiguration >>

A query result containing the Autopilot configuration

AutopilotGetHealth(CancellationToken)​

Retrieves the autopilot health status of the cluster (synchronous version)

public Task<QueryResult<AutopilotHealth>> AutopilotGetHealth(CancellationToken cancellationToken)

Parameters​

cancellationToken CancellationToken

Query parameters

Returns​

Task <QueryResult <AutopilotHealth >>

The autopilot health information

AutopilotGetHealth()​

public Task<QueryResult<AutopilotHealth>> AutopilotGetHealth()

Returns​

Task <QueryResult <AutopilotHealth >>

AutopilotGetHealth(QueryOptions, CancellationToken)​

Retrieves the autopilot health status of the cluster

public Task<QueryResult<AutopilotHealth>> AutopilotGetHealth(QueryOptions q, CancellationToken cancellationToken = default)

Parameters​

q QueryOptions

Query parameters

cancellationToken CancellationToken

Cancellation token

Returns​

Task <QueryResult <AutopilotHealth >>

The autopilot health information

AutopilotGetState(CancellationToken)​

Retrieves the autopilot state of the cluster

public Task<QueryResult<AutopilotState>> AutopilotGetState(CancellationToken cancellationToken)

Parameters​

cancellationToken CancellationToken

Cancellation token

Returns​

Task <QueryResult <AutopilotState >>

The autopilot state information

AutopilotGetState()​

public Task<QueryResult<AutopilotState>> AutopilotGetState()

Returns​

Task <QueryResult <AutopilotState >>

AutopilotGetState(QueryOptions, CancellationToken)​

Retrieves the autopilot state of the cluster

public Task<QueryResult<AutopilotState>> AutopilotGetState(QueryOptions q, CancellationToken cancellationToken = default)

Parameters​

q QueryOptions

Query parameters

cancellationToken CancellationToken

Cancellation token

Returns​

Task <QueryResult <AutopilotState >>

The autopilot state information

AutopilotSetConfiguration(AutopilotConfiguration, CancellationToken)​

Updates the autopilot configuration of the cluster (synchronous version)

public Task<WriteResult> AutopilotSetConfiguration(AutopilotConfiguration configuration, CancellationToken cancellationToken)

Parameters​

configuration AutopilotConfiguration

The autopilot configuration to set

cancellationToken CancellationToken

Cancellation token

Returns​

Task <WriteResult >

The write result

AutopilotSetConfiguration(AutopilotConfiguration)​

public Task<WriteResult> AutopilotSetConfiguration(AutopilotConfiguration configuration)

Parameters​

configuration AutopilotConfiguration

Returns​

Task <WriteResult >

AutopilotSetConfiguration(AutopilotConfiguration, WriteOptions, CancellationToken)​

Updates the autopilot configuration of the cluster

public Task<WriteResult> AutopilotSetConfiguration(AutopilotConfiguration configuration, WriteOptions q, CancellationToken cancellationToken = default)

Parameters​

configuration AutopilotConfiguration

The autopilot configuration to set

q WriteOptions

Write options

cancellationToken CancellationToken

Cancellation token

Returns​

Task <WriteResult >

The write result

GetConsulLicense(string, CancellationToken)​

public Task<QueryResult<ConsulLicense>> GetConsulLicense(string datacenter = "", CancellationToken ct = default)

Parameters​

datacenter string

ct CancellationToken

Returns​

Task <QueryResult <ConsulLicense >>

KeyringInstall(string, CancellationToken)​

KeyringInstall is used to install a new gossip encryption key into the cluster

public Task<WriteResult> KeyringInstall(string key, CancellationToken ct)

Parameters​

key string

ct CancellationToken

Returns​

Task <WriteResult >

KeyringInstall(string)​

public Task<WriteResult> KeyringInstall(string key)

Parameters​

key string

Returns​

Task <WriteResult >

KeyringInstall(string, WriteOptions, CancellationToken)​

KeyringInstall is used to install a new gossip encryption key into the cluster

public Task<WriteResult> KeyringInstall(string key, WriteOptions q, CancellationToken ct = default)

Parameters​

key string

q WriteOptions

ct CancellationToken

Returns​

Task <WriteResult >

KeyringList(CancellationToken)​

KeyringList is used to list the gossip keys installed in the cluster

public Task<QueryResult<KeyringResponse[]>> KeyringList(CancellationToken ct)

Parameters​

ct CancellationToken

Returns​

Task <QueryResult <KeyringResponse []>>

KeyringList()​

public Task<QueryResult<KeyringResponse[]>> KeyringList()

Returns​

Task <QueryResult <KeyringResponse []>>

KeyringList(QueryOptions, CancellationToken)​

KeyringList is used to list the gossip keys installed in the cluster

public Task<QueryResult<KeyringResponse[]>> KeyringList(QueryOptions q, CancellationToken ct = default)

Parameters​

q QueryOptions

ct CancellationToken

Returns​

Task <QueryResult <KeyringResponse []>>

KeyringRemove(string, CancellationToken)​

KeyringRemove is used to remove a gossip encryption key from the cluster

public Task<WriteResult> KeyringRemove(string key, CancellationToken ct)

Parameters​

key string

ct CancellationToken

Returns​

Task <WriteResult >

KeyringRemove(string)​

public Task<WriteResult> KeyringRemove(string key)

Parameters​

key string

Returns​

Task <WriteResult >

KeyringRemove(string, WriteOptions, CancellationToken)​

KeyringRemove is used to remove a gossip encryption key from the cluster

public Task<WriteResult> KeyringRemove(string key, WriteOptions q, CancellationToken ct = default)

Parameters​

key string

q WriteOptions

ct CancellationToken

Returns​

Task <WriteResult >

KeyringUse(string, CancellationToken)​

KeyringUse is used to change the active gossip encryption key

public Task<WriteResult> KeyringUse(string key, CancellationToken ct)

Parameters​

key string

ct CancellationToken

Returns​

Task <WriteResult >

KeyringUse(string)​

public Task<WriteResult> KeyringUse(string key)

Parameters​

key string

Returns​

Task <WriteResult >

KeyringUse(string, WriteOptions, CancellationToken)​

KeyringUse is used to change the active gossip encryption key

public Task<WriteResult> KeyringUse(string key, WriteOptions q, CancellationToken ct = default)

Parameters​

key string

q WriteOptions

ct CancellationToken

Returns​

Task <WriteResult >

OperatorGetUsage(CancellationToken)​

public Task<QueryResult<OperatorUsageInformation>> OperatorGetUsage(CancellationToken cancellationToken)

Parameters​

cancellationToken CancellationToken

Returns​

Task <QueryResult <OperatorUsageInformation >>

OperatorGetUsage()​

public Task<QueryResult<OperatorUsageInformation>> OperatorGetUsage()

Returns​

Task <QueryResult <OperatorUsageInformation >>

OperatorGetUsage(QueryOptions, CancellationToken)​

public Task<QueryResult<OperatorUsageInformation>> OperatorGetUsage(QueryOptions q, CancellationToken cancellationToken = default)

Parameters​

q QueryOptions

cancellationToken CancellationToken

Returns​

Task <QueryResult <OperatorUsageInformation >>

RaftGetConfiguration(CancellationToken)​

RaftGetConfiguration is used to query the current Raft peer set.

public Task<QueryResult<RaftConfiguration>> RaftGetConfiguration(CancellationToken ct)

Parameters​

ct CancellationToken

Returns​

Task <QueryResult <RaftConfiguration >>

RaftGetConfiguration()​

public Task<QueryResult<RaftConfiguration>> RaftGetConfiguration()

Returns​

Task <QueryResult <RaftConfiguration >>

RaftGetConfiguration(QueryOptions, CancellationToken)​

RaftGetConfiguration is used to query the current Raft peer set.

public Task<QueryResult<RaftConfiguration>> RaftGetConfiguration(QueryOptions q, CancellationToken ct = default)

Parameters​

q QueryOptions

ct CancellationToken

Returns​

Task <QueryResult <RaftConfiguration >>

RaftRemovePeerByAddress(string, CancellationToken)​

RaftRemovePeerByAddress is used to kick a stale peer (one that it in the Raft quorum but no longer known to Serf or the catalog) by address in the form of "IP:port".

public Task<WriteResult> RaftRemovePeerByAddress(string address, CancellationToken ct)

Parameters​

address string

ct CancellationToken

Returns​

Task <WriteResult >

RaftRemovePeerByAddress(string)​

public Task<WriteResult> RaftRemovePeerByAddress(string address)

Parameters​

address string

Returns​

Task <WriteResult >

RaftRemovePeerByAddress(string, WriteOptions, CancellationToken)​

RaftRemovePeerByAddress is used to kick a stale peer (one that it in the Raft quorum but no longer known to Serf or the catalog) by address in the form of "IP:port".

public Task<WriteResult> RaftRemovePeerByAddress(string address, WriteOptions q, CancellationToken ct = default)

Parameters​

address string

q WriteOptions

ct CancellationToken

Returns​

Task <WriteResult >

RaftTransferLeader(CancellationToken)​

Transfers Raft leadership to another server

public Task<WriteResult> RaftTransferLeader(CancellationToken ct)

Parameters​

ct CancellationToken

Cancellation token for the request

Returns​

Task <WriteResult >

A write result indicating the success of the operation

RaftTransferLeader()​

public Task<WriteResult> RaftTransferLeader()

Returns​

Task <WriteResult >

RaftTransferLeader(WriteOptions, CancellationToken)​

Transfers Raft leadership to another server with write options

public Task<WriteResult> RaftTransferLeader(WriteOptions q, CancellationToken ct)

Parameters​

q WriteOptions

Write options including datacenter and token

ct CancellationToken

Cancellation token for the request

Returns​

Task <WriteResult >

A write result indicating the success of the operation

RaftTransferLeader(WriteOptions)​

public Task<WriteResult> RaftTransferLeader(WriteOptions q)

Parameters​

q WriteOptions

Returns​

Task <WriteResult >

RaftTransferLeader(string, CancellationToken)​

Transfers Raft leadership to another server by ID

public Task<WriteResult> RaftTransferLeader(string id, CancellationToken ct)

Parameters​

id string

The node ID of the Raft peer to transfer leadership to

ct CancellationToken

Cancellation token for the request

Returns​

Task <WriteResult >

A write result indicating the success of the operation

RaftTransferLeader(string)​

public Task<WriteResult> RaftTransferLeader(string id)

Parameters​

id string

Returns​

Task <WriteResult >

RaftTransferLeader(string, WriteOptions, CancellationToken)​

Transfers Raft leadership to another server by ID with write options

public Task<WriteResult> RaftTransferLeader(string id, WriteOptions q, CancellationToken ct = default)

Parameters​

id string

The node ID of the Raft peer to transfer leadership to

q WriteOptions

Write options including datacenter and token

ct CancellationToken

Cancellation token for the request

Returns​

Task <WriteResult >

A write result indicating the success of the operation

SegmentList(QueryOptions, CancellationToken)​

// SegmentList returns all the available LAN segments.

public Task<QueryResult<string[]>> SegmentList(QueryOptions q, CancellationToken ct = default)

Parameters​

q QueryOptions

ct CancellationToken

Returns​

Task <QueryResult <string []>>

SegmentList(CancellationToken)​

// SegmentList returns all the available LAN segments.

public Task<QueryResult<string[]>> SegmentList(CancellationToken ct)

Parameters​

ct CancellationToken

Returns​

Task <QueryResult <string []>>

SegmentList()​

public Task<QueryResult<string[]>> SegmentList()

Returns​

Task <QueryResult <string []>>

  • Methods
    • AreaCreate(AreaRequest, CancellationToken)
    • AreaCreate(AreaRequest)
    • AreaCreate(AreaRequest, WriteOptions, CancellationToken)
    • AreaDelete(string, CancellationToken)
    • AreaDelete(string)
    • AreaDelete(string, WriteOptions, CancellationToken)
    • AreaGet(string, CancellationToken)
    • AreaGet(string)
    • AreaGet(string, QueryOptions, CancellationToken)
    • AreaList(CancellationToken)
    • AreaList()
    • AreaList(QueryOptions, CancellationToken)
    • AreaUpdate(AreaRequest, string, CancellationToken)
    • AreaUpdate(AreaRequest, string)
    • AreaUpdate(AreaRequest, string, WriteOptions, CancellationToken)
    • AutopilotGetConfiguration(CancellationToken)
    • AutopilotGetConfiguration()
    • AutopilotGetConfiguration(QueryOptions, CancellationToken)
    • AutopilotGetHealth(CancellationToken)
    • AutopilotGetHealth()
    • AutopilotGetHealth(QueryOptions, CancellationToken)
    • AutopilotGetState(CancellationToken)
    • AutopilotGetState()
    • AutopilotGetState(QueryOptions, CancellationToken)
    • AutopilotSetConfiguration(AutopilotConfiguration, CancellationToken)
    • AutopilotSetConfiguration(AutopilotConfiguration)
    • AutopilotSetConfiguration(AutopilotConfiguration, WriteOptions, CancellationToken)
    • GetConsulLicense(string, CancellationToken)
    • KeyringInstall(string, CancellationToken)
    • KeyringInstall(string)
    • KeyringInstall(string, WriteOptions, CancellationToken)
    • KeyringList(CancellationToken)
    • KeyringList()
    • KeyringList(QueryOptions, CancellationToken)
    • KeyringRemove(string, CancellationToken)
    • KeyringRemove(string)
    • KeyringRemove(string, WriteOptions, CancellationToken)
    • KeyringUse(string, CancellationToken)
    • KeyringUse(string)
    • KeyringUse(string, WriteOptions, CancellationToken)
    • OperatorGetUsage(CancellationToken)
    • OperatorGetUsage()
    • OperatorGetUsage(QueryOptions, CancellationToken)
    • RaftGetConfiguration(CancellationToken)
    • RaftGetConfiguration()
    • RaftGetConfiguration(QueryOptions, CancellationToken)
    • RaftRemovePeerByAddress(string, CancellationToken)
    • RaftRemovePeerByAddress(string)
    • RaftRemovePeerByAddress(string, WriteOptions, CancellationToken)
    • RaftTransferLeader(CancellationToken)
    • RaftTransferLeader()
    • RaftTransferLeader(WriteOptions, CancellationToken)
    • RaftTransferLeader(WriteOptions)
    • RaftTransferLeader(string, CancellationToken)
    • RaftTransferLeader(string)
    • RaftTransferLeader(string, WriteOptions, CancellationToken)
    • SegmentList(QueryOptions, CancellationToken)
    • SegmentList(CancellationToken)
    • SegmentList()