Skip to content

Commit

Permalink
SP36 docs
Browse files Browse the repository at this point in the history
  • Loading branch information
@kevinjojeejoseph
kevinjojeejoseph committed Jun 14, 2024
1 parent 8dae4e5 commit f768586
Show file tree
Hide file tree
Showing 247 changed files with 33,278 additions and 15,140 deletions.
48 changes: 41 additions & 7 deletions docs/cvpysdk/activate.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -43,7 +43,7 @@ <h1 id="activate-instance-attributes">Activate instance Attributes</h1>
<details class="source">
<summary>
<span>Expand source code</span>
<a href="https://github.com/Commvault/cvpysdk/blob/f1b869bfdbbeeadc5afb6212882168e26fa82324/cvpysdk/activate.py#L1-L190" class="git-link">Browse git</a>
<a href="https://github.com/Commvault/cvpysdk/blob/8dae4e5d757578a0123ac548967635d21ca9ca6f/cvpysdk/activate.py#L1-L199" class="git-link">Browse git</a>
</summary>
<pre><code class="python"># -*- coding: utf-8 -*-

Expand Down Expand Up @@ -99,6 +99,8 @@ <h1 id="activate-instance-attributes">Activate instance Attributes</h1>

from .activateapps.entity_manager import EntityManagerTypes, ActivateEntities, Tags, Classifiers

from .activateapps.compliance_utils import ComplianceSearchUtils


class Activate(object):
&#34;&#34;&#34;Class for representing activate apps in the commcell.&#34;&#34;&#34;
Expand All @@ -122,6 +124,7 @@ <h1 id="activate-instance-attributes">Activate instance Attributes</h1>
self._fso_server_groups = None
self._sdg_projects = None
self._req_mgr = None
self._compliance_search = None

def __del__(self):
&#34;&#34;&#34;Destructor method to delete all instances of apps referenced by this class&#34;&#34;&#34;
Expand All @@ -134,6 +137,12 @@ <h1 id="activate-instance-attributes">Activate instance Attributes</h1>
del self._sdg_projects
del self._req_mgr

def compliance_search(self):
&#34;&#34;&#34;Returns the Compliance Search utility class object from activate apps&#34;&#34;&#34;
if self._compliance_search is None:
self._compliance_search = ComplianceSearchUtils(self._commcell_object)
return self._compliance_search

def inventory_manager(self):
&#34;&#34;&#34;Returns the Inventories class object from inventory manager app from activate apps&#34;&#34;&#34;
if self._inventories is None:
Expand Down Expand Up @@ -265,7 +274,7 @@ <h2 id="returns">Returns</h2>
<details class="source">
<summary>
<span>Expand source code</span>
<a href="https://github.com/Commvault/cvpysdk/blob/f1b869bfdbbeeadc5afb6212882168e26fa82324/cvpysdk/activate.py#L56-L190" class="git-link">Browse git</a>
<a href="https://github.com/Commvault/cvpysdk/blob/8dae4e5d757578a0123ac548967635d21ca9ca6f/cvpysdk/activate.py#L58-L199" class="git-link">Browse git</a>
</summary>
<pre><code class="python">class Activate(object):
&#34;&#34;&#34;Class for representing activate apps in the commcell.&#34;&#34;&#34;
Expand All @@ -289,6 +298,7 @@ <h2 id="returns">Returns</h2>
self._fso_server_groups = None
self._sdg_projects = None
self._req_mgr = None
self._compliance_search = None

def __del__(self):
&#34;&#34;&#34;Destructor method to delete all instances of apps referenced by this class&#34;&#34;&#34;
Expand All @@ -301,6 +311,12 @@ <h2 id="returns">Returns</h2>
del self._sdg_projects
del self._req_mgr

def compliance_search(self):
&#34;&#34;&#34;Returns the Compliance Search utility class object from activate apps&#34;&#34;&#34;
if self._compliance_search is None:
self._compliance_search = ComplianceSearchUtils(self._commcell_object)
return self._compliance_search

