ciscobcs

package
v0.6.0 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Jun 27, 2022 License: MIT Imports: 11 Imported by: 0

Documentation

Overview

Copyright 2021 The ciscobcs AUTHORS. All rights reserved.

Use of this source code is governed by an MIT-style license that can be found in the LICENSE file. Code generated by gen-accessors; DO NOT EDIT.

Index

Constants

View Source 
const (
	ErrMissingAPIKey     = Err("ciscobcs: missing required apikey")
	ErrMissingCustomerID = Err("ciscobcs: missing customer id")

	ErrBadRequest    = Err("ciscobcs: bad request")
	ErrUnauthorized  = Err("ciscobcs: unauthorized request")
	ErrForbidden     = Err("ciscobcs: forbidden")
	ErrInternalError = Err("ciscobcs: internal error")
	ErrUnknown       = Err("ciscobcs: unexpected error occurred")
)

Error Constants

View Source 
const DateFormat = "2006-01-02"

DateFormat represents the date only format provided in the Cisco results.

View Source 
const DateTimeMinusTimezoneFormat = "2006-01-02T15:04:05"

DateTimeMinusTimezoneFormat represents the datetime field provided in the Cisco results which they have chosen not to provide any timezone information for.

Variables

This section is empty.

Functions

func Bool 

func Bool(v bool) *bool

Bool is a helper routine that allocates a new bool value to store v and returns a pointer to it.

func Float64 

func Float64(v float64) *float64

Float64 is a helper routine that allocates a new Float64 value to store v and returns a pointer to it.

func Int 

func Int(v int) *int

Int is a helper routine that allocates a new int value to store v and returns a pointer to it.

func Int64 

func Int64(v int64) *int64

Int64 is a helper routine that allocates a new int64 value to store v and returns a pointer to it.

func ListAllBCSObjects 

func ListAllBCSObjects[T any](ctx context.Context, c *Client, customerID string, urlStr string) ([]*T, error)

ListAllBCSObjects provides a generic function for listing all items for a particular BCS Object type without needing the user to perform pagination.

func String 

func String(v string) *string

String is a helper routine that allocates a new string value to store v and returns a pointer to it.

Types

type Asset 

type Asset struct {
	// Customer ID is not included in the response, but should be added to associate this device to a specific customer
	CustomerID string `gorm:"primaryKey;autoIncrement:false"`

	// The name of the chassis.  This is useful to reference child hardware to its parent chassis in a multi-chassis set-up.
	ChassisName *string `json:"chassisName,omitempty"`

	// The unique ID of the NP NetworkElement/Device.
	DeviceId *int `json:"deviceId,omitempty"`

	// The Network Element Name of the device. When used as input, it can include % as wildcard.
	DeviceName *string `json:"deviceName,omitempty"`

	// The hardware revision.
	HwRev *string `json:"hwRev,omitempty"`

	// The amount of installed flash in the chassis (in megabytes).
	InstalledFlash *int `json:"installedFlash,omitempty"`

	// The amount of installed memory in the chassis (in megabytes).
	InstalledMemory *int `json:"installedMemory,omitempty"`

	// The printed circuit board (PCB) number of the hardware.
	Pcb *string `json:"pcb,omitempty"`

	// The printed circuit board (PCB) number revision of the hardware.
	PcbRev *string `json:"pcbRev,omitempty"`

	// The unique ID in NP for a specific piece of hardware.
	PhysicalElementId *int `json:"physicalElementId,omitempty" gorm:"primaryKey;autoIncrement:false"`

	// For chassis physicalType, this field will indicate which are IP-PHONE, LWAP, or UCSB.
	PhysicalSubtype *string `json:"physicalSubtype,omitempty"`

	// The physical type of the hardware.  Valid values are: Chassis, Module, Power Supply, Fan.
	PhysicalType *string `json:"physicalType,omitempty"`

	// The Cisco Product Family of the hardware.  Values come from MDF for Chassis.
	ProductFamily *string `json:"productFamily,omitempty"`

	// The Cisco Product ID (PID) of the hardware.
	ProductId *string `json:"productId,omitempty" gorm:"size:32000"`

	// The Cisco Product Type in COLD of the hardware.  Values usually come from MDF.
	ProductType *string `json:"productType,omitempty"`

	// The serial number of the hardware.
	SerialNumber *string `json:"serialNumber,omitempty"`

	// The validation status of the serial number of the hardware.  VALID means the SN was found in Cisco MFG or Contract DB. INVALID means the SN was not found in either of those DBs. UNKNOWN means the SN validation has been completed. N/A means the SN is null, so validation is not applicable.
	SerialNumberStatus *string `json:"serialNumberStatus,omitempty"`

	// The slot where a hardware component is located in a chassis.
	Slot *string `json:"slot,omitempty"`

	// The Software Version of the device.
	SwVersion *string `json:"swVersion,omitempty"`

	// The Top Assembly Number (TAN) of the hardware.
	Tan *string `json:"tan,omitempty"`

	// The Top Assembly Number (TAN) Revision of the hardware.
	TanRev *string `json:"tanRev,omitempty"`
}

Asset defines model for Asset.

func (*Asset) GetChassisName 

func (a *Asset) GetChassisName() string

GetChassisName returns the ChassisName field if it's non-nil, zero value otherwise.

func (*Asset) GetDeviceId 

func (a *Asset) GetDeviceId() int

GetDeviceId returns the DeviceId field if it's non-nil, zero value otherwise.

func (*Asset) GetDeviceName 

func (a *Asset) GetDeviceName() string

GetDeviceName returns the DeviceName field if it's non-nil, zero value otherwise.

func (*Asset) GetHwRev 

func (a *Asset) GetHwRev() string

GetHwRev returns the HwRev field if it's non-nil, zero value otherwise.

func (*Asset) GetInstalledFlash 

func (a *Asset) GetInstalledFlash() int

GetInstalledFlash returns the InstalledFlash field if it's non-nil, zero value otherwise.

func (*Asset) GetInstalledMemory 

func (a *Asset) GetInstalledMemory() int

GetInstalledMemory returns the InstalledMemory field if it's non-nil, zero value otherwise.

func (*Asset) GetPcb 

func (a *Asset) GetPcb() string

GetPcb returns the Pcb field if it's non-nil, zero value otherwise.

func (*Asset) GetPcbRev 

func (a *Asset) GetPcbRev() string

GetPcbRev returns the PcbRev field if it's non-nil, zero value otherwise.

func (*Asset) GetPhysicalElementId 

func (a *Asset) GetPhysicalElementId() int

GetPhysicalElementId returns the PhysicalElementId field if it's non-nil, zero value otherwise.

func (*Asset) GetPhysicalSubtype 

func (a *Asset) GetPhysicalSubtype() string

GetPhysicalSubtype returns the PhysicalSubtype field if it's non-nil, zero value otherwise.

func (*Asset) GetPhysicalType 

func (a *Asset) GetPhysicalType() string

GetPhysicalType returns the PhysicalType field if it's non-nil, zero value otherwise.

func (*Asset) GetProductFamily 

func (a *Asset) GetProductFamily() string

GetProductFamily returns the ProductFamily field if it's non-nil, zero value otherwise.

func (*Asset) GetProductId 

func (a *Asset) GetProductId() string

GetProductId returns the ProductId field if it's non-nil, zero value otherwise.

func (*Asset) GetProductType 

func (a *Asset) GetProductType() string

GetProductType returns the ProductType field if it's non-nil, zero value otherwise.

func (*Asset) GetSerialNumber 

func (a *Asset) GetSerialNumber() string

GetSerialNumber returns the SerialNumber field if it's non-nil, zero value otherwise.

func (*Asset) GetSerialNumberStatus 

func (a *Asset) GetSerialNumberStatus() string

GetSerialNumberStatus returns the SerialNumberStatus field if it's non-nil, zero value otherwise.

func (*Asset) GetSlot 

func (a *Asset) GetSlot() string

GetSlot returns the Slot field if it's non-nil, zero value otherwise.

func (*Asset) GetSwVersion 

func (a *Asset) GetSwVersion() string

GetSwVersion returns the SwVersion field if it's non-nil, zero value otherwise.

func (*Asset) GetTan 

func (a *Asset) GetTan() string

GetTan returns the Tan field if it's non-nil, zero value otherwise.

func (*Asset) GetTanRev 

func (a *Asset) GetTanRev() string

GetTanRev returns the TanRev field if it's non-nil, zero value otherwise.

type BCSListResponse 

type BCSListResponse[T any] struct {
	Items   []*T `json:"items"`
	Page    int  `json:"page"`
	Pages   int  `json:"pages"`
	PerPage int  `json:"perPage"`
	Total   int  `json:"total"`
}

BCSListResponse is used for all currently known list types with a generic Items field to capture the various results.

func ListBCSObject 

func ListBCSObject[T any](ctx context.Context, c *Client, customerID string, urlStr string, options ...*ListOptions) (*BCSListResponse[T], error)

ListBCSObject provides a generic function for listing the different BCS Object types which only differ in the list of Items it returns.

type CBPDetail 

type CBPDetail struct {
	// // Customer ID is not included in the response, but should be added to associate this device to a specific customer
	CustomerID string `gorm:"primary_key;autoIncrement:false"`

	// The internal Config BP Nugget ID from the AI-X system. Used to cross-reference with other API results.
	BpNuggetId *int `json:"bpNuggetId,omitempty"`

	// The internal Config BP Rule ID from the AI-X system. Used to cross-reference with other API results.
	BpRuleId *int `json:"bpRuleId,omitempty" gorm:"primaryKey;autoIncrement:false"`

	// The source of a Configuration file.  The primary source will be "STANDARD". But in some devices, it might be "CONTEXT" or "ADMIN".
	ConfigSource *string `json:"configSource,omitempty"`

	// The ID of the NP NetworkElement/Device.
	DeviceId *int `json:"deviceId,omitempty" gorm:"primaryKey;autoIncrement:false"`
}

CBPDetails defines model for CBPDetails.

func (*CBPDetail) GetBpNuggetId 

func (c *CBPDetail) GetBpNuggetId() int

GetBpNuggetId returns the BpNuggetId field if it's non-nil, zero value otherwise.

func (*CBPDetail) GetBpRuleId 

func (c *CBPDetail) GetBpRuleId() int

GetBpRuleId returns the BpRuleId field if it's non-nil, zero value otherwise.

func (*CBPDetail) GetConfigSource 

func (c *CBPDetail) GetConfigSource() string

GetConfigSource returns the ConfigSource field if it's non-nil, zero value otherwise.

func (*CBPDetail) GetDeviceId 

func (c *CBPDetail) GetDeviceId() int

GetDeviceId returns the DeviceId field if it's non-nil, zero value otherwise.

type CBPRule 

