7.3. SteelScript SCC Sources

The SCC package offers a set of interfaces to control and work with a SteelCentral Controller appliance.

7.3.1. SCC Objects

class steelscript.scc.core.scc.SCC(host, port=None, auth=None)

This class is the main interface to interact with a SteelCentral Controller.

__init__(host, port=None, auth=None)

Create an SCC object

7.3.1.1. ServiceDefLoader Objects

class steelscript.scc.core.scc.ServiceDefLoader

This class serves as the custom hook for service manager.

find_by_id(id_)

This method generates service schema corresponding to the id

Parameters:

id – Service id specified in service definition file

find_by_name(name, version, provider)

Method used to discover service from service map based upon service name, version and service provider

Parameters:

  • name – Name of the service

  • version – Version of service

  • provider – Name of service provider

7.3.1.2. SCCServerConnectionHook Objects

class steelscript.scc.core.scc.SCCServerConnectionHook
connect(host, auth)

Create a connection to the server

7.3.1.3. SCCServiceManager Objects

class steelscript.scc.core.scc.SCCServiceManager(*args, **kw)

This class encapsulates the storage of SCC services and connection with the SCC device.

static __new__(cls)

Create a SCCServiceManager instance

7.3.2. BaseSCCReport Objects

class steelscript.scc.core.report.BaseSCCReport(scc)

Base class for SCC reports, not directly used for creating report objects.

Parameters:

  • service – string, attr name of the service obj

  • resource – string, name of the resource

  • link – string, name of the link to retrieve data

  • data_key – string, key mapping to the data in response if None, then the entire reponse is desired

  • required_fields – list of fields required by the sub-report, excluding start_time and end_time.

  • non_required_fields – list of fields available to use but not required by the sub-report

__init__(scc)
run(**kwargs)

Run report to fetch data from the SCC device

7.3.2.1. BaseStatsReport Objects

class steelscript.scc.core.report.BaseStatsReport(scc)

Bases: BaseSCCReport

Base class for reports generated by scc.stats api, not directly used for creating reports objects. All report instances are derived based on sub-classes inheriting from this class.

__init__(scc)
run(**kwargs)

Run report to fetch data from the SCC device

7.3.2.2. BWUsageStatsReport Objects

class steelscript.scc.core.report.BWUsageStatsReport(scc)

Bases: BaseStatsReport

Report class to return bandwidth usage

run(**kwargs)

Run report to fetch data from the SCC device

7.3.2.3. BWTimeSeriesStatsReport Objects

class steelscript.scc.core.report.BWTimeSeriesStatsReport(scc)

Bases: BaseStatsReport

Report class to return bandwidth timeseries

run(**kwargs)

Run report to fetch data from the SCC device

7.3.2.4. BWPerApplStatsReport Objects

class steelscript.scc.core.report.BWPerApplStatsReport(scc)

Bases: BaseStatsReport

Report class to return the bandwidth per appliance data

run(**kwargs)

Run report to fetch data from the SCC device

7.3.2.5. ThroughputStatsReport Objects

class steelscript.scc.core.report.ThroughputStatsReport(scc)

Bases: BaseStatsReport

Report class to return the peak/p95 throughput timeseries

run(**kwargs)

Run report to fetch data from the SCC device

7.3.2.6. ThroughputPerApplStatsReport Objects

class steelscript.scc.core.report.ThroughputPerApplStatsReport(scc)

Bases: BaseStatsReport

Report class to return the throughput per appliance data

run(**kwargs)

Run report to fetch data from the SCC device

7.3.2.7. ConnectionHistoryStatsReport Objects

class steelscript.scc.core.report.ConnectionHistoryStatsReport(scc)

Bases: BaseStatsReport

Report class to return the max/avg connection history timeseries

run(**kwargs)

Run report to fetch data from the SCC device

7.3.2.8. SRDFStatsReport Objects

class steelscript.scc.core.report.SRDFStatsReport(scc)

Bases: BaseStatsReport

Report class to return the regular/peak srdf timeseries

run(**kwargs)

Run report to fetch data from the SCC device

7.3.2.9. TCPMemoryPressureReport Objects

class steelscript.scc.core.report.TCPMemoryPressureReport(scc)

Bases: BaseStatsReport

Report class to return regular/peak tcp memory pressure timesries

run(**kwargs)

Run report to fetch data from the SCC device

7.3.2.10. MultiDevStatsReport Objects

class steelscript.scc.core.report.MultiDevStatsReport(scc)

Bases: BaseStatsReport

run(**kwargs)

Run report to fetch data from the SCC device

7.3.2.11. ConnectionPoolingStatsReport Objects

class steelscript.scc.core.report.ConnectionPoolingStatsReport(scc)

Bases: MultiDevStatsReport

Report class to return the connection pooling timeseries

run(**kwargs)

Run report to fetch data from the SCC device

7.3.2.12. ConnectionForwardingStatsReport Objects

class steelscript.scc.core.report.ConnectionForwardingStatsReport(scc)

Bases: MultiDevStatsReport

Report class to return the connection forwrding timeseries

run(**kwargs)

Run report to fetch data from the SCC device

7.3.2.13. DNSUsageStatsReport Objects

class steelscript.scc.core.report.DNSUsageStatsReport(scc)

Bases: MultiDevStatsReport

Report class to return the dns usage timeseries

run(**kwargs)

