cmd

Documentation

Index

• Constants
• Variables
• func APIID() int
• func APIToken() string
• func Execute()
• func FormatOps(rs []*OPRecordEntry, format string, cap string) string
• type ActionRunner
• type DomainActionRunner
  • func (r *DomainActionRunner) Detail() string
  • func (r *DomainActionRunner) Name() string
  • func (r *DomainActionRunner) Run()
• type InfoActionRunner
  • func (r *InfoActionRunner) Detail() string
  • func (r *InfoActionRunner) Name() string
  • func (r *InfoActionRunner) Run()
• type OPRecordEntry
• type PlaybookRunner
  • func NewPlaybookRunner(action, scene string, cfg dnspodapi.Scene, auths dnspodapi.Auth) *PlaybookRunner
  • func (p *PlaybookRunner) Run()
• type RecordActionRunner
  • func (r *RecordActionRunner) Detail() string
  • func (r *RecordActionRunner) Name() string
  • func (r *RecordActionRunner) Run()

Constants

const (
	// DomainActionCreate defines OPCreate
	DomainActionCreate = "create"
	// DomainActionRemove defines OPRemove
	DomainActionRemove = "remove"
	// DomainActionInfo defines OPInfo
	DomainActionInfo = "info"
	// DomainActionStatus defines OPStatus
	DomainActionStatus = "status"
	// DomainActionList defines OPList
	DomainActionList = "list"
)

const (
	// RecordActionCreate defines OPCreate
	RecordActionCreate = "create"
	// RecordActionRemove defines OPRemove
	RecordActionRemove = "remove"
	// RecordActionModify defines OPModify
	RecordActionModify = "modify"
	// RecordActionImport defines OPImport
	RecordActionImport = "import"
	// RecordActionExport defines OPExport
	RecordActionExport = "export"
)

const (
	// RecordFlagClear for clear conflict records
	RecordFlagClear = iota
	// RecordFlagForceDomain for create domain if not exist when import record
	RecordFlagForceDomain
	// RecordFlagExclude for exclude non declared records when ensure
	RecordFlagExclude
	// RecordFlagClearNS for force clear @ NS record
	RecordFlagClearNS
)

const (
	// APIIDField defines the field raw string of `api_id` in config file
	APIIDField = "api_id"
	// APITokenField defines the field raw string of `api_token` in config file
	APITokenField = "api_token"
	// LogOutput defines the output of writer of log
	LogOutput = "log_output"
	// GlobalNamespace defines the default namespace raw string
	GlobalNamespace = "global"
)

Variables

var (
	// DefaultRecordLineID defines the default record_line_id, 0 is "默认"
	DefaultRecordLineID = "0"
	// DefaultTTL defines the default TTL value
	DefaultTTL = "600"
	// CNAMEMagicString defines the magic string in value to replace in CNAME
	CNAMEMagicString = "{DOMAIN}"
)

Functions

func APIID

func APIID() int

APIID returns apiID

func APIToken

func APIToken() string

APIToken returns apiToken

func Execute

func Execute()

Execute adds all child commands to the root command and sets flags appropriately. This is called by main.main(). It only needs to happen once to the rootCmd.

func FormatOps

func FormatOps(rs []*OPRecordEntry, format string, cap string) string

FormatOps returns string of Ops slice

Types

type ActionRunner

type ActionRunner interface {
	Detail() string
	Name() string
	Run()
}

ActionRunner defines the interface to run action

type DomainActionRunner

type DomainActionRunner struct {
	Domain   string
	Action   string
	Params   map[string]string
	APIID    int
	APIToken string
}

DomainActionRunner defines the runner to run domain action

func (*DomainActionRunner) Detail

func (r *DomainActionRunner) Detail() string

Detail returns detail information

func (*DomainActionRunner) Name

func (r *DomainActionRunner) Name() string

Name returns runner name

func (*DomainActionRunner) Run

func (r *DomainActionRunner) Run()

Run starts to run action

type InfoActionRunner

type InfoActionRunner struct {
	Action   string
	Params   map[string]string
	APIID    int
	APIToken string
}

InfoActionRunner defines the runner to run info action

func (*InfoActionRunner) Detail

func (r *InfoActionRunner) Detail() string

Detail returns detail information

func (*InfoActionRunner) Name

func (r *InfoActionRunner) Name() string

Name returns runner name

func (*InfoActionRunner) Run

func (r *InfoActionRunner) Run()

Run starts to run action

type OPRecordEntry

type OPRecordEntry struct {
	Action    string `json:"action"`
	Domain    string `json:"domain"`
	DomainID  string `json:"domain_id"`
	RecordID  string `json:"record_id"`
	SubDomain string `json:"sub_domain"`
	Type      string `json:"type"`
	Value     string `json:"value"`
	RealValue string `json:"real_value"`
	TTL       string `json:"ttl"`
	Err       error  `json:"err"`
	Message   string `json:"message"`
}

OPRecordEntry defines the struct for adding record and result info

type PlaybookRunner

type PlaybookRunner struct {
	Scene         string
	Action        string
	ActionRunners []ActionRunner
}

PlaybookRunner defines the runner to run scene

func NewPlaybookRunner

func NewPlaybookRunner(action, scene string, cfg dnspodapi.Scene,
	auths dnspodapi.Auth,
) *PlaybookRunner

NewPlaybookRunner returns a new PlaybookRunner pointer

func (*PlaybookRunner) Run

func (p *PlaybookRunner) Run()

Run starts to run playbook

type RecordActionRunner

type RecordActionRunner struct {
	Record   string
	Action   string
	Params   map[string]string
	APIID    int
	APIToken string
	// contains filtered or unexported fields
}

RecordActionRunner defines the runner to run record action

func (*RecordActionRunner) Detail

func (r *RecordActionRunner) Detail() string

Detail returns detail information

func (*RecordActionRunner) Name

func (r *RecordActionRunner) Name() string

Name returns runner name

func (*RecordActionRunner) Run

func (r *RecordActionRunner) Run()

Run starts to run action