type CBPRule struct {
	// The Caveat associated with a Config BP Rule.
	BpCaveat *string `json:"bpCaveat,omitempty" gorm:"size:4000"`

	// The Corrective Action associated with a Config BP Rule.
	BpCorrectiveAction *string `json:"bpCorrectiveAction,omitempty" gorm:"size:4000"`

	// The Description associated with a Config BP Rule.
	BpDescription *string `json:"bpDescription,omitempty" gorm:"size:4000"`

	// The internal Config BP Nugget ID from the AI-X system. Used to cross-reference with other API results.
	BpNuggetId *int `json:"bpNuggetId,omitempty"`

	// The Primary Technology associated with a Config BP Rule.
	BpPrimaryTechnology *string `json:"bpPrimaryTechnology,omitempty"`

	// The Recommendation associated with a Config BP Rule.
	BpRecommendation *string `json:"bpRecommendation,omitempty" gorm:"size:4000"`

	// The Risk associated with a Config BP Rule. Valid values include: High, Medium, Low.
	BpRisk *string `json:"bpRisk,omitempty"`

	// The internal Config BP Rule ID from the AI-X system. Used to cross-reference with other API results.
	BpRuleId *int `json:"bpRuleId,omitempty" gorm:"primaryKey;autoIncrement:false"`

	// The Secondary Technologies associated with a Config BP Rule. Can be multiple values separated with commas.
	BpSecondaryTechnology *string `json:"bpSecondaryTechnology,omitempty"`

	// The Config BP exception headline / title.
	BpTitle *string `json:"bpTitle,omitempty"`

	// The date the record orrule was created in NP database.  For devices, a new record is created whenever a unique name+sysobjectid combination is seen in the collector.
	CreateDate *DateTime `json:"createDate,omitempty"`

	// The Type of Software running on the NP Network Element.  Common values include IOS, IOS XR, IOS-XE, NX-OS, etc.
	SwType *string `json:"swType,omitempty"`

	// The timestamp when the data or rule was last updated.
	UpdateDate *DateTime `json:"updateDate,omitempty"`
}

CBPRules defines model for CBPRules.

func (*CBPRule) GetBpCaveat 

func (c *CBPRule) GetBpCaveat() string

GetBpCaveat returns the BpCaveat field if it's non-nil, zero value otherwise.

func (*CBPRule) GetBpCorrectiveAction 

func (c *CBPRule) GetBpCorrectiveAction() string

GetBpCorrectiveAction returns the BpCorrectiveAction field if it's non-nil, zero value otherwise.

func (*CBPRule) GetBpDescription 

func (c *CBPRule) GetBpDescription() string

GetBpDescription returns the BpDescription field if it's non-nil, zero value otherwise.

func (*CBPRule) GetBpNuggetId 

func (c *CBPRule) GetBpNuggetId() int

GetBpNuggetId returns the BpNuggetId field if it's non-nil, zero value otherwise.

func (*CBPRule) GetBpPrimaryTechnology 

func (c *CBPRule) GetBpPrimaryTechnology() string

GetBpPrimaryTechnology returns the BpPrimaryTechnology field if it's non-nil, zero value otherwise.

func (*CBPRule) GetBpRecommendation 

func (c *CBPRule) GetBpRecommendation() string

GetBpRecommendation returns the BpRecommendation field if it's non-nil, zero value otherwise.

func (*CBPRule) GetBpRisk 

func (c *CBPRule) GetBpRisk() string

GetBpRisk returns the BpRisk field if it's non-nil, zero value otherwise.

func (*CBPRule) GetBpRuleId 

func (c *CBPRule) GetBpRuleId() int

GetBpRuleId returns the BpRuleId field if it's non-nil, zero value otherwise.

func (*CBPRule) GetBpSecondaryTechnology 

func (c *CBPRule) GetBpSecondaryTechnology() string

GetBpSecondaryTechnology returns the BpSecondaryTechnology field if it's non-nil, zero value otherwise.

func (*CBPRule) GetBpTitle 

func (c *CBPRule) GetBpTitle() string

GetBpTitle returns the BpTitle field if it's non-nil, zero value otherwise.

func (*CBPRule) GetCreateDate 

func (c *CBPRule) GetCreateDate() *DateTime

GetCreateDate returns the CreateDate field.

func (*CBPRule) GetSwType 

func (c *CBPRule) GetSwType() string

GetSwType returns the SwType field if it's non-nil, zero value otherwise.

func (*CBPRule) GetUpdateDate 

func (c *CBPRule) GetUpdateDate() *DateTime

GetUpdateDate returns the UpdateDate field.

type CBPRulesReference 

type CBPRulesReference struct {
	// The internal Config BP Rule ID from the AI-X system. Used to cross-reference with other API results.
	BpRuleId *int `json:"bpRuleId,omitempty"`

	// The Config BP reference URL.  Any rule can have 1 or more reference URLs.
	BpUrl *string `json:"bpUrl,omitempty"`

	// The Config BP reference URL Title associated with bpUrl.
	BpUrlTitle *string `json:"bpUrlTitle,omitempty"`
}

CBPRulesReferences defines model for CBPRulesReferences.

func (*CBPRulesReference) GetBpRuleId 

func (c *CBPRulesReference) GetBpRuleId() int

GetBpRuleId returns the BpRuleId field if it's non-nil, zero value otherwise.

func (*CBPRulesReference) GetBpUrl 

func (c *CBPRulesReference) GetBpUrl() string

GetBpUrl returns the BpUrl field if it's non-nil, zero value otherwise.

func (*CBPRulesReference) GetBpUrlTitle 

func (c *CBPRulesReference) GetBpUrlTitle() string

GetBpUrlTitle returns the BpUrlTitle field if it's non-nil, zero value otherwise.

type CBPSummary 

type CBPSummary struct {
	// The internal Config BP Nugget ID from the AI-X system. Used to cross-reference with other API results.
	BpNuggetId *int `json:"bpNuggetId,omitempty"`

	// The Primary Technology associated with a Config BP Rule.
	BpPrimaryTechnology *string `json:"bpPrimaryTechnology,omitempty"`

	// The Risk associated with a Config BP Rule. Valid values include: High, Medium, Low.
	BpRisk *string `json:"bpRisk,omitempty"`

	// The internal Config BP Rule ID from the AI-X system. Used to cross-reference with other API results.
	BpRuleId *int `json:"bpRuleId,omitempty"`

	// The Secondary Technologies associated with a Config BP Rule. Can be multiple values separated with commas.
	BpSecondaryTechnology *string `json:"bpSecondaryTechnology,omitempty"`

	// The Config BP exception headline / title.
	BpTitle *string `json:"bpTitle,omitempty"`

	// The Type of Software running on the NP Network Element.  Common values include IOS, IOS XR, IOS-XE, NX-OS, etc.
	SwType *string `json:"swType,omitempty"`

	// The number of unique matching devices in summary APIs.  For Custom Config and BP, this is the number of devices with exceptions.  For Feature, this is the number of devices with the feature match.  For tracks, this is the total number of devices in the track.
	TotalDevices *int `json:"totalDevices,omitempty"`
}

CBPSummary defines model for CBPSummary.

func (*CBPSummary) GetBpNuggetId 

func (c *CBPSummary) GetBpNuggetId() int

GetBpNuggetId returns the BpNuggetId field if it's non-nil, zero value otherwise.

func (*CBPSummary) GetBpPrimaryTechnology 

func (c *CBPSummary) GetBpPrimaryTechnology() string

GetBpPrimaryTechnology returns the BpPrimaryTechnology field if it's non-nil, zero value otherwise.

func (*CBPSummary) GetBpRisk 

func (c *CBPSummary) GetBpRisk() string

GetBpRisk returns the BpRisk field if it's non-nil, zero value otherwise.

func (*CBPSummary) GetBpRuleId 

func (c *CBPSummary) GetBpRuleId() int

GetBpRuleId returns the BpRuleId field if it's non-nil, zero value otherwise.

func (*CBPSummary) GetBpSecondaryTechnology 

func (c *CBPSummary) GetBpSecondaryTechnology() string

GetBpSecondaryTechnology returns the BpSecondaryTechnology field if it's non-nil, zero value otherwise.

func (*CBPSummary) GetBpTitle 

func (c *CBPSummary) GetBpTitle() string

GetBpTitle returns the BpTitle field if it's non-nil, zero value otherwise.

func (*CBPSummary) GetSwType 

func (c *CBPSummary) GetSwType() string

GetSwType returns the SwType field if it's non-nil, zero value otherwise.

func (*CBPSummary) GetTotalDevices 

func (c *CBPSummary) GetTotalDevices() int

GetTotalDevices returns the TotalDevices field if it's non-nil, zero value otherwise.

type Client 

type Client struct {
	// BaseURL for BCS API.  Set to https://demo.api.csco-bcs.com/v2 using `ciscobcs.New()`, or set directly.
	BaseURL string

	//HTTP Client to use for making requests, allowing the user to supply their own if required.
	HTTPClient *http.Client

	//CustomerID for specific customer/API Key combination.
	CustomerID string

	//API Key for Cisco BCS.
	APIKey string
	// contains filtered or unexported fields
}

func NewClient 

func NewClient(customerID, apikey string, client *http.Client) (*Client, error)

func (*Client) ListAllAssets 

func (c *Client) ListAllAssets(ctx context.Context) ([]*Asset, error)

func (*Client) ListAllCBPDetailsPerDeviceID 

func (c *Client) ListAllCBPDetailsPerDeviceID(ctx context.Context) ([]*CBPDetail, error)

func (*Client) ListAllCBPRules 

func (c *Client) ListAllCBPRules(ctx context.Context) ([]*CBPRule, error)

func (*Client) ListAllContractInformationPerSerialNumber added in v0.5.0 

func (c *Client) ListAllContractInformationPerSerialNumber(ctx context.Context) ([]*SerialNumberDetails, error)

func (*Client) ListAllDailySyslog added in v0.5.0 

func (c *Client) ListAllDailySyslog(ctx context.Context) ([]*SyslogDaily, error)

func (*Client) ListAllDevices 

func (c *Client) ListAllDevices(ctx context.Context) ([]*Device, error)

func (*Client) ListAllFieldNoticeNBulletins 

func (c *Client) ListAllFieldNoticeNBulletins(ctx context.Context) ([]*FieldNoticeNBulletin, error)

func (*Client) ListAllFieldNotices 

func (c *Client) ListAllFieldNotices(ctx context.Context) ([]*FieldNotice, error)

func (*Client) ListAllHardwareEOX 

func (c *Client) ListAllHardwareEOX(ctx context.Context) ([]*HardwareEOX, error)

func (*Client) ListAllHardwareEOXBulletins 

func (c *Client) ListAllHardwareEOXBulletins(ctx context.Context) ([]*HardwareEOXBulletin, error)

func (*Client) ListAllSecurityAdvisories 

func (c *Client) ListAllSecurityAdvisories(ctx context.Context) ([]*SecurityAdvisory, error)

func (*Client) ListAllSecurityAdvisoryBulletins 

func (c *Client) ListAllSecurityAdvisoryBulletins(ctx context.Context) ([]*SecurityAdvisoryBulletin, error)

func (*Client) ListAllSoftwareAlerts 

func (c *Client) ListAllSoftwareAlerts(ctx context.Context) ([]*SoftwareAlert, error)

func (*Client) ListAllSoftwareEOX 

func (c *Client) ListAllSoftwareEOX(ctx context.Context) ([]*SoftwareEOX, error)

