Class Operator
Namespace: Consul
Assembly: Consul.dll
public class Operator : IOperatorEndpoint
Inheritance
Implements
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 = default)
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
Returns
Task <WriteResult <string >>
AreaDelete(string, CancellationToken)
AreaDelete deletes the given network area.
public Task<WriteResult> AreaDelete(string areaId, CancellationToken ct = default)
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
Returns
Task <WriteResult >
AreaGet(string, CancellationToken)
AreaGet returns a single network area
public Task<QueryResult<Area[]>> AreaGet(string areaId, CancellationToken ct = default)
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
Returns
Task <QueryResult <Area []>>
AreaList(CancellationToken)
AreaList returns all the available network areas
public Task<QueryResult<List<Area>>> AreaList(CancellationToken ct = default)
Parameters
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
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 = default)
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
Returns
Task <WriteResult <string >>
GetConsulLicense(string, CancellationToken)
public Task<QueryResult<ConsulLicense>> GetConsulLicense(string datacenter = "", CancellationToken ct = default)
Parameters
datacenter string
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 = default)
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
Returns
Task <WriteResult >
KeyringList(CancellationToken)
KeyringList is used to list the gossip keys installed in the cluster
public Task<QueryResult<KeyringResponse[]>> KeyringList(CancellationToken ct = default)
Parameters
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
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 = default)
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
Returns
Task <WriteResult >
KeyringUse(string, CancellationToken)
KeyringUse is used to change the active gossip encryption key
public Task<WriteResult> KeyringUse(string key, CancellationToken ct = default)
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
Returns
Task <WriteResult >
RaftGetConfiguration(CancellationToken)
RaftGetConfiguration is used to query the current Raft peer set.
public Task<QueryResult<RaftConfiguration>> RaftGetConfiguration(CancellationToken ct = default)
Parameters
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
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 = default)
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
Returns
Task <WriteResult >
SegmentList(QueryOptions, CancellationToken)
// SegmentList returns all the available LAN segments.
public Task<QueryResult<string[]>> SegmentList(QueryOptions q, CancellationToken ct = default)
Parameters
Returns
Task <QueryResult <string []>>
SegmentList(CancellationToken)
// SegmentList returns all the available LAN segments.
public Task<QueryResult<string[]>> SegmentList(CancellationToken ct = default)
Parameters
Returns
Task <QueryResult <string []>>