Run report to fetch data from the SCC device

7.3.2.14. DNSCacheHitsStatsReport Objects

class steelscript.scc.core.report.DNSCacheHitsStatsReport(scc)

Bases: MultiDevStatsReport

Report class to return the dns cache hits timeseries

run(**kwargs)

Run report to fetch data from the SCC device

7.3.2.15. HTTPStatsReport Objects

class steelscript.scc.core.report.HTTPStatsReport(scc)

Bases: MultiDevStatsReport

Report class to return the http timeseries

run(**kwargs)

Run report to fetch data from the SCC device

7.3.2.16. NFSStatsReport Objects

class steelscript.scc.core.report.NFSStatsReport(scc)

Bases: MultiDevStatsReport

Report class to return the nfs timeseries

run(**kwargs)

Run report to fetch data from the SCC device

7.3.2.17. SSLStatsReport Objects

class steelscript.scc.core.report.SSLStatsReport(scc)

Bases: MultiDevStatsReport

Report class to return the ssl timeseries

run(**kwargs)

Run report to fetch data from the SCC device

7.3.2.18. DiskLoadStatsReport Objects

class steelscript.scc.core.report.DiskLoadStatsReport(scc)

Bases: MultiDevStatsReport

Report class to return disk load timeseries

run(**kwargs)

Run report to fetch data from the SCC device

7.3.2.19. SingleDevStatsReport Objects

class steelscript.scc.core.report.SingleDevStatsReport(scc)

Bases: BaseStatsReport

run(**kwargs)

Run report to fetch data from the SCC device

7.3.2.20. SDRAdaptiveStatsReport Objects

class steelscript.scc.core.report.SDRAdaptiveStatsReport(scc)

Bases: SingleDevStatsReport

Report class to return the SDR Adaptive timeseries

run(**kwargs)

Run report to fetch data from the SCC device

7.3.2.21. MemoryPagingStatsReport Objects

class steelscript.scc.core.report.MemoryPagingStatsReport(scc)

Bases: SingleDevStatsReport

Report class to return the memory paging timeseries

run(**kwargs)

Run report to fetch data from the SCC device

7.3.2.22. CpuUtilizationStatsReport Objects

class steelscript.scc.core.report.CpuUtilizationStatsReport(scc)

Bases: SingleDevStatsReport

Report class to return the cpu utilization timeseries

run(**kwargs)

Run report to fetch data from the SCC device

7.3.2.23. PFSStatsReport Objects

class steelscript.scc.core.report.PFSStatsReport(scc)

Bases: SingleDevStatsReport

Report class to return the pfs timeseries

run(**kwargs)

Run report to fetch data from the SCC device

7.3.2.24. QoSStatsReport Objects

class steelscript.scc.core.report.QoSStatsReport(scc)

Bases: BaseStatsReport

Report class to return the outbound/inbound qos timeseries

run(**kwargs)

Run report to fetch data from the SCC device

7.3.2.25. SnapMirrorStatsReport Objects

class steelscript.scc.core.report.SnapMirrorStatsReport(scc)

Bases: BaseStatsReport

Report class to return regular/peak snapmirror timeseries

run(**kwargs)

Run report to fetch data from the SCC device

7.3.2.26. SteelFusionLUNIOReport Objects

class steelscript.scc.core.report.SteelFusionLUNIOReport(scc)

Bases: BaseStatsReport

Report class to return the SteelFusion lun io timeseries

run(**kwargs)

Run report to fetch data from the SCC device

7.3.2.27. SteelFusionInitiatorIOReport Objects

class steelscript.scc.core.report.SteelFusionInitiatorIOReport(scc)

Bases: BaseStatsReport

Report class to return the SteelFusion initiator io timeseries

run(**kwargs)

Run report to fetch data from the SCC device

7.3.2.28. SteelFusionNetworkIOReport Objects

class steelscript.scc.core.report.SteelFusionNetworkIOReport(scc)

Bases: BaseStatsReport

Report class to return the SteelFusion network IO timeseries

run(**kwargs)

Run report to fetch data from the SCC device

7.3.2.29. SteelFusionBlockstoreReport Objects

class steelscript.scc.core.report.SteelFusionBlockstoreReport(scc)

Bases: BaseStatsReport

Report class to return the SteelFusion blockstore timeseries

run(**kwargs)

Run report to fetch data from the SCC device

7.3.2.30. BaseApplInvtReport Objects

class steelscript.scc.core.report.BaseApplInvtReport(scc)

Bases: BaseSCCReport

Base class for reports generated by appliance_inventory api, not directly used for creating reports objects. All report instances are derived based on sub-classes inheriting from this class.

run(**kwargs)

Run report to fetch data from the SCC device

7.3.2.31. AppliancesReport Objects

class steelscript.scc.core.report.AppliancesReport(scc)

Bases: BaseApplInvtReport

Report class to return brief info of appliances

run(**kwargs)

Run report to fetch data from the SCC device

7.3.3. SCCApp Objects

class steelscript.scc.core.app.SCCApp(*args, **kwargs)

Class to wrap common command line parsing

__init__(*args, **kwargs)
setup()

Commands to run before execution.

If defined in a subclass, the subclass will mostly want to call setup() of the parent via:

super(<subclass>, self).setup()

This will ensure the any setup required of the parent classes is performed as well.

validate_args()

Hook for subclasses to add their own option/argument validation