func (*Client) ListAllSoftwareEOXBulletins 

func (c *Client) ListAllSoftwareEOXBulletins(ctx context.Context) ([]*SoftwareEOXBulletin, error)

func (*Client) ListAssets 

func (c *Client) ListAssets(ctx context.Context, options ...*ListOptions) (*BCSListResponse[Asset], error)

func (*Client) ListCBPDetailsPerDeviceID 

func (c *Client) ListCBPDetailsPerDeviceID(ctx context.Context, options ...*ListOptions) (*BCSListResponse[CBPDetail], error)

func (*Client) ListCBPRules 

func (c *Client) ListCBPRules(ctx context.Context, options ...*ListOptions) (*BCSListResponse[CBPRule], error)

func (*Client) ListDevices 

func (c *Client) ListDevices(ctx context.Context, options ...*ListOptions) (*BCSListResponse[Device], error)

func (*Client) ListFieldNoticeNBulletins 

func (c *Client) ListFieldNoticeNBulletins(ctx context.Context, options ...*ListOptions) (*BCSListResponse[FieldNoticeNBulletin], error)

func (*Client) ListFieldNotices 

func (c *Client) ListFieldNotices(ctx context.Context, options ...*ListOptions) (*BCSListResponse[FieldNotice], error)

func (*Client) ListHardwareEOX 

func (c *Client) ListHardwareEOX(ctx context.Context, options ...*ListOptions) (*BCSListResponse[HardwareEOX], error)

func (*Client) ListHardwareEOXBulletins 

func (c *Client) ListHardwareEOXBulletins(ctx context.Context, options ...*ListOptions) (*BCSListResponse[HardwareEOXBulletin], error)

func (*Client) ListRiskMitigationDetails added in v0.6.0 

func (c *Client) ListRiskMitigationDetails(ctx context.Context) ([]*RiskMitigationDetails, error)

func (*Client) ListRiskMitigationSummaries added in v0.6.0 

func (c *Client) ListRiskMitigationSummaries(ctx context.Context) ([]*RiskMitigationSummary, error)

func (*Client) ListSecurityAdvisories 

func (c *Client) ListSecurityAdvisories(ctx context.Context, options ...*ListOptions) (*BCSListResponse[SecurityAdvisory], error)

func (*Client) ListSecurityAdvisoryBulletins 

func (c *Client) ListSecurityAdvisoryBulletins(ctx context.Context, options ...*ListOptions) (*BCSListResponse[SecurityAdvisoryBulletin], error)

func (*Client) ListSoftwareAlerts 

func (c *Client) ListSoftwareAlerts(ctx context.Context, options ...*ListOptions) (*BCSListResponse[SoftwareAlert], error)

func (*Client) ListSoftwareEOX 

func (c *Client) ListSoftwareEOX(ctx context.Context, options ...*ListOptions) (*BCSListResponse[SoftwareEOX], error)

func (*Client) ListSoftwareEOXBulletins 

func (c *Client) ListSoftwareEOXBulletins(ctx context.Context, options ...*ListOptions) (*BCSListResponse[SoftwareEOXBulletin], error)

type ContractBasePID added in v0.5.0 

type ContractBasePID struct {
	// Base or manufacturing product identifiers related to the specified serial number.
	BasePid *string `json:"basePid,omitempty"`
}

ContractBasePID defines model for contractBasePID.

func (*ContractBasePID) GetBasePid added in v0.5.0 

func (c *ContractBasePID) GetBasePid() string

GetBasePid returns the BasePid field if it's non-nil, zero value otherwise.

type Date 

type Date struct {
	time.Time
}

Date represente a date provided in the Cisco results.

func (Date) MarshalJSON 

func (d Date) MarshalJSON() ([]byte, error)

MarshalJSON will marshal the date format provided in the Cisco results.

func (Date) String 

func (d Date) String() string

String will return the date representation in the format provided by Cisco.

func (*Date) UnmarshalJSON 

func (d *Date) UnmarshalJSON(data []byte) error

UnmarshalJSON will unmarshal the date format provided in the Cisco results.

func (*Date) Value added in v0.5.0 

func (d *Date) Value() (driver.Value, error)

Value is used by gorm to get a time.Time back instead of a Cisco Date.

type DateTime 

type DateTime struct {
	time.Time
}

DateTime represents the datetime field in the Cisco results which has no timezone information.

func (DateTime) MarshalJSON 

func (d DateTime) MarshalJSON() ([]byte, error)

MarshalJSON will marshal the datetime format provided in the Cisco results.

func (DateTime) String 

func (d DateTime) String() string

String will return the datetime representation in the format provided by Cisco.

func (*DateTime) UnmarshalJSON 

func (d *DateTime) UnmarshalJSON(data []byte) error

UnmarshalJSON will unmarshal the datetime format provided in the Cisco results.

func (*DateTime) Value 

func (d *DateTime) Value() (driver.Value, error)

Value is used by gorm to get a time.Time back instead of a Cisco DateTime.

type Device 

type Device struct {
	// Customer ID is not included in the response, but should be added to associate this device to a specific customer
	CustomerID string `gorm:"primaryKey;autoIncrement:false"`

	// The collector identifier, which can be either a 4 character collectorid or the applianceid.
	Collector *string `json:"collector,omitempty" gorm:"size:255"`

	// The Configuration register of the device.
	ConfigRegister *string `json:"configRegister,omitempty" gorm:"size:255"`

	// The status of Configuration collection.  Completed means the config was successfully collected.  NotAvailable means the config was not collected.  NotSupported means the device does not support collection of an ASCii config via CLI.
	ConfigStatus *string `json:"configStatus,omitempty" gorm:"size:255"`

	// The time when the collector last successfully collected the configuration from the device.
	ConfigTime *DateTime `json:"configTime,omitempty"`

	// The date the record or rule was created in NP database.  For devices, a new record is created whenever a unique name+sysobjectid combination is seen in the collector.
	CreateDate *DateTime `json:"createDate,omitempty"`

	// The unique ID of the NP NetworkElement/Device.
	DeviceId *int `json:"deviceId,omitempty" gorm:"primaryKey;autoIncrement:false"`

	// The management IP address of the device.
	DeviceIp *string `json:"deviceIp,omitempty" gorm:"size:255"`

	// The Network Element Name of the device.  When used as input, it can include % as wildcard.
	DeviceName *string `json:"deviceName,omitempty" gorm:"size:255"`

	// The status of the device as reported by the collector.  Usually will be either ACTIVE or DEVICE NOT REACHABLE.
	DeviceStatus *string `json:"deviceStatus,omitempty" gorm:"size:255"`

	// The hostname (SNMP sysName) of the device.  It will be fully-qualified name, if domain name is set on the device.
	DeviceSysName *string `json:"deviceSysName,omitempty" gorm:"size:255"`

	// The type of the device.  Values include Managed Chassis, Managed Multi-Chassis, SDR, Contexts, and IOS-XR Admin
	DeviceType *string `json:"deviceType,omitempty" gorm:"size:255"`

	// The name of the software feature set running on the device.  This data is primarily available for IOS.
	FeatureSetdesc *string `json:"featureSetdesc,omitempty" gorm:"size:4000"`

	// The Image Name of the software on the Network Element.
	ImageName *string `json:"imageName,omitempty" gorm:"size:255"`

	// Indicates whether the device is in a collector seedfile (true) or has been logically created by NP (false).  This is important for some KPI measurements to be accurate.
	InSeedFile *bool `json:"inSeedFile,omitempty"`

	// The status of Inventory collection.  Completed means some SNMP inventory was successfully collected.  NotAvailable means SNMP inventory was not collected.  NotSupported means the device was not in CSPC to be collected.
	InventoryStatus *string `json:"inventoryStatus,omitempty" gorm:"size:255"`

	// The time when the collector last successfully collected inventory from the device.
	InventoryTime *DateTime `json:"inventoryTime,omitempty"`

	// An IPv4 Address.
	IpAddress *string `json:"ipAddress,omitempty" gorm:"size:255"`

	// The date timestamp of the last reset of the device as reported by the show version command.
	LastReset *DateTime `json:"lastReset,omitempty"`

	// The Cisco Product Family of the hardware.  Values come from MDF for Chassis.
	ProductFamily *string `json:"productFamily,omitempty" gorm:"size:4000"`

	// The Cisco Product ID (PID) of the hardware.
	ProductId *string `json:"productId,omitempty" gorm:"size:32000"`

	// The Cisco Product Type in COLD of the hardware.  Values usually come from MDF.
	ProductType *string `json:"productType,omitempty" gorm:"size:255"`

	// The reason for the last system reset as reported in the show version output.
	ResetReason *string `json:"resetReason,omitempty" gorm:"size:255"`

	// The Type of Software running on the NP Network Element.  Common values include IOS, IOS XR, IOS-XE, NX-OS, etc.
	SwType *string `json:"swType,omitempty" gorm:"size:255"`

	// The Software Version of the device.
	SwVersion *string `json:"swVersion,omitempty" gorm:"size:255"`

	// The SNMP sysContact of the device which is populated in most devices using a configuration command.
	SysContact *string `json:"sysContact,omitempty" gorm:"size:4000"`

	// The SNMP system description from the device.
	SysDescription *string `json:"sysDescription,omitempty" gorm:"size:32000"`

	// The SNMP sysLocation of the device which is populated in most devices using a configuration command.
	SysLocation *string `json:"sysLocation,omitempty" gorm:"size:255"`

	// The SNMP sysObjectID of the device.
	SysObjectId *string `json:"sysObjectId,omitempty" gorm:"size:255"`

	// The user field1 value populated in the collector seedfile.
	UserField1 *string `json:"userField1,omitempty" gorm:"size:4000"`

	// The user field2 value populated in the collector seedfile.
	UserField2 *string `json:"userField2,omitempty" gorm:"size:4000"`

	// The user field3 value populated in the collector seedfile.
	UserField3 *string `json:"userField3,omitempty" gorm:"size:4000"`

	// The user field4 value populated in the collector seedfile.
	UserField4 *string `json:"userField4,omitempty" gorm:"size:4000"`
}

Device defines model for Device.

func (*Device) GetCollector 

func (d *Device) GetCollector() string

GetCollector returns the Collector field if it's non-nil, zero value otherwise.

func (*Device) GetConfigRegister 

func (d *Device) GetConfigRegister() string

GetConfigRegister returns the ConfigRegister field if it's non-nil, zero value otherwise.

func (*Device) GetConfigStatus 

func (d *Device) GetConfigStatus() string

GetConfigStatus returns the ConfigStatus field if it's non-nil, zero value otherwise.

func (*Device) GetConfigTime 

func (d *Device) GetConfigTime() *DateTime

GetConfigTime returns the ConfigTime field.

func (*Device) GetCreateDate 

func (d *Device) GetCreateDate() *DateTime

GetCreateDate returns the CreateDate field.

func (*Device) GetDeviceId 

func (d *Device) GetDeviceId() int

GetDeviceId returns the DeviceId field if it's non-nil, zero value otherwise.

func (*Device) GetDeviceIp 

func (d *Device) GetDeviceIp() string