def inventory_manager(self):
&#34;&#34;&#34;Returns the Inventories class object from inventory manager app from activate apps&#34;&#34;&#34;
if self._inventories is None:
Expand Down Expand Up @@ -405,6 +421,23 @@ <h2 id="returns">Returns</h2>
</details>
<h3>Methods</h3>
<dl>
<dt id="cvpysdk.activate.Activate.compliance_search"><code class="name flex">
<span>def <span class="ident">compliance_search</span></span>(<span>self)</span>
</code></dt>
<dd>
<div class="desc"><p>Returns the Compliance Search utility class object from activate apps</p></div>
<details class="source">
<summary>
<span>Expand source code</span>
<a href="https://github.com/Commvault/cvpysdk/blob/8dae4e5d757578a0123ac548967635d21ca9ca6f/cvpysdk/activate.py#L93-L97" class="git-link">Browse git</a>
</summary>
<pre><code class="python">def compliance_search(self):
&#34;&#34;&#34;Returns the Compliance Search utility class object from activate apps&#34;&#34;&#34;
if self._compliance_search is None:
self._compliance_search = ComplianceSearchUtils(self._commcell_object)
return self._compliance_search</code></pre>
</details>
</dd>
<dt id="cvpysdk.activate.Activate.entity_manager"><code class="name flex">
<span>def <span class="ident">entity_manager</span></span>(<span>self, entity_type=EntityManagerTypes.ENTITIES)</span>
</code></dt>
Expand All @@ -430,7 +463,7 @@ <h2 id="raises">Raises</h2>
<details class="source">
<summary>
<span>Expand source code</span>
<a href="https://github.com/Commvault/cvpysdk/blob/f1b869bfdbbeeadc5afb6212882168e26fa82324/cvpysdk/activate.py#L154-L190" class="git-link">Browse git</a>
<a href="https://github.com/Commvault/cvpysdk/blob/8dae4e5d757578a0123ac548967635d21ca9ca6f/cvpysdk/activate.py#L163-L199" class="git-link">Browse git</a>
</summary>
<pre><code class="python">def entity_manager(self, entity_type=EntityManagerTypes.ENTITIES):
&#34;&#34;&#34;Returns the ActivateEntities or Classifiers or Tagsets object in entity manager based on input type
Expand Down Expand Up @@ -491,7 +524,7 @@ <h2 id="sdkexception">Sdkexception</h2>
<details class="source">
<summary>
<span>Expand source code</span>
<a href="https://github.com/Commvault/cvpysdk/blob/f1b869bfdbbeeadc5afb6212882168e26fa82324/cvpysdk/activate.py#L102-L132" class="git-link">Browse git</a>
<a href="https://github.com/Commvault/cvpysdk/blob/8dae4e5d757578a0123ac548967635d21ca9ca6f/cvpysdk/activate.py#L111-L141" class="git-link">Browse git</a>
</summary>
<pre><code class="python">def file_storage_optimization(self, fso_type=FsoTypes.SERVERS):
&#34;&#34;&#34;returns object of FsoServers/FsoServerGroups/Projects based on FSO type
Expand Down Expand Up @@ -534,7 +567,7 @@ <h2 id="sdkexception">Sdkexception</h2>
<details class="source">
<summary>
<span>Expand source code</span>
<a href="https://github.com/Commvault/cvpysdk/blob/f1b869bfdbbeeadc5afb6212882168e26fa82324/cvpysdk/activate.py#L90-L94" class="git-link">Browse git</a>
<a href="https://github.com/Commvault/cvpysdk/blob/8dae4e5d757578a0123ac548967635d21ca9ca6f/cvpysdk/activate.py#L99-L103" class="git-link">Browse git</a>
</summary>
<pre><code class="python">def inventory_manager(self):
&#34;&#34;&#34;Returns the Inventories class object from inventory manager app from activate apps&#34;&#34;&#34;
Expand All @@ -551,7 +584,7 @@ <h2 id="sdkexception">Sdkexception</h2>
<details class="source">
<summary>
<span>Expand source code</span>
<a href="https://github.com/Commvault/cvpysdk/blob/f1b869bfdbbeeadc5afb6212882168e26fa82324/cvpysdk/activate.py#L96-L100" class="git-link">Browse git</a>
<a href="https://github.com/Commvault/cvpysdk/blob/8dae4e5d757578a0123ac548967635d21ca9ca6f/cvpysdk/activate.py#L105-L109" class="git-link">Browse git</a>
</summary>
<pre><code class="python">def request_manager(self):
&#34;&#34;&#34;Returns the Requests class object from request manager app from activate apps&#34;&#34;&#34;
Expand All @@ -575,7 +608,7 @@ <h2 id="raises">Raises</h2>
<details class="source">
<summary>
<span>Expand source code</span>
<a href="https://github.com/Commvault/cvpysdk/blob/f1b869bfdbbeeadc5afb6212882168e26fa82324/cvpysdk/activate.py#L134-L152" class="git-link">Browse git</a>
<a href="https://github.com/Commvault/cvpysdk/blob/8dae4e5d757578a0123ac548967635d21ca9ca6f/cvpysdk/activate.py#L143-L161" class="git-link">Browse git</a>
</summary>
<pre><code class="python">def sensitive_data_governance(self):
&#34;&#34;&#34;returns object of Sensitive data governance - Projects class
Expand Down Expand Up @@ -673,6 +706,7 @@ <h1>Index</h1>
<li>
<h4><code><a title="cvpysdk.activate.Activate" href="#cvpysdk.activate.Activate">Activate</a></code></h4>
<ul class="">
<li><code><a title="cvpysdk.activate.Activate.compliance_search" href="#cvpysdk.activate.Activate.compliance_search">compliance_search</a></code></li>
<li><code><a title="cvpysdk.activate.Activate.entity_manager" href="#cvpysdk.activate.Activate.entity_manager">entity_manager</a></code></li>
<li><code><a title="cvpysdk.activate.Activate.file_storage_optimization" href="#cvpysdk.activate.Activate.file_storage_optimization">file_storage_optimization</a></code></li>
<li><code><a title="cvpysdk.activate.Activate.inventory_manager" href="#cvpysdk.activate.Activate.inventory_manager">inventory_manager</a></code></li>
Expand Down
Loading

0 comments on commit f768586

Please sign in to comment.