GetDeviceIp returns the DeviceIp field if it's non-nil, zero value otherwise.

func (*Device) GetDeviceName 

func (d *Device) GetDeviceName() string

GetDeviceName returns the DeviceName field if it's non-nil, zero value otherwise.

func (*Device) GetDeviceStatus 

func (d *Device) GetDeviceStatus() string

GetDeviceStatus returns the DeviceStatus field if it's non-nil, zero value otherwise.

func (*Device) GetDeviceSysName 

func (d *Device) GetDeviceSysName() string

GetDeviceSysName returns the DeviceSysName field if it's non-nil, zero value otherwise.

func (*Device) GetDeviceType 

func (d *Device) GetDeviceType() string

GetDeviceType returns the DeviceType field if it's non-nil, zero value otherwise.

func (*Device) GetFeatureSetdesc 

func (d *Device) GetFeatureSetdesc() string

GetFeatureSetdesc returns the FeatureSetdesc field if it's non-nil, zero value otherwise.

func (*Device) GetImageName 

func (d *Device) GetImageName() string

GetImageName returns the ImageName field if it's non-nil, zero value otherwise.

func (*Device) GetInSeedFile 

func (d *Device) GetInSeedFile() bool

GetInSeedFile returns the InSeedFile field if it's non-nil, zero value otherwise.

func (*Device) GetInventoryStatus 

func (d *Device) GetInventoryStatus() string

GetInventoryStatus returns the InventoryStatus field if it's non-nil, zero value otherwise.

func (*Device) GetInventoryTime 

func (d *Device) GetInventoryTime() *DateTime

GetInventoryTime returns the InventoryTime field.

func (*Device) GetIpAddress 

func (d *Device) GetIpAddress() string

GetIpAddress returns the IpAddress field if it's non-nil, zero value otherwise.

func (*Device) GetLastReset 

func (d *Device) GetLastReset() *DateTime

GetLastReset returns the LastReset field.

func (*Device) GetProductFamily 

func (d *Device) GetProductFamily() string

GetProductFamily returns the ProductFamily field if it's non-nil, zero value otherwise.

func (*Device) GetProductId 

func (d *Device) GetProductId() string

GetProductId returns the ProductId field if it's non-nil, zero value otherwise.

func (*Device) GetProductType 

func (d *Device) GetProductType() string

GetProductType returns the ProductType field if it's non-nil, zero value otherwise.

func (*Device) GetResetReason 

func (d *Device) GetResetReason() string

GetResetReason returns the ResetReason field if it's non-nil, zero value otherwise.

func (*Device) GetSwType 

func (d *Device) GetSwType() string

GetSwType returns the SwType field if it's non-nil, zero value otherwise.

func (*Device) GetSwVersion 

func (d *Device) GetSwVersion() string

GetSwVersion returns the SwVersion field if it's non-nil, zero value otherwise.

func (*Device) GetSysContact 

func (d *Device) GetSysContact() string

GetSysContact returns the SysContact field if it's non-nil, zero value otherwise.

func (*Device) GetSysDescription 

func (d *Device) GetSysDescription() string

GetSysDescription returns the SysDescription field if it's non-nil, zero value otherwise.

func (*Device) GetSysLocation 

func (d *Device) GetSysLocation() string

GetSysLocation returns the SysLocation field if it's non-nil, zero value otherwise.

func (*Device) GetSysObjectId 

func (d *Device) GetSysObjectId() string

GetSysObjectId returns the SysObjectId field if it's non-nil, zero value otherwise.

func (*Device) GetUserField1 

func (d *Device) GetUserField1() string

GetUserField1 returns the UserField1 field if it's non-nil, zero value otherwise.

func (*Device) GetUserField2 

func (d *Device) GetUserField2() string

GetUserField2 returns the UserField2 field if it's non-nil, zero value otherwise.

func (*Device) GetUserField3 

func (d *Device) GetUserField3() string

GetUserField3 returns the UserField3 field if it's non-nil, zero value otherwise.

func (*Device) GetUserField4 

func (d *Device) GetUserField4() string

GetUserField4 returns the UserField4 field if it's non-nil, zero value otherwise.

type Err 

type Err string

Err implements the error interface so we can have constant errors.

func (Err) Error 

func (e Err) Error() string

type FieldNotice 

type FieldNotice struct {
	// The unique ID of the NP NetworkElement/Device.
	DeviceId *int `json:"deviceId,omitempty" `

	// Field Notice ID number.
	FieldNoticeId *string `json:"fieldNoticeId,omitempty" gorm:"primaryKey;autoIncrement:false"`

	// The match confidence result from PAS.  Valid values include: Vulnerable, Potentially Vulnerable, Not Vulnerable.
	MatchConfidence *string `json:"matchConfidence,omitempty"`

	// The reason behind the match confidence result from PAS. Explains why you are vulnerable or not vulnerable or what data is missing to cause a potentially vulnerable result.  PAS value is enhanced in NP for readability.
	MatchConfidenceReason *string `json:"matchConfidenceReason,omitempty"`

	// The unique ID in NP for a specific piece of hardware.
	PhysicalElementId *int `json:"physicalElementId,omitempty" gorm:"primaryKey;autoIncrement:false"`
}

FieldNotice defines model for fieldNotices.

func (*FieldNotice) GetDeviceId 

func (f *FieldNotice) GetDeviceId() int

GetDeviceId returns the DeviceId field if it's non-nil, zero value otherwise.

func (*FieldNotice) GetFieldNoticeId 

func (f *FieldNotice) GetFieldNoticeId() string

GetFieldNoticeId returns the FieldNoticeId field if it's non-nil, zero value otherwise.

func (*FieldNotice) GetMatchConfidence 

func (f *FieldNotice) GetMatchConfidence() string

GetMatchConfidence returns the MatchConfidence field if it's non-nil, zero value otherwise.

func (*FieldNotice) GetMatchConfidenceReason 

func (f *FieldNotice) GetMatchConfidenceReason() string

GetMatchConfidenceReason returns the MatchConfidenceReason field if it's non-nil, zero value otherwise.

func (*FieldNotice) GetPhysicalElementId 

func (f *FieldNotice) GetPhysicalElementId() int

GetPhysicalElementId returns the PhysicalElementId field if it's non-nil, zero value otherwise.

type FieldNoticeNBulletin 

type FieldNoticeNBulletin struct {
	// The date when the bulletin was first published to Cisco.com.  Most API calls will allow Regex input for this field.
	BulletinFirstPublished *string `json:"bulletinFirstPublished,omitempty"`

	// The date when the bulletin was last updated on Cisco.com.
	BulletinLastUpdated *DateTime `json:"bulletinLastUpdated,omitempty"`

	// The Bulletin Mapping Caveat gives any explanations why the automation may need additional review by the customer.
	BulletinMappingCaveat *string `json:"bulletinMappingCaveat,omitempty"`

	// The Cisco.com Title/Headline for the bulletin.
	BulletinTitle *string `json:"bulletinTitle,omitempty"`

	// The Cisco.com URL for the bulletin.
	BulletinUrl *string `json:"bulletinUrl,omitempty"`

	// Field Notice ID number.
	FieldNoticeId *string `json:"fieldNoticeId,omitempty" gorm:"primaryKey;autoIncrement:false"`

	// Type of Field Notice as defined from PLATO.  Valid values include: hardware, software, other
	FnType *string `json:"fnType,omitempty"`

	// The description of the problem on a Cisco bulletin.
	ProblemDescription *string `json:"problemDescription,omitempty"`
}

FieldNoticeBulletin defines model for FNBulletins.

func (*FieldNoticeNBulletin) GetBulletinFirstPublished 

func (f *FieldNoticeNBulletin) GetBulletinFirstPublished() string

GetBulletinFirstPublished returns the BulletinFirstPublished field if it's non-nil, zero value otherwise.

func (*FieldNoticeNBulletin) GetBulletinLastUpdated 

func (f *FieldNoticeNBulletin) GetBulletinLastUpdated() *DateTime

GetBulletinLastUpdated returns the BulletinLastUpdated field.

func (*FieldNoticeNBulletin) GetBulletinMappingCaveat 

func (f *FieldNoticeNBulletin) GetBulletinMappingCaveat() string

GetBulletinMappingCaveat returns the BulletinMappingCaveat field if it's non-nil, zero value otherwise.

func (*FieldNoticeNBulletin) GetBulletinTitle 

func (f *FieldNoticeNBulletin) GetBulletinTitle() string

GetBulletinTitle returns the BulletinTitle field if it's non-nil, zero value otherwise.

func (*FieldNoticeNBulletin) GetBulletinUrl 

func (f *FieldNoticeNBulletin) GetBulletinUrl() string

GetBulletinUrl returns the BulletinUrl field if it's non-nil, zero value otherwise.

func (*FieldNoticeNBulletin) GetFieldNoticeId 

func (f *FieldNoticeNBulletin) GetFieldNoticeId() string

GetFieldNoticeId returns the FieldNoticeId field if it's non-nil, zero value otherwise.

func (*FieldNoticeNBulletin) GetFnType 

func (f *FieldNoticeNBulletin) GetFnType() string

GetFnType returns the FnType field if it's non-nil, zero value otherwise.

func (*FieldNoticeNBulletin) GetProblemDescription 

func (f *FieldNoticeNBulletin) GetProblemDescription() string

GetProblemDescription returns the ProblemDescription field if it's non-nil, zero value otherwise.

type HardwareEOX 

type HardwareEOX struct {
	// The current end-of-life milestone as calculated during last NP profile. If more than one milestone falls on the same date, the returned value will be a comma-separated list.
	CurrentEoxMilestone *string `json:"currentEoxMilestone,omitempty"`

	// The date associated with the current end-of-life milestone.
	CurrentEoxMilestoneDate *DateTime `json:"currentEoxMilestoneDate,omitempty"`

	// The unique ID of the NP NetworkElement/Device.
	DeviceId *int `json:"deviceId,omitempty"`

	// The Network Element Name of the device. When used as input, it can include % as wildcard.
	DeviceName *string `json:"deviceName,omitempty"`

	// Internal hardware end-of-life identifier to allow join with master hw_eox_bulletins API.
	HwEoxId *int `json:"hwEoxId,omitempty" gorm:"primaryKey;autoIncrement:false"`

	// The next end-of-life milestone that is coming up as calculated during last NP profile.  If more than one milestone falls on the same date, the returned value will be a comma-separated list.  If the device is already LDoS it will not have an next milestone.
	NextEoxMilestone *string `json:"nextEoxMilestone,omitempty"`

	// The date associated with the next end-of-life milestone.
	NextEoxMilestoneDate *DateTime `json:"nextEoxMilestoneDate,omitempty"`

	// The unique ID in NP for a specific piece of hardware.
	PhysicalElementId *int `json:"physicalElementId,omitempty" gorm:"primaryKey;autoIncrement:false"`

	// The physical type of the hardware.  Valid values are: Chassis, Module, Power Supply, Fan.
	PhysicalType *string `json:"physicalType,omitempty"`

	// The Cisco Product ID (PID) of the hardware.
	ProductId *string `json:"productId,omitempty"`
}

HardwareEOX defines model for HWEOX.

func (*HardwareEOX) GetCurrentEoxMilestone 

func (h *HardwareEOX) GetCurrentEoxMilestone() string

GetCurrentEoxMilestone returns the CurrentEoxMilestone field if it's non-nil, zero value otherwise.

func (*HardwareEOX) GetCurrentEoxMilestoneDate 

func (h *HardwareEOX) GetCurrentEoxMilestoneDate() *DateTime

GetCurrentEoxMilestoneDate returns the CurrentEoxMilestoneDate field.

func (*HardwareEOX) GetDeviceId 

func (h *HardwareEOX) GetDeviceId() int

GetDeviceId returns the DeviceId field if it's non-nil, zero value otherwise.

func (*HardwareEOX) GetDeviceName 

func (h *HardwareEOX) GetDeviceName() string

GetDeviceName returns the DeviceName field if it's non-nil, zero value otherwise.

func (*HardwareEOX) GetHwEoxId 

func (h *HardwareEOX) GetHwEoxId() int

GetHwEoxId returns the HwEoxId field if it's non-nil, zero value otherwise.

func (*HardwareEOX) GetNextEoxMilestone 

func (h *HardwareEOX) GetNextEoxMilestone() string

GetNextEoxMilestone returns the NextEoxMilestone field if it's non-nil, zero value otherwise.

func (*HardwareEOX) GetNextEoxMilestoneDate 

func (h *HardwareEOX) GetNextEoxMilestoneDate() *DateTime

GetNextEoxMilestoneDate returns the NextEoxMilestoneDate field.

func (*HardwareEOX) GetPhysicalElementId 

func (h *HardwareEOX) GetPhysicalElementId() int

GetPhysicalElementId returns the PhysicalElementId field if it's non-nil, zero value otherwise.

func (*HardwareEOX) GetPhysicalType 

func (h *HardwareEOX) GetPhysicalType() string

GetPhysicalType returns the PhysicalType field if it's non-nil, zero value otherwise.

func (*HardwareEOX) GetProductId 

func (h *HardwareEOX) GetProductId() string

GetProductId returns the ProductId field if it's non-nil, zero value otherwise.

type HardwareEOXBulletin 

type HardwareEOXBulletin struct {
	// The Cisco.com bulletin number for an End-of-Life bulletin or Field Notice.
	BulletinNumber *string `json:"bulletinNumber,omitempty"`

	// The Cisco.com Title/Headline for the bulletin.
	BulletinTitle *string `json:"bulletinTitle,omitempty"`

	// The Cisco.com URL for the bulletin.
	BulletinUrl *string `json:"bulletinUrl,omitempty"`

	// The End-of-Life Announcement (Announced) Date.
	EoLifeAnnouncementDate *DateTime `json:"eoLifeAnnouncementDate,omitempty"`

	// The End of New Service Attachment Date.
	EoNewServiceAttachDate *DateTime `json:"eoNewServiceAttachDate,omitempty"`

	// The End of Routine Failure Analysis Date (EoRFA) Date.
	EoRoutineFailureAnalysisDate *DateTime `json:"eoRoutineFailureAnalysisDate,omitempty"`

	// The End-of-Sale (EoSale) Date.
	EoSaleDate *DateTime `json:"eoSaleDate,omitempty"`

	// The End of Vulnerability/Security Support (EoVSS) Date.
	EoSecurityVulSupportDate *DateTime `json:"eoSecurityVulSupportDate,omitempty"`

	// The End of Service Contract Renewal (EoSCR) Date.
	EoSoftwareContractRenewalDate *DateTime `json:"eoSoftwareContractRenewalDate,omitempty"`

	// The End of SW Maintenance Releases (EoSWM) Date.
	EoSwMaintenanceReleasesDate *DateTime `json:"eoSwMaintenanceReleasesDate,omitempty"`

	// Internal hardware end-of-life identifier to allow join with master hw_eox_bulletins API.
	HwEoxId *int `json:"hwEoxId,omitempty" gorm:"primaryKey;autoIncrement:false"`

	// The Last Date of Support (LDoS).
	LastDateOfSupport *DateTime `json:"lastDateOfSupport,omitempty"`

	// The Last Ship Date.
	LastShipDate *DateTime `json:"lastShipDate,omitempty"`

	// The Cisco Product ID (PID) of the hardware.
	ProductId *string `json:"productId,omitempty"`
}

HardwareEOXBulletin defines model for HWEOXBulletins.

func (*HardwareEOXBulletin) GetBulletinNumber 

func (h *HardwareEOXBulletin) GetBulletinNumber() string

GetBulletinNumber returns the BulletinNumber field if it's non-nil, zero value otherwise.

func (*HardwareEOXBulletin) GetBulletinTitle 

func (h *HardwareEOXBulletin) GetBulletinTitle() string

GetBulletinTitle returns the BulletinTitle field if it's non-nil, zero value otherwise.

func (*HardwareEOXBulletin) GetBulletinUrl 

func (h *HardwareEOXBulletin) GetBulletinUrl() string

GetBulletinUrl returns the BulletinUrl field if it's non-nil, zero value otherwise.

func (*HardwareEOXBulletin) GetEoLifeAnnouncementDate 

func (h *HardwareEOXBulletin) GetEoLifeAnnouncementDate() *DateTime

GetEoLifeAnnouncementDate returns the EoLifeAnnouncementDate field.

func (*HardwareEOXBulletin) GetEoNewServiceAttachDate 

func (h *HardwareEOXBulletin) GetEoNewServiceAttachDate() *DateTime

GetEoNewServiceAttachDate returns the EoNewServiceAttachDate field.

func (*HardwareEOXBulletin) GetEoRoutineFailureAnalysisDate 

func (h *HardwareEOXBulletin) GetEoRoutineFailureAnalysisDate() *DateTime

GetEoRoutineFailureAnalysisDate returns the EoRoutineFailureAnalysisDate field.

func (*HardwareEOXBulletin) GetEoSaleDate 

func (h *HardwareEOXBulletin) GetEoSaleDate() *DateTime

GetEoSaleDate returns the EoSaleDate field.

func (*HardwareEOXBulletin) GetEoSecurityVulSupportDate 

func (h *HardwareEOXBulletin) GetEoSecurityVulSupportDate() *DateTime

GetEoSecurityVulSupportDate returns the EoSecurityVulSupportDate field.

func (*HardwareEOXBulletin) GetEoSoftwareContractRenewalDate 

func (h *HardwareEOXBulletin) GetEoSoftwareContractRenewalDate() *DateTime

GetEoSoftwareContractRenewalDate returns the EoSoftwareContractRenewalDate field.

func (*HardwareEOXBulletin) GetEoSwMaintenanceReleasesDate 

func (h *HardwareEOXBulletin) GetEoSwMaintenanceReleasesDate() *DateTime

GetEoSwMaintenanceReleasesDate returns the EoSwMaintenanceReleasesDate field.

func (*HardwareEOXBulletin) GetHwEoxId 

func (h *HardwareEOXBulletin) GetHwEoxId() int

GetHwEoxId returns the HwEoxId field if it's non-nil, zero value otherwise.

func (*HardwareEOXBulletin) GetLastDateOfSupport 

func (h *HardwareEOXBulletin) GetLastDateOfSupport() *DateTime

GetLastDateOfSupport returns the LastDateOfSupport field.

func (*HardwareEOXBulletin) GetLastShipDate 

func (h *HardwareEOXBulletin) GetLastShipDate() *DateTime

GetLastShipDate returns the LastShipDate field.

func (*HardwareEOXBulletin) GetProductId 

func (h *HardwareEOXBulletin) GetProductId() string

GetProductId returns the ProductId field if it's non-nil, zero value otherwise.

type ListOptions 

type ListOptions struct {
	// Query filter in JSON to search for specific fields. <br/>Example: {"physicaltype":"Module"}
	Filter *string `url:"filter,omitempty"`
	// Mask filter to lower the amount of fields returned, comma separated values, nested field between brackets. Example: items{physicaltype,currenteoxmilestone,currenteoxmilestonedate,productid}}
	Mask *string `url:"mask,omitempty"`
	// Page Number
	Page *int `url:"page,omitempty"`
	// Results Per Page
	PerPage *int `url:"perPage,omitempty"`
}

ListOptions specifies the optional parameters to various List methods that support offset pagination and other features.

func (*ListOptions) GetFilter 

func (l *ListOptions) GetFilter() string

GetFilter returns the Filter field if it's non-nil, zero value otherwise.

func (*ListOptions) GetMask 

func (l *ListOptions) GetMask() string

GetMask returns the Mask field if it's non-nil, zero value otherwise.

func (*ListOptions) GetPage 

func (l *ListOptions) GetPage() int

GetPage returns the Page field if it's non-nil, zero value otherwise.

func (*ListOptions) GetPerPage 

func (l *ListOptions) GetPerPage() int

GetPerPage returns the PerPage field if it's non-nil, zero value otherwise.

type OrderablePid added in v0.5.0 

type OrderablePid struct {
	// Orderable product description for the specified serial number
	ItemDescription *string `json:"itemDescription,omitempty"`

	// Orderable product position for the specified serial number
	ItemPosition *string `json:"itemPosition,omitempty"`

	// Orderable product type for the specified serial number
	ItemType *string `json:"itemType,omitempty"`

	// Orderable product identifiers for the specified serial number
	OrderablePid *string `json:"orderablePid,omitempty"`

	// Orderable product identifiers for the specified serial number
	PillarCode *string `json:"pillarCode,omitempty"`
}

OrderablePid defines model for orderablePid.

func (*OrderablePid) GetItemDescription added in v0.5.0 

func (o *OrderablePid) GetItemDescription() string

GetItemDescription returns the ItemDescription field if it's non-nil, zero value otherwise.

func (*OrderablePid) GetItemPosition added in v0.5.0 

func (o *OrderablePid) GetItemPosition() string

GetItemPosition returns the ItemPosition field if it's non-nil, zero value otherwise.

func (*OrderablePid) GetItemType added in v0.5.0 

func (o *OrderablePid) GetItemType() string

GetItemType returns the ItemType field if it's non-nil, zero value otherwise.

func (*OrderablePid) GetOrderablePid added in v0.5.0 

func (o *OrderablePid) GetOrderablePid() string

GetOrderablePid returns the OrderablePid field if it's non-nil, zero value otherwise.

func (*OrderablePid) GetPillarCode added in v0.5.0 

func (o *OrderablePid) GetPillarCode() string

GetPillarCode returns the PillarCode field if it's non-nil, zero value otherwise.

type RiskMitigationDetails added in v0.6.0 

type RiskMitigationDetails struct {
	// Customer ID is not included in the response, but should be added to associate this contract to a specific customer
	CustomerID string `gorm:"primaryKey;autoIncrement:false"`

	// The unique ID of the NP NetworkElement/Device.
	DeviceId *int `json:"deviceId,omitempty" gorm:"primaryKey;autoIncrement:false"`

	// The management IP address of the device.
	DeviceIp *string `json:"deviceIp,omitempty" gorm:"size:255"`

	// The Network Element Name of the device. When used as input, it can include % as wildcard.
	DeviceName *string `json:"deviceName,omitempty" gorm:"size:255"`

	// The Cisco Product Family of the hardware.  Values come from MDF for Chassis.
	ProductFamily *string `json:"productFamily,omitempty" gorm:"size:4000"`

	// The Cisco Product ID (PID) of the hardware.
	ProductId *string `json:"productId,omitempty" gorm:"size:32000"`

	// Severity of risk
	RiskCategory *string `json:"riskCategory,omitempty" gorm:"size:255"`

	// Risk score
	RiskScore *float32 `json:"riskScore,omitempty"`

	// The Type of Software running on the NP Network Element.  Common values include IOS, IOS XR, IOS-XE, NX-OS, etc.
	SwType *string `json:"swType,omitempty" gorm:"size:255"`

	// The Software Version of the device.
	SwVersion *string `json:"swVersion,omitempty" gorm:"size:255"`
}

RiskMitigationDetails defines model for riskMitigationDetails.

func (*RiskMitigationDetails) GetDeviceId added in v0.6.0 

func (r *RiskMitigationDetails) GetDeviceId() int

GetDeviceId returns the DeviceId field if it's non-nil, zero value otherwise.

func (*RiskMitigationDetails) GetDeviceIp added in v0.6.0 

func (r *RiskMitigationDetails) GetDeviceIp() string

GetDeviceIp returns the DeviceIp field if it's non-nil, zero value otherwise.

func (*RiskMitigationDetails) GetDeviceName added in v0.6.0 

func (r *RiskMitigationDetails) GetDeviceName() string

GetDeviceName returns the DeviceName field if it's non-nil, zero value otherwise.

func (*RiskMitigationDetails) GetProductFamily added in v0.6.0 

func (r *RiskMitigationDetails) GetProductFamily() string

GetProductFamily returns the ProductFamily field if it's non-nil, zero value otherwise.

func (*RiskMitigationDetails) GetProductId added in v0.6.0 

func (r *RiskMitigationDetails) GetProductId() string

GetProductId returns the ProductId field if it's non-nil, zero value otherwise.

func (*RiskMitigationDetails) GetRiskCategory added in v0.6.0 

func (r *RiskMitigationDetails) GetRiskCategory() string

GetRiskCategory returns the RiskCategory field if it's non-nil, zero value otherwise.

func (*RiskMitigationDetails) GetRiskScore added in v0.6.0 

func (r *RiskMitigationDetails) GetRiskScore() float32

GetRiskScore returns the RiskScore field if it's non-nil, zero value otherwise.

func (*RiskMitigationDetails) GetSwType added in v0.6.0 

func (r *RiskMitigationDetails) GetSwType() string

GetSwType returns the SwType field if it's non-nil, zero value otherwise.

func (*RiskMitigationDetails) GetSwVersion added in v0.6.0 

func (r *RiskMitigationDetails) GetSwVersion() string

GetSwVersion returns the SwVersion field if it's non-nil, zero value otherwise.

type RiskMitigationSummary added in v0.6.0 

type RiskMitigationSummary struct {
	// Customer ID is not included in the response, but should be added to associate this contract to a specific customer
	CustomerID string `gorm:"primaryKey;autoIncrement:false"`

	// Amount of devices marked as in high risk of crash
	HighRiskDeviceCount *int `json:"highRiskDeviceCount,omitempty"`

	// Amount of devices marked as in low risk of crash
	LowRiskDeviceCount *int `json:"lowRiskDeviceCount,omitempty"`

	// Amount of devices marked as in mediumrisk of crash
	MediumRiskDeviceCount *int `json:"mediumRiskDeviceCount,omitempty"`

	// The Cisco Product Family of the hardware.  Values come from MDF for Chassis.
	ProductFamily *string `json:"productFamily,omitempty" gorm:"primaryKey;autoIncrement:false;size:4000"`
}

RiskMitigationSummary defines model for riskMitigationSummary.

func (*RiskMitigationSummary) GetHighRiskDeviceCount added in v0.6.0 

func (r *RiskMitigationSummary) GetHighRiskDeviceCount() int

GetHighRiskDeviceCount returns the HighRiskDeviceCount field if it's non-nil, zero value otherwise.

func (*RiskMitigationSummary) GetLowRiskDeviceCount added in v0.6.0 

func (r *RiskMitigationSummary) GetLowRiskDeviceCount() int

GetLowRiskDeviceCount returns the LowRiskDeviceCount field if it's non-nil, zero value otherwise.

func (*RiskMitigationSummary) GetMediumRiskDeviceCount added in v0.6.0 

func (r *RiskMitigationSummary) GetMediumRiskDeviceCount() int

GetMediumRiskDeviceCount returns the MediumRiskDeviceCount field if it's non-nil, zero value otherwise.

func (*RiskMitigationSummary) GetProductFamily added in v0.6.0 

func (r *RiskMitigationSummary) GetProductFamily() string

GetProductFamily returns the ProductFamily field if it's non-nil, zero value otherwise.

type SecurityAdvisory 

type SecurityAdvisory struct {
	// The unique ID of the NP NetworkElement/Device.
	DeviceId *int `json:"deviceId,omitempty" gorm:"primaryKey;autoIncrement:false"`

	// The match confidence result from PAS.  Valid values include: Vulnerable, Potentially Vulnerable, Not Vulnerable.
	MatchConfidence *string `json:"matchConfidence,omitempty"`

	// The reason behind the match confidence result from PAS. Explains why you are vulnerable or not vulnerable or what data is missing to cause a potentially vulnerable result.  PAS value is enhanced in NP for readability.
	MatchConfidenceReason *string `json:"matchConfidenceReason,omitempty"`

	// The internal COLD ID for a PSIRT. This is useful for joining multiple data sources.
	PsirtColdId *int `json:"psirtColdId,omitempty" gorm:"primaryKey;autoIncrement:false"`
}

SecurityAdvisory defines model for securityAdvisories.

func (*SecurityAdvisory) GetDeviceId 

func (s *SecurityAdvisory) GetDeviceId() int

GetDeviceId returns the DeviceId field if it's non-nil, zero value otherwise.

func (*SecurityAdvisory) GetMatchConfidence 

func (s *SecurityAdvisory) GetMatchConfidence() string

GetMatchConfidence returns the MatchConfidence field if it's non-nil, zero value otherwise.

func (*SecurityAdvisory) GetMatchConfidenceReason 

func (s *SecurityAdvisory) GetMatchConfidenceReason() string

GetMatchConfidenceReason returns the MatchConfidenceReason field if it's non-nil, zero value otherwise.

func (*SecurityAdvisory) GetPsirtColdId 

func (s *SecurityAdvisory) GetPsirtColdId() int

GetPsirtColdId returns the PsirtColdId field if it's non-nil, zero value otherwise.

type SecurityAdvisoryBulletin 

type SecurityAdvisoryBulletin struct {
	// The date when the bulletin was first published to Cisco.com.  Most API calls will allow Regex input for this field.
	BulletinFirstPublished *string `json:"bulletinFirstPublished,omitempty"`

	// The date when the bulletin was last updated on Cisco.com.
	BulletinLastUpdated *DateTime `json:"bulletinLastUpdated,omitempty"`

	// The Bulletin Mapping Caveat gives any explanations why the automation may need additional review by the customer.
	BulletinMappingCaveat *string `json:"bulletinMappingCaveat,omitempty"`

	// The Summary of a Cisco.com bulletin.
	BulletinSummary *string `json:"bulletinSummary,omitempty"`

	// The Cisco.com Title/Headline for the bulletin.
	BulletinTitle *string `json:"bulletinTitle,omitempty"`

	// The Cisco.com URL for the bulletin.
	BulletinUrl *string `json:"bulletinUrl,omitempty"`

	// The version # of the Cisco.com bulletin.
	BulletinVersion *string `json:"bulletinVersion,omitempty"`

	// Comma-separated list of Cisco Bug IDs.
	CiscoBugIds *string `json:"ciscoBugIds,omitempty"`

	// Common Vulnerabilities and Exposures (CVE) Identifier
	CveId *string `json:"cveId,omitempty"`

	// Common Vulnerability Scoring System (CVSS) Base Score
	CvssBase *string `json:"cvssBase,omitempty"`

	// Common Vulnerability Scoring System (CVSS) Temporal Score
	CvssTemporal *string `json:"cvssTemporal,omitempty"`

	// The Advisory ID of a PSIRT as seen on Cisco.com.
	PsirtAdvisoryId *string `json:"psirtAdvisoryId,omitempty"`

	// The internal COLD ID for a PSIRT.  This is useful for joining multiple data sources.
	PsirtColdId *int `json:"psirtColdId,omitempty" gorm:"primaryKey;autoIncrement:false"`

	// The Security Impact Rating (SIR) for Cisco PSIRTs.
	Sir *string `json:"sir,omitempty"`
}

SecurityAdvisoryBulletin defines model for PSIRTBulletins.

func (*SecurityAdvisoryBulletin) GetBulletinFirstPublished 

func (s *SecurityAdvisoryBulletin) GetBulletinFirstPublished() string

GetBulletinFirstPublished returns the BulletinFirstPublished field if it's non-nil, zero value otherwise.

func (*SecurityAdvisoryBulletin) GetBulletinLastUpdated 

func (s *SecurityAdvisoryBulletin) GetBulletinLastUpdated() *DateTime

GetBulletinLastUpdated returns the BulletinLastUpdated field.

func (*SecurityAdvisoryBulletin) GetBulletinMappingCaveat 

func (s *SecurityAdvisoryBulletin) GetBulletinMappingCaveat() string

GetBulletinMappingCaveat returns the BulletinMappingCaveat field if it's non-nil, zero value otherwise.

func (*SecurityAdvisoryBulletin) GetBulletinSummary 

func (s *SecurityAdvisoryBulletin) GetBulletinSummary() string

GetBulletinSummary returns the BulletinSummary field if it's non-nil, zero value otherwise.

func (*SecurityAdvisoryBulletin) GetBulletinTitle 

func (s *SecurityAdvisoryBulletin) GetBulletinTitle() string

GetBulletinTitle returns the BulletinTitle field if it's non-nil, zero value otherwise.

func (*SecurityAdvisoryBulletin) GetBulletinUrl 

func (s *SecurityAdvisoryBulletin) GetBulletinUrl() string

GetBulletinUrl returns the BulletinUrl field if it's non-nil, zero value otherwise.

func (*SecurityAdvisoryBulletin) GetBulletinVersion 

func (s *SecurityAdvisoryBulletin) GetBulletinVersion() string

GetBulletinVersion returns the BulletinVersion field if it's non-nil, zero value otherwise.

func (*SecurityAdvisoryBulletin) GetCiscoBugIds 

func (s *SecurityAdvisoryBulletin) GetCiscoBugIds() string

GetCiscoBugIds returns the CiscoBugIds field if it's non-nil, zero value otherwise.

func (*SecurityAdvisoryBulletin) GetCveId 

func (s *SecurityAdvisoryBulletin) GetCveId() string

GetCveId returns the CveId field if it's non-nil, zero value otherwise.

func (*SecurityAdvisoryBulletin) GetCvssBase 

func (s *SecurityAdvisoryBulletin) GetCvssBase() string

GetCvssBase returns the CvssBase field if it's non-nil, zero value otherwise.

func (*SecurityAdvisoryBulletin) GetCvssTemporal 

func (s *SecurityAdvisoryBulletin) GetCvssTemporal() string

GetCvssTemporal returns the CvssTemporal field if it's non-nil, zero value otherwise.

func (*SecurityAdvisoryBulletin) GetPsirtAdvisoryId 

func (s *SecurityAdvisoryBulletin) GetPsirtAdvisoryId() string

GetPsirtAdvisoryId returns the PsirtAdvisoryId field if it's non-nil, zero value otherwise.

func (*SecurityAdvisoryBulletin) GetPsirtColdId 

func (s *SecurityAdvisoryBulletin) GetPsirtColdId() int

GetPsirtColdId returns the PsirtColdId field if it's non-nil, zero value otherwise.

func (*SecurityAdvisoryBulletin) GetSir 

func (s *SecurityAdvisoryBulletin) GetSir() string

GetSir returns the Sir field if it's non-nil, zero value otherwise.

type SerialNumberDetails added in v0.5.0 

type SerialNumberDetails struct {
	// Customer ID is not included in the response, but should be added to associate this contract to a specific customer
	CustomerID string `gorm:"primaryKey;autoIncrement:false"`

	// FirstBasePID is not included in the response -- we will add it if there is at least one base PID in the Base PID List
	FirstBasePid string

	BasePidList *[]ContractBasePID `json:"basePidList,omitempty" gorm:"-"`

	// Address field for the contract install site.
	ContractSiteAddress1 *string `json:"contractSiteAddress1,omitempty"`

	// City field for the contract install site; for example,
	ContractSiteCity *string `json:"contractSiteCity,omitempty"`

	// Country field for the contract install site
	ContractSiteCountry *string `json:"contractSiteCountry,omitempty"`

	// Customer name associated to the contract install site.
	ContractSiteCustomerName *string `json:"contractSiteCustomerName,omitempty"`

	// State field for the contract install site
	ContractSiteStateProvince *string `json:"contractSiteStateProvince,omitempty"`

	// End date of the covered product line in the following format: YYYY-MM-DD
	CoveredProductLineEndDate *Date `json:"coveredProductLineEndDate,omitempty"`

	// Number of the record in the results. Appears to be null in most cases.
	Id *int `json:"id,omitempty"`

	// Indicates whether the specified serial number is covered by a service contract; one of the following values: YES or NO. If the serial number is covered by a service contract, the value is Yes.
	IsCovered *string `json:"isCovered,omitempty"`

	OrderablePidList *[]OrderablePid `json:"orderablePidList,omitempty" gorm:"-"`

	// FirstOrderablePid is not included in the response. We should set it separately.
	FirstOrderablePid            string
	FirstOrderablePidType        string
	FirstOrderablePidDescription string
	FirstOrderablePidPosition    string
	FirstOrderablePidPillarCode  string

	// Parent serial number. The value of parent_sr_no will be the same as the value for sr_no if the item is a MAJOR item.
	ParentSrNo *string `json:"parentSrNo,omitempty"`

	// Service contract number
	ServiceContractNumber *string `json:"serviceContractNumber,omitempty"`

	// Description of the service type
	ServiceLineDescr *string `json:"serviceLineDescr,omitempty"`

	// Serial number of the device.
	SrNo *string `json:"srNo,omitempty" gorm:"primaryKey;autoIncrement:false"`

	// End date of the warranty for the specified serial number in the following format: YYYY-MM-DD
	WarrantyEndDate *Date `json:"warrantyEndDate,omitempty"`

	// Warranty service type
	WarrantyType *string `json:"warrantyType,omitempty"`

	// Link to the description of the warranty type.
	WarrantyTypeDescription *string `json:"warrantyTypeDescription,omitempty"`
}

SerialNumberDetails defines model for serialNumberDetails.

func (*SerialNumberDetails) GetBasePidList added in v0.5.0 

func (s *SerialNumberDetails) GetBasePidList() []ContractBasePID

GetBasePidList returns the BasePidList field if it's non-nil, zero value otherwise.

func (*SerialNumberDetails) GetContractSiteAddress1 added in v0.5.0 

func (s *SerialNumberDetails) GetContractSiteAddress1() string

GetContractSiteAddress1 returns the ContractSiteAddress1 field if it's non-nil, zero value otherwise.

func (*SerialNumberDetails) GetContractSiteCity added in v0.5.0 

func (s *SerialNumberDetails) GetContractSiteCity() string

GetContractSiteCity returns the ContractSiteCity field if it's non-nil, zero value otherwise.

func (*SerialNumberDetails) GetContractSiteCountry added in v0.5.0 

func (s *SerialNumberDetails) GetContractSiteCountry() string

GetContractSiteCountry returns the ContractSiteCountry field if it's non-nil, zero value otherwise.

func (*SerialNumberDetails) GetContractSiteCustomerName added in v0.5.0 

func (s *SerialNumberDetails) GetContractSiteCustomerName() string

GetContractSiteCustomerName returns the ContractSiteCustomerName field if it's non-nil, zero value otherwise.

func (*SerialNumberDetails) GetContractSiteStateProvince added in v0.5.0 

func (s *SerialNumberDetails) GetContractSiteStateProvince() string

GetContractSiteStateProvince returns the ContractSiteStateProvince field if it's non-nil, zero value otherwise.

func (*SerialNumberDetails) GetCoveredProductLineEndDate added in v0.5.0 

func (s *SerialNumberDetails) GetCoveredProductLineEndDate() *Date

GetCoveredProductLineEndDate returns the CoveredProductLineEndDate field.

func (*SerialNumberDetails) GetId added in v0.5.0 

func (s *SerialNumberDetails) GetId() int

GetId returns the Id field if it's non-nil, zero value otherwise.

func (*SerialNumberDetails) GetIsCovered added in v0.5.0 

func (s *SerialNumberDetails) GetIsCovered() string

GetIsCovered returns the IsCovered field if it's non-nil, zero value otherwise.

func (*SerialNumberDetails) GetOrderablePidList added in v0.5.0 

func (s *SerialNumberDetails) GetOrderablePidList() []OrderablePid

GetOrderablePidList returns the OrderablePidList field if it's non-nil, zero value otherwise.

func (*SerialNumberDetails) GetParentSrNo added in v0.5.0 

func (s *SerialNumberDetails) GetParentSrNo() string

GetParentSrNo returns the ParentSrNo field if it's non-nil, zero value otherwise.

func (*SerialNumberDetails) GetServiceContractNumber added in v0.5.0 

func (s *SerialNumberDetails) GetServiceContractNumber() string

GetServiceContractNumber returns the ServiceContractNumber field if it's non-nil, zero value otherwise.

func (*SerialNumberDetails) GetServiceLineDescr added in v0.5.0 

func (s *SerialNumberDetails) GetServiceLineDescr() string

GetServiceLineDescr returns the ServiceLineDescr field if it's non-nil, zero value otherwise.

func (*SerialNumberDetails) GetSrNo added in v0.5.0 

func (s *SerialNumberDetails) GetSrNo() string

GetSrNo returns the SrNo field if it's non-nil, zero value otherwise.

func (*SerialNumberDetails) GetWarrantyEndDate added in v0.5.0 

func (s *SerialNumberDetails) GetWarrantyEndDate() *Date

GetWarrantyEndDate returns the WarrantyEndDate field.

func (*SerialNumberDetails) GetWarrantyType added in v0.5.0 

func (s *SerialNumberDetails) GetWarrantyType() string

GetWarrantyType returns the WarrantyType field if it's non-nil, zero value otherwise.

func (*SerialNumberDetails) GetWarrantyTypeDescription added in v0.5.0 

func (s *SerialNumberDetails) GetWarrantyTypeDescription() string

GetWarrantyTypeDescription returns the WarrantyTypeDescription field if it's non-nil, zero value otherwise.

type SoftwareAlert 

type SoftwareAlert struct {
	// The unique ID of the NP NetworkElement/Device.
	DeviceId *int `json:"deviceId,omitempty" gorm:"primaryKey;autoIncrement:false"`

	// The Network Element Name of the device. When used as input, it can include % as wildcard.
	DeviceName *string `json:"deviceName,omitempty"`

	// The Image Name of the software on the Network Element.
	ImageName *string `json:"imageName,omitempty"`

	// The type of Software Alert on the device. Valid values include SA for Software Advisory and DF for Deferral.
	SwAlertType *string `json:"swAlertType,omitempty"`

	// The Cisco.com URL with details for a specific software advisory or deferral.
	SwAlertUrl *string `json:"swAlertUrl,omitempty" gorm:"primaryKey;autoIncrement:false"`

	// The Type of Software running on the NP Network Element.  Common values include IOS, IOS XR, IOS-XE, NX-OS, etc.
	SwType *string `json:"swType,omitempty"`

	// The Software Version of the device.
	SwVersion *string `json:"swVersion,omitempty"`
}

SoftwareAlert defines model for softwareAlerts.

func (*SoftwareAlert) GetDeviceId 

func (s *SoftwareAlert) GetDeviceId() int

GetDeviceId returns the DeviceId field if it's non-nil, zero value otherwise.

func (*SoftwareAlert) GetDeviceName 

func (s *SoftwareAlert) GetDeviceName() string

GetDeviceName returns the DeviceName field if it's non-nil, zero value otherwise.

func (*SoftwareAlert) GetImageName 

func (s *SoftwareAlert) GetImageName() string

GetImageName returns the ImageName field if it's non-nil, zero value otherwise.

func (*SoftwareAlert) GetSwAlertType 

func (s *SoftwareAlert) GetSwAlertType() string

GetSwAlertType returns the SwAlertType field if it's non-nil, zero value otherwise.

func (*SoftwareAlert) GetSwAlertUrl 

func (s *SoftwareAlert) GetSwAlertUrl() string

GetSwAlertUrl returns the SwAlertUrl field if it's non-nil, zero value otherwise.

func (*SoftwareAlert) GetSwType 

func (s *SoftwareAlert) GetSwType() string

GetSwType returns the SwType field if it's non-nil, zero value otherwise.

func (*SoftwareAlert) GetSwVersion 

func (s *SoftwareAlert) GetSwVersion() string

GetSwVersion returns the SwVersion field if it's non-nil, zero value otherwise.

type SoftwareEOX 

type SoftwareEOX struct {
	// The current end-of-life milestone as calculated during last NP profile. If more than one milestone falls on the same date, the returned value will be a comma-separated list.
	CurrentEoxMilestone *string `json:"currentEoxMilestone,omitempty"`

	// The date associated with the current end-of-life milestone.
	CurrentEoxMilestoneDate *DateTime `json:"currentEoxMilestoneDate,omitempty"`

	// The unique ID of the NP NetworkElement/Device.
	DeviceId *int `json:"deviceId,omitempty" gorm:"primaryKey;autoIncrement:false"`

	// The Network Element Name of the device. When used as input, it can include % as wildcard.
	DeviceName *string `json:"deviceName,omitempty"`

	// The next end-of-life milestone that is coming up as calculated during last NP profile.  If more than one milestone falls on the same date, the returned value will be a comma-separated list.  If the device is already LDoS it will not have an next milestone.
	NextEoxMilestone *string `json:"nextEoxMilestone,omitempty"`

	// The date associated with the next end-of-life milestone.
	NextEoxMilestoneDate *DateTime `json:"nextEoxMilestoneDate,omitempty"`

	// Internal software end-of-life identifier to allow join with master sw_eox_bulletins API.
	SwEoxId *int `json:"swEoxId,omitempty" gorm:"primaryKey;autoIncrement:false"`

	// The Type of Software running on the NP Network Element.  Common values include IOS, IOS XR, IOS-XE, NX-OS, etc.
	SwType *string `json:"swType,omitempty"`

	// The Software Version of the device.
	SwVersion *string `json:"swVersion,omitempty"`
}

SoftwareEOX defines model for softwareEOX.

func (*SoftwareEOX) GetCurrentEoxMilestone 

func (s *SoftwareEOX) GetCurrentEoxMilestone() string

GetCurrentEoxMilestone returns the CurrentEoxMilestone field if it's non-nil, zero value otherwise.

func (*SoftwareEOX) GetCurrentEoxMilestoneDate 

func (s *SoftwareEOX) GetCurrentEoxMilestoneDate() *DateTime

GetCurrentEoxMilestoneDate returns the CurrentEoxMilestoneDate field.

func (*SoftwareEOX) GetDeviceId 

func (s *SoftwareEOX) GetDeviceId() int

GetDeviceId returns the DeviceId field if it's non-nil, zero value otherwise.

func (*SoftwareEOX) GetDeviceName 

func (s *SoftwareEOX) GetDeviceName() string

GetDeviceName returns the DeviceName field if it's non-nil, zero value otherwise.

func (*SoftwareEOX) GetNextEoxMilestone 

func (s *SoftwareEOX) GetNextEoxMilestone() string

GetNextEoxMilestone returns the NextEoxMilestone field if it's non-nil, zero value otherwise.

func (*SoftwareEOX) GetNextEoxMilestoneDate 

func (s *SoftwareEOX) GetNextEoxMilestoneDate() *DateTime

GetNextEoxMilestoneDate returns the NextEoxMilestoneDate field.

func (*SoftwareEOX) GetSwEoxId 

func (s *SoftwareEOX) GetSwEoxId() int

GetSwEoxId returns the SwEoxId field if it's non-nil, zero value otherwise.

func (*SoftwareEOX) GetSwType 

func (s *SoftwareEOX) GetSwType() string

GetSwType returns the SwType field if it's non-nil, zero value otherwise.

func (*SoftwareEOX) GetSwVersion 

func (s *SoftwareEOX) GetSwVersion() string

GetSwVersion returns the SwVersion field if it's non-nil, zero value otherwise.

type SoftwareEOXBulletin 

type SoftwareEOXBulletin struct {
	// The Cisco.com bulletin number for an End-of-Life bulletin or Field Notice.
	BulletinNumber *string `json:"bulletinNumber,omitempty"`

	// The Cisco.com Title/Headline for the bulletin.
	BulletinTitle *string `json:"bulletinTitle,omitempty"`

	// The Cisco.com URL for the bulletin.
	BulletinUrl *string `json:"bulletinUrl,omitempty"`

	// The End-of-Life Announcement (Announced) Date.
	EoLifeAnnouncementDate *DateTime `json:"eoLifeAnnouncementDate,omitempty"`

	// The End-of-Sale (EoSale) Date.
	EoSaleDate *DateTime `json:"eoSaleDate,omitempty"`

	// The End of Vulnerability/Security Support (EoVSS) Date.
	EoSecurityVulSupportDate *DateTime `json:"eoSecurityVulSupportDate,omitempty"`

	// The End of SW Maintenance Releases (EoSWM) Date.
	EoSwMaintenanceReleasesDate *DateTime `json:"eoSwMaintenanceReleasesDate,omitempty"`

	// The Last Date of Support (LDoS).
	LastDateOfSupport *DateTime `json:"lastDateOfSupport,omitempty"`

	// Internal software end-of-life identifier to allow join with master sw_eox_bulletins API.
	SwEoxId *int `json:"swEoxId,omitempty" gorm:"primaryKey;autoIncrement:false"`

	// The maintenance version portion of the software version.  For example, in 12.4(21), it is "21"
	SwMaintenanceVersion *string `json:"swMaintenanceVersion,omitempty"`

	// The major version portion of the software version.
	SwMajorVersion *string `json:"swMajorVersion,omitempty"`

	// The Software Train, typically only applies to IOS.
	SwTrain *string `json:"swTrain,omitempty"`

	// The Type of Software running on the NP Network Element.  Common values include IOS, IOS XR, IOS-XE, NX-OS, etc.
	SwType *string `json:"swType,omitempty"`
}

SoftwareEOXBulletin defines model for SWEOXBulletins.

func (*SoftwareEOXBulletin) GetBulletinNumber 

func (s *SoftwareEOXBulletin) GetBulletinNumber() string

GetBulletinNumber returns the BulletinNumber field if it's non-nil, zero value otherwise.

func (*SoftwareEOXBulletin) GetBulletinTitle 

func (s *SoftwareEOXBulletin) GetBulletinTitle() string

GetBulletinTitle returns the BulletinTitle field if it's non-nil, zero value otherwise.

func (*SoftwareEOXBulletin) GetBulletinUrl 

func (s *SoftwareEOXBulletin) GetBulletinUrl() string

GetBulletinUrl returns the BulletinUrl field if it's non-nil, zero value otherwise.

func (*SoftwareEOXBulletin) GetEoLifeAnnouncementDate 

func (s *SoftwareEOXBulletin) GetEoLifeAnnouncementDate() *DateTime

GetEoLifeAnnouncementDate returns the EoLifeAnnouncementDate field.

func (*SoftwareEOXBulletin) GetEoSaleDate 

func (s *SoftwareEOXBulletin) GetEoSaleDate() *DateTime

GetEoSaleDate returns the EoSaleDate field.

func (*SoftwareEOXBulletin) GetEoSecurityVulSupportDate 

func (s *SoftwareEOXBulletin) GetEoSecurityVulSupportDate() *DateTime

GetEoSecurityVulSupportDate returns the EoSecurityVulSupportDate field.

func (*SoftwareEOXBulletin) GetEoSwMaintenanceReleasesDate 

func (s *SoftwareEOXBulletin) GetEoSwMaintenanceReleasesDate() *DateTime

GetEoSwMaintenanceReleasesDate returns the EoSwMaintenanceReleasesDate field.

func (*SoftwareEOXBulletin) GetLastDateOfSupport 

func (s *SoftwareEOXBulletin) GetLastDateOfSupport() *DateTime

GetLastDateOfSupport returns the LastDateOfSupport field.

func (*SoftwareEOXBulletin) GetSwEoxId 

func (s *SoftwareEOXBulletin) GetSwEoxId() int

GetSwEoxId returns the SwEoxId field if it's non-nil, zero value otherwise.

func (*SoftwareEOXBulletin) GetSwMaintenanceVersion 

func (s *SoftwareEOXBulletin) GetSwMaintenanceVersion() string

GetSwMaintenanceVersion returns the SwMaintenanceVersion field if it's non-nil, zero value otherwise.

func (*SoftwareEOXBulletin) GetSwMajorVersion 

func (s *SoftwareEOXBulletin) GetSwMajorVersion() string

GetSwMajorVersion returns the SwMajorVersion field if it's non-nil, zero value otherwise.

func (*SoftwareEOXBulletin) GetSwTrain 

func (s *SoftwareEOXBulletin) GetSwTrain() string

GetSwTrain returns the SwTrain field if it's non-nil, zero value otherwise.

func (*SoftwareEOXBulletin) GetSwType 

func (s *SoftwareEOXBulletin) GetSwType() string

GetSwType returns the SwType field if it's non-nil, zero value otherwise.

type SyslogDaily added in v0.5.0 

type SyslogDaily struct {
	// Customer ID is not included in the response, but should be added to associate this device to a specific customer
	CustomerID string `gorm:"primary_key;autoIncrement:false"`

	// Date of insertion
	Date *Date `json:"date,omitempty"`

	Description *string `json:"description,omitempty"`

	Devices *map[string]interface{} `json:"devices,omitempty"`

	Icseverity *string `json:"icseverity,omitempty"`

	Msgtype *string `json:"msgtype,omitempty"`

	Recommendation *string `json:"recommendation,omitempty"`

	Severity *int `json:"severity,omitempty"`

	Timestamp *DateTime `json:"timestamp,omitempty"`

	Total *int `json:"total,omitempty"`
}

SyslogDailyModel defines model for syslogDailyModel.

func (*SyslogDaily) GetDate added in v0.6.0 

func (s *SyslogDaily) GetDate() *Date

GetDate returns the Date field.

func (*SyslogDaily) GetDescription added in v0.6.0 

func (s *SyslogDaily) GetDescription() string

GetDescription returns the Description field if it's non-nil, zero value otherwise.

func (*SyslogDaily) GetIcseverity added in v0.6.0 

func (s *SyslogDaily) GetIcseverity() string

GetIcseverity returns the Icseverity field if it's non-nil, zero value otherwise.

func (*SyslogDaily) GetMsgtype added in v0.6.0 

func (s *SyslogDaily) GetMsgtype() string

GetMsgtype returns the Msgtype field if it's non-nil, zero value otherwise.

func (*SyslogDaily) GetRecommendation added in v0.6.0 

func (s *SyslogDaily) GetRecommendation() string

GetRecommendation returns the Recommendation field if it's non-nil, zero value otherwise.

func (*SyslogDaily) GetSeverity added in v0.6.0 

func (s *SyslogDaily) GetSeverity() int

GetSeverity returns the Severity field if it's non-nil, zero value otherwise.

func (*SyslogDaily) GetTimestamp added in v0.6.0 

func (s *SyslogDaily) GetTimestamp() *DateTime

GetTimestamp returns the Timestamp field.

func (*SyslogDaily) GetTotal added in v0.6.0 

func (s *SyslogDaily) GetTotal() int

GetTotal returns the Total field if it's non-nil, zero value otherwise.

type SyslogDevice added in v0.5.0 

type SyslogDevice struct {
	Device *string `json:"device,omitempty"`

	DeviceId *int `json:"deviceId,omitempty"`

	Events *int `json:"events,omitempty"`
}

func (*SyslogDevice) GetDevice added in v0.6.0 

func (s *SyslogDevice) GetDevice() string

GetDevice returns the Device field if it's non-nil, zero value otherwise.

func (*SyslogDevice) GetDeviceId added in v0.6.0 

func (s *SyslogDevice) GetDeviceId() int

GetDeviceId returns the DeviceId field if it's non-nil, zero value otherwise.

func (*SyslogDevice) GetEvents added in v0.6.0 

func (s *SyslogDevice) GetEvents() int

GetEvents returns the Events field if it's non-nil, zero value otherwise